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.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string

No

Filtering

fields[proofs]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

Includes#

Value

Description

proof_type

Proof Types Object

entity

Identity Object or Address Object

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#

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}

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

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.