# Get Proofs

Returns a list of proofs on your account.

## Request

HTTP Method: `GET`

URI Path: `/v3/proofs`

Note

For all returned data attributes, see [Proofs Object](proofs-object.html).

### URI Query Parameters

| Name | Type | Is Required? | Description |
| --- | --- | --- | --- |
| include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) |
| filter[<filter\_name>] | `string` | No | [Filtering](../../../specification/filtering.html#api-filters) |
| fields[proofs] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) |
| sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) |
| page[number] | `integer` | No | [Page number](../../../specification/pagination.html#api-pagination). |
| page[size] | `integer` | No | [Page size](../../../specification/pagination.html#api-pagination). Pagination defaults to `50` records per page. The maximum is `100`. |

### Includes

| Value | Description |
| --- | --- |
| proof\_type | [Proof Types Object](../proof-types/proof-types-object.html#proof-types-object-v35) |
| entity | [Identity Object](../identities/identity-object.html#identity-object-v35) or [Address Object](../addresses/address-object.html#addresses-object-v35) |

### Filters

| Filter Name | Type | Allow Blank | Allow Array | Filters by: |
| --- | --- | --- | --- | --- |
| id | `string` | No | Yes | The `id` field. |
| external\_reference\_id | `string` | No | No | The `external_reference_id` field. |

### Sorting

| Value | Sorts by: |
| --- | --- |
| created\_at | The `created_at` field. |
| expires\_at | The `expires_at` field. |
| external\_reference\_id | The `external_reference_id` field. |

## Examples

Simple RequestFilter external\_reference\_id

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/proofs HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET https://api.didww.com/v3/proofs -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": [
 6        {
 7            "id": "84155378-88d5-456e-844d-103596e3fb2c",
 8            "type": "proofs",
 9            "attributes": {
10                "created_at": "2021-03-28T18:01:50.387Z",
11                "expires_at": null,
12                "external_reference_id": null
13            },
14            "relationships": {
15                "proof_type": {
16                    "links": {
17                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/proof_type",
18                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/proof_type"
19                    }
20                },
21                "entity": {
22                    "links": {
23                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/entity",
24                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/entity"
25                    }
26                }
27            }
28        }
29    ],
30    "meta": {
31        "total_records": 1,
32        "api_version": "2026-11-19"
33    },
34    "links": {
35        "first": "https://api.didww.com/v3/proofs?page%5Bnumber%5D=1&page%5Bsize%5D=50",
36        "last": "https://api.didww.com/v3/proofs?page%5Bnumber%5D=1&page%5Bsize%5D=50"
37    }
38}
```

[[DIDWW-API-EXAMPLE-END]]

[[DIDWW-API-EXAMPLE-START]]

http

```
1GET /v3/proofs?filter%5Bexternal_reference_id%5D=proof-001 HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Authorization: Bearer [access token]
```

curl

```
1curl -i -X GET 'https://api.didww.com/v3/proofs?filter%5Bexternal_reference_id%5D=proof-001' -H "Accept: application/vnd.api+json" -H "Content-Type: application/vnd.api+json" -H "Authorization: Bearer [access token]"
```

response

```
 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5    "data": [
 6        {
 7            "id": "84155378-88d5-456e-844d-103596e3fb2c",
 8            "type": "proofs",
 9            "attributes": {
10                "created_at": "2021-03-28T18:01:50.387Z",
11                "expires_at": null,
12                "external_reference_id": "proof-001"
13            },
14            "relationships": {
15                "proof_type": {
16                    "links": {
17                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/proof_type",
18                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/proof_type"
19                    }
20                },
21                "entity": {
22                    "links": {
23                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/entity",
24                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/entity"
25                    }
26                }
27            }
28        }
29    ],
30    "meta": {
31        "total_records": 1,
32        "api_version": "2026-11-19"
33    },
34    "links": {
35        "first": "https://api.didww.com/v3/proofs?filter%5Bexternal_reference_id%5D=proof-001&page%5Bnumber%5D=1&page%5Bsize%5D=50",
36        "last": "https://api.didww.com/v3/proofs?filter%5Bexternal_reference_id%5D=proof-001&page%5Bnumber%5D=1&page%5Bsize%5D=50"
37    }
38}
```

[[DIDWW-API-EXAMPLE-END]]

## Other Responses

| Code | Success | Description |
| --- | --- | --- |
| 400 | No | [Bad Request](../../../specification/errors/index.html#api-bad-request). Malformed request: unknown filter, bad pagination or bad sort field. |
| 401 | No | [Unauthorized](../../authentication.html#authentication-v35) |
| 429 | No | The request budget of the account for the current window is spent (`too_many_requests`). `Retry-After` gives the number of seconds to wait. |
