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	string	Yes	Unique ID identifier of the Identity.
include	string	No	Related resources to include in the response. See Inclusion.

Includes

Value	Description
country	Country Object
birth_country	Country Object
proofs	Proofs Object
addresses	Addresses Object
addresses.country	Country Object
proofs.proof_type	Proof Types Object
permanent_documents	Permanent Documents Object
permanent_documents.template	Supporting Document Template Object

Examples

Simple RequestInclude country

http

GET /v3/identities/0083c7f2-b030-491f-91b3-54597967ca38 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/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

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

{
    "data": {
        "id": "0083c7f2-b030-491f-91b3-54597967ca38",
        "type": "identities",
        "attributes": {
            "first_name": "Jane",
            "last_name": "Smith",
            "phone_number": "1276813663",
            "id_number": "",
            "birth_date": null,
            "company_name": null,
            "company_reg_number": null,
            "vat_id": null,
            "description": null,
            "personal_tax_id": null,
            "identity_type": "personal",
            "created_at": "2025-04-11T13:03:17.029Z",
            "external_reference_id": null,
            "verified": false,
            "contact_email": "contact@email.com"
        },
        "relationships": {
            "country": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/country",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/country"
                }
            },
            "birth_country": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/birth_country",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/birth_country"
                }
            },
            "proofs": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/proofs",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/proofs"
                }
            },
            "addresses": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/addresses",
                    "related": "https://sandbox-api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/addresses"
                }
            },
            "permanent_documents": {
                "links": {
                    "self": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/relationships/permanent_documents",
                    "related": "https://api.didww.com/v3/identities/0083c7f2-b030-491f-91b3-54597967ca38/permanent_documents"
                }
            }
        }
    },
    "meta": {
        "api_version": "2026-04-16"
    }
}

Other Responses

Code	Success	Description
404	No	Not Found
401	No	Unauthorized