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

Includes

Value

Description

proof_type

Proof Types Object

entity

Identity Object or Address Object

Filters

Filter Name

Type

Allow Blank

Allow Array

Filters by:

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

GET /v3/proofs HTTP/1.1
Host: api.didww.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Api-Key: [API token]

curl

curl -i -X GET https://api.didww.com/v3/proofs -H "Accept: application/vnd.api+json" -H "Api-Key: [API token]" -H "Content-Type: application/vnd.api+json"

response

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
    "data": [
        {
            "id": "84155378-88d5-456e-844d-103596e3fb2c",
            "type": "proofs",
            "attributes": {
                "created_at": "2021-03-28T18:01:50.387Z",
                "expires_at": null,
                "external_reference_id": null
            },
            "relationships": {
                "proof_type": {
                    "links": {
                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/proof_type",
                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/proof_type"
                    }
                },
                "entity": {
                    "links": {
                        "self": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/relationships/entity",
                        "related": "https://api.didww.com/v3/proofs/84155378-88d5-456e-844d-103596e3fb2c/entity"
                    }
                }
            }
        }
    ],
    "meta": {
        "total_records": 1,
        "api_version": "2026-04-16"
    },
    "links": {
        "first": "https://api.didww.com/v3/proofs?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "last": "https://api.didww.com/v3/proofs?page%5Bnumber%5D=1&page%5Bsize%5D=50"
    }
}

Other Responses

Code

Success

Description

401

No

Unauthorized