Get Identity#

Description

Returns a single Identity in the account.

Request#

HTTP Method: GET

URI Path: /v3/identities/

URI Query Parameters:

Name

Type

Is Required?

Description

id

string

Yes

Unique ID identifier of the Identity.

Examples#

http

1GET /v3/identities/0083c7f2-b030-491f-91b3-54597967ca38 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/identities/0083c7f2-b030-491f-91b3-54597967ca38 -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        "id": "0083c7f2-b030-491f-91b3-54597967ca38",
 7        "type": "identities",
 8        "attributes": {
 9            "first_name": "Jane",
10            "last_name": "Smith",
11            "phone_number": "1276813663",
12            "id_number": "",
13            "birth_date": null,
14            "company_name": null,
15            "company_reg_number": null,
16            "vat_id": null,
17            "description": null,
18            "personal_tax_id": null,
19            "identity_type": "Personal"
20            "created_at": "2025-04-11T13:03:17.029Z",
21            "external_reference_id": null,
22            "verified": false,
23            "contact_email": "contact@email.com"
24        },
25        "relationships": {
26            "country": {
27                "links": {
28                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/country",
29                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/country"
30                }
31            },
32            "proofs": {
33                "links": {
34                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/proofs",
35                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/proofs"
36                }
37            },
38            "addresses": {
39                "links": {
40                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/addresses",
41                    "related": "https://sandbox-api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/addresses"
42                }
43            },
44            "permanent_documents": {
45                "links": {
46                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/permanent_documents",
47                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/permanent_documents"
48                }
49            }
50        }
51    },
52    "meta": {
53        "api_version": "2021-12-15"
54    }
55}

Other Responses#

Code

Success

Description

404

No

Not Found

401

No

Unauthorized