Get Proof Types#

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.

Sparse Fieldsets#

Value

Returns:

name

The name attribute.

entity_type

The entity_type attribute.

Examples#

http

1GET /v3/proof_types HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]

curl

1curl -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

 1HTTP/1.1 200 OK
 2Content-Type: application/vnd.api+json
 3
 4{
 5        "data": [
 6                {
 7                        "id": "d2c1b3fb-29f7-46ca-ba82-b617f4630b78",
 8                        "type": "proof_types",
 9                        "attributes": {
10                                "name": "Copy of Phone Bill",
11                                "entity_type": "Address"
12                        }
13                },
14                {
15                        "id": "ab1fb565-ac55-4c73-bc55-64dc61e70169",
16                        "type": "proof_types",
17                        "attributes": {
18                                "name": "Utility Bill",
19                                "entity_type": "Address"
20                        }
21                },
22                {
23                        "id": "634aea96-43d9-49a2-bd4e-6e8e2ce4e5e9",
24                        "type": "proof_types",
25                        "attributes": {
26                                "name": "Rental Receipt",
27                                "entity_type": "Address"
28                        }
29                },
30                {
31                        "id": "49f42cbd-d051-43e0-9d30-883e154bad0d",
32                        "type": "proof_types",
33                        "attributes": {
34                                "name": "Other",
35                                "entity_type": "Address"
36                        }
37                }
38        ],
39        "meta": {
40                "total_records": 4,
41                "api_version": "2022-05-10"
42        }
43}

Other Responses#

Code

Success

Description

401

No

Unauthorized