# Get Identities Returns a list of Identities on your account. ## Request HTTP Method: `GET` URI Path: `/v3/identities` Note For all returned data attributes, see [Identity Object](identity-object.html). ### URI Query Parameters | Name | Type | Is Required? | Description | | --- | --- | --- | --- | | include | `string` | No | [Inclusion](../../../specification/includes.html#api-includes) | | filter[] | `string`, `DateTime` | No | [Filtering](../../../specification/filtering.html#api-filters) | | fields[identities] | `string` | No | [Sparse fieldsets](../../../specification/sparse-fieldsets.html#api-sparse-fieldsets) | | sort | `string` | No | [Sorting](../../../specification/sorting.html#api-sorting) | ### Includes | Value | Description | | --- | --- | | country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) | | birth\_country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) | | proofs | [Proofs Object](../proofs/proofs-object.html#proofs-object-v34) | | addresses | [Addresses Object](../addresses/address-object.html#addresses-object-v34) | | addresses.country | [Country Object](../../coverage-resources/countries/country-object.html#country-object-v34) | | proofs.proof\_type | [Proof Types Object](../proof-types/proof-types-object.html#proof-types-object-v34) | | permanent\_documents | [Permanent Documents Object](../permanent-documents/permanent-documents-object.html#permanent-documents-object-v34) | | permanent\_documents.template | [Supporting Document Template Object](../supporting-document-templates/supporting-document-templates-object.html#supporting-document-templates-object-v34) | ### Filters | Filter Name | Type | Allow Blank | Allow Array | Filters by: | | --- | --- | --- | --- | --- | | first\_name | `string` | Yes | Yes | The `first_name` field. | | first\_name\_contains | `string` | Yes | Yes | The `firs_name_contains` field. | | last\_name | `string` | Yes | Yes | The `last_name` field. | | last\_name\_contains | `string` | Yes | Yes | The `last_name_contains` field. | | phone\_number | `string` | Yes | Yes | The `phone_number` field. | | phone\_number\_contains | `string` | Yes | No | The `phone_number_contains` field. | | id\_number | `string` | Yes | Yes | The `id_number` field. | | id\_number\_contains | `string` | Yes | Yes | The `id_number_contains` field. | | birth\_date | `DateTime` | No | Yes | The `birth_date` field. | | company\_name | `string` | Yes | Yes | The `company_name` field. | | company\_name\_contains | `string` | Yes | Yes | The `company_name_contains` field. | | company\_reg\_number | `string` | Yes | Yes | The `company_reg_number` field. | | company\_reg\_number\_contains | `string` | Yes | Yes | The `company_reg_number_contains` field. | | vat\_id | `string` | Yes | Yes | The `vat_id` field. | | vat\_id\_contains | `string` | Yes | Yes | The `vat_id_contains` field. | | description | `string` | Yes | Yes | The `description` field. | | description\_contains | `string` | Yes | Yes | The `description_contains` field | | personal\_tax\_id | `string` | Yes | Yes | The `personal_tax_id` field. | | personal\_tax\_id\_contains | `string` | Yes | Yes | The `personal_tax_id` field. | | identity\_type | `string` | No | No | The `identity_type` field. Possible values: `any, personal`, `business`. | | country.id | `string` | No | No | The `country.id` field. | | external\_reference\_id | `string` | No | No | The `external_reference_id` field. | ### Sorting | Value | Sorts by: | | --- | --- | | first\_name | The `first_name` field. | | last\_name | The `last_name` field. | | phone\_number | The `phone_number` field. | | id\_number | The `id_number` field. | | birth\_date | The `birth_date` field. | | company\_name | The `company_name` field. | | company\_reg\_number | The `company_reg_number` field. | | vat\_id | The `vat_id` field. | | description | The `description` field. | | personal\_tax\_id | The `personal_tax_id` field. | ## Examples Simple RequestFilter first\_name\_containsInclude country [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/identities 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 -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": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c", "type": "identities", "attributes": { "first_name": "Jane", "last_name": "Smith", "phone_number": "353-1-9015266", "id_number": "0000000000", "birth_date": "2000-01-01", "company_name": null, "company_reg_number": null, "vat_id": null, "description": "Personal details", "personal_tax_id": null, "identity_type": "personal", "created_at": "2020-09-14T07:29:41.393Z", "external_reference_id": null, "verified": false, "contact_email": "contact@email.com" }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country" } }, "birth_country": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country" } }, "proofs": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs" } }, "addresses": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses" } }, "permanent_documents": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents" } } } } ], "meta": { "total_records": 4, "api_version": "2026-04-16" }, "links": { "first": "https://sandbox-api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://sandbox-api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/identities/v3/identities?filter%5Bfirst_name_contains%5D=Jane 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/v3/identities?filter%5Bfirst_name_contains%5D=Jane' -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": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c", "type": "identities", "attributes": { "first_name": "Jane", "last_name": "Smith", "phone_number": "353-1-9015266", "id_number": "0000000000", "birth_date": "2000-01-01", "company_name": null, "company_reg_number": null, "vat_id": null, "description": "Personal details", "personal_tax_id": null, "identity_type": "personal", "created_at": "2020-09-14T07:29:41.393Z", "external_reference_id": null, "verified": false, "contact_email": "contact@email.com" }, "relationships": { "country": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country" } }, "birth_country": { "links": { "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country", "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country" } }, "proofs": { "links": { "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs", "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs" } }, "addresses": { "links": { "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses", "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses" } }, "permanent_documents": { "links": { "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents", "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents" } } } } ], "meta": { "total_records": 4, "api_version": "2026-04-16" }, "links": { "first": "https://sandbox-api.didww.com/v3/identities?filter%5Bfirst_name_contains%5D=Jane&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://sandbox-api.didww.com/v3/identities?filter%5Bfirst_name_contains%5D=Jane&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] [[DIDWW-API-EXAMPLE-START]] http ``` GET /v3/identities/v3/identities?include=country 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/v3/identities?include=country' -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": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c", "type": "identities", "attributes": { "first_name": "Jane", "last_name": "Smith", "phone_number": "353-1-9015266", "id_number": "0000000000", "birth_date": "2000-01-01", "company_name": null, "company_reg_number": null, "vat_id": null, "description": "Personal details", "personal_tax_id": null, "identity_type": "personal", "created_at": "2020-09-14T07:29:41.393Z", "external_reference_id": null, "verified": false, "contact_email": "contact@email.com" }, }, "relationships":{ "country":{ "links":{ "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/country", "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/country" }, "data":{ "type": "countries", "id": "683c77a5-fcb0-48a0-8501-4de6284a2889" } }, "birth_country":{ "links":{ "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/birth_country", "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/birth_country" } }, "proofs": {"links":{ "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/proofs", "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/proofs" }}, "addresses": {"links":{ "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/addresses", "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/addresses" }}, "permanent_documents": {"links":{ "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/permanent_documents", "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/permanent_documents" }} } }], "included": [{ "id": "683c77a5-fcb0-48a0-8501-4de6284a2889", "type": "countries", "attributes":{ "name": "Lithuania", "prefix": "370", "iso": "LT" }, "relationships": {"regions": {"links":{ "self": "https://api.didww.com/v3/countries/683c77a5-fcb0-48a0-8501-4de6284a2889/relationships/regions", "related": "https://api.didww.com/v3/countries/683c77a5-fcb0-48a0-8501-4de6284a2889/regions" }}} }], "meta": { "total_records": 1, "api_version": "2026-04-16" }, "links": { "first": "https://api.didww.com/v3/identities?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50", "last": "https://api.didww.com/v3/identities?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50" } } ``` [[DIDWW-API-EXAMPLE-END]] ## Other Responses | Code | Success | Description | | --- | --- | --- | | 401 | No | [Unauthorized](../../../configuration.html#api-key) | On this page