Get Identity#
Returns a single Identity in the account.
Request#
HTTP Method: GET
URI Path: /v3/identities/{id}
Note
For all returned data attributes, see Identity Object.
URI Query Parameters#
Name |
Type |
Is Required? |
Description |
|---|---|---|---|
id |
|
Yes |
Unique ID identifier of the Identity. |
include |
|
No |
Related resources to include in the response. See Inclusion. |
fields[identities] |
|
No |
Includes#
Value |
Description |
|---|---|
country |
|
birth_country |
|
proofs |
|
addresses |
|
addresses.country |
|
proofs.proof_type |
|
permanent_documents |
|
permanent_documents.template |
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
5Authorization: Bearer [access token]
curl
1curl -i -X GET https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38 -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 "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": null,
13 "birth_date": null,
14 "company_name": null,
15 "company_website": null,
16 "company_reg_number": null,
17 "vat_id": null,
18 "description": null,
19 "personal_tax_id": null,
20 "identity_type": "personal",
21 "created_at": "2025-04-11T13:03:17.029Z",
22 "external_reference_id": null,
23 "verified": false,
24 "contact_email": "jane@example.com"
25 },
26 "relationships": {
27 "country": {
28 "links": {
29 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/country",
30 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/country"
31 }
32 },
33 "birth_country": {
34 "links": {
35 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/birth_country",
36 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/birth_country"
37 }
38 },
39 "proofs": {
40 "links": {
41 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/proofs",
42 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/proofs"
43 }
44 },
45 "addresses": {
46 "links": {
47 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/addresses",
48 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/addresses"
49 }
50 },
51 "permanent_documents": {
52 "links": {
53 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/permanent_documents",
54 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/permanent_documents"
55 }
56 }
57 }
58 },
59 "meta": {
60 "api_version": "2026-11-19"
61 }
62}
http
1GET /v3/identities/0083c7f2-b030-491f-91b3-54597967ca38?include=country 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/identities/0083c7f2-b030-491f-91b3-54597967ca38?include=country' -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 "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": null,
13 "birth_date": null,
14 "company_name": null,
15 "company_website": null,
16 "company_reg_number": null,
17 "vat_id": null,
18 "description": null,
19 "personal_tax_id": null,
20 "identity_type": "personal",
21 "created_at": "2025-04-11T13:03:17.029Z",
22 "external_reference_id": null,
23 "verified": false,
24 "contact_email": "jane@example.com"
25 },
26 "relationships": {
27 "country": {
28 "links": {
29 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/country",
30 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/country"
31 },
32 "data": {
33 "type": "countries",
34 "id": "b9dce495-1085-4452-8224-6761dd3cc15a"
35 }
36 },
37 "birth_country": {
38 "links": {
39 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/birth_country",
40 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/birth_country"
41 }
42 },
43 "proofs": {
44 "links": {
45 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/proofs",
46 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/proofs"
47 }
48 },
49 "addresses": {
50 "links": {
51 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/addresses",
52 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/addresses"
53 }
54 },
55 "permanent_documents": {
56 "links": {
57 "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/permanent_documents",
58 "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/permanent_documents"
59 }
60 }
61 }
62 },
63 "included": [
64 {
65 "id": "b9dce495-1085-4452-8224-6761dd3cc15a",
66 "type": "countries",
67 "attributes": {
68 "name": "Andorra",
69 "prefix": "376",
70 "iso": "AD"
71 },
72 "relationships": {
73 "regions": {
74 "links": {
75 "self": "https://api.didww.com/v3/countries/b9dce495-1085-4452-8224-6761dd3cc15a/relationships/regions",
76 "related": "https://api.didww.com/v3/countries/b9dce495-1085-4452-8224-6761dd3cc15a/regions"
77 }
78 }
79 }
80 }
81 ],
82 "meta": {
83 "api_version": "2026-11-19"
84 }
85}
Other Responses#
Code |
Success |
Description |
|---|---|---|
404 |
No |
|
401 |
No |
|
429 |
No |
The request budget of the account for the current window is spent ( |