Get Identity
GET https://{{host}}/v3/identities/:id
Returns a single Identity in the account.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
include | null | Comma-separated values of include parameter. | |
The response will include a top-level object relationships with associated data under the appropriate resource key. | |||
Details in Inclusion of Related Resources Article. |
Allowed values:
country - Country Object
proofs - Proof Object
proofs.proof_type - Proof Type Object
addresses - Address Object
addresses.country - Country Object
permanent_documents - Permanent Document Object
permanent_documents.template - Supporting Document Template Object *** |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string | ||
Content-Type | string | ||
Api-Key | string |
RESPONSES
status: OK
{"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":"2021-04-20T13:37:21.594Z","external_reference_id":null,"verified":false},"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"},"data":{"type":"countries","id":"b9dce495-1085-4452-8224-6761dd3cc15a"}},"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://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"}}}},"included":[{"id":"b9dce495-1085-4452-8224-6761dd3cc15a","type":"countries","attributes":{"name":"Andorra","prefix":"376","iso":"AD"},"relationships":{"regions":{"links":{"self":"https://api.didww.com/v3/countries/b9dce495-1085-4452-8224-6761dd3cc15a/relationships/regions","related":"https://api.didww.com/v3/countries/b9dce495-1085-4452-8224-6761dd3cc15a/regions"}}}}],"meta":{"api_version":"2022-05-10"}}