Get Proof Types

Description

Returns the list of proof types for identities or addresses.

Request

HTTP Method: GET

URI Path: /v3/proof_types

URI Query Parameters:

Name

Type

Is Required?

Description

filtering

string

No

Filtering

Filters:

Filter Name

Type

Allow Blank

Allow Array

Filters by:

entity_type

string

Yes

Yes

The entity_type field.

Fielding:

Value

Returns:

name

The name attribute.

entity_type

The entity_type attribute.

Examples

http

GET /v3/proof_types 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/proof_types -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": "d2c1b3fb-29f7-46ca-ba82-b617f4630b78",
                        "type": "proof_types",
                        "attributes": {
                                "name": "Copy of Phone Bill",
                                "entity_type": "Address"
                        }
                },
                {
                        "id": "ab1fb565-ac55-4c73-bc55-64dc61e70169",
                        "type": "proof_types",
                        "attributes": {
                                "name": "Utility Bill",
                                "entity_type": "Address"
                        }
                },
                {
                        "id": "634aea96-43d9-49a2-bd4e-6e8e2ce4e5e9",
                        "type": "proof_types",
                        "attributes": {
                                "name": "Rental Receipt",
                                "entity_type": "Address"
                        }
                },
                {
                        "id": "49f42cbd-d051-43e0-9d30-883e154bad0d",
                        "type": "proof_types",
                        "attributes": {
                                "name": "Other",
                                "entity_type": "Address"
                        }
                }
        ],
        "meta": {
                "total_records": 4,
                "api_version": "2022-05-10"
        }
}

Other Responses

Code

Success

Description

401

No

Unauthorized