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.

URI Query Parameters#

Name

Type

Is Required?

Description

include

string

No

Inclusion

filter[<filter_name>]

string, date

No

Filtering

fields[identities]

string

No

Sparse fieldsets

sort

string

No

Sorting

page[number]

integer

No

Page number.

page[size]

integer

No

Page size. Pagination defaults to 50 records per page. The maximum is 100.

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

Filters#

Filter Name

Type

Allow Blank

Allow Array

Filters by:

id

string

No

Yes

The id field.

first_name

string

Yes

No

The first_name field.

first_name_contains

string

Yes

No

The first_name_contains field.

last_name

string

Yes

No

The last_name field.

last_name_contains

string

Yes

No

The last_name_contains field.

phone_number

string

Yes

No

The phone_number field.

phone_number_contains

string

Yes

No

The phone_number_contains field.

id_number

string

Yes

No

The id_number field.

id_number_contains

string

Yes

No

The id_number_contains field.

birth_date

date

No

No

The birth_date field.

company_name

string

Yes

No

The company_name field.

company_name_contains

string

Yes

No

The company_name_contains field.

company_website

string

Yes

No

The company_website field (exact match).

company_website_contains

string

Yes

No

The company_website_contains field.

company_reg_number

string

Yes

No

The company_reg_number field.

company_reg_number_contains

string

Yes

No

The company_reg_number_contains field.

vat_id

string

Yes

No

The vat_id field.

vat_id_contains

string

Yes

No

The vat_id_contains field.

description

string

Yes

No

The description field.

description_contains

string

Yes

No

The description_contains field.

personal_tax_id

string

Yes

No

The personal_tax_id field.

personal_tax_id_contains

string

Yes

No

The personal_tax_id_contains field.

identity_type

string

No

No

The identity_type field. Possible values: personal, business.

country.id

string

No

Yes

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_website

The company_website 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.

contact_email

The contact_email field.

created_at

The created_at field.

verified

The verified field.

external_reference_id

The external_reference_id field.

Examples#

http

1GET /v3/identities 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 -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                {
 7                    "id": "0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c",
 8                    "type": "identities",
 9                    "attributes": {
10                        "first_name": "Jane",
11                        "last_name": "Smith",
12                        "phone_number": "35319015266",
13                        "id_number": "0000000000",
14                        "birth_date": "2000-01-01",
15                        "company_name": null,
16                        "company_website": null,
17                        "company_reg_number": null,
18                        "vat_id": null,
19                        "description": "Personal details",
20                        "personal_tax_id": null,
21                        "identity_type": "personal",
22                        "created_at": "2020-09-14T07:29:41.393Z",
23                        "external_reference_id": null,
24                        "verified": false,
25                        "contact_email": "contact@email.com"
26                    },
27                    "relationships": {
28                        "country": {
29                            "links": {
30                                "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
31                                "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
32                            }
33                        },
34                        "birth_country": {
35                            "links": {
36                                "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/birth_country",
37                                "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/birth_country"
38                            }
39                        },
40                        "proofs": {
41                            "links": {
42                                "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
43                                "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
44                            }
45                        },
46                        "addresses": {
47                            "links": {
48                                "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
49                                "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
50                            }
51                        },
52                        "permanent_documents": {
53                            "links": {
54                                "self": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
55                                "related": "https://api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
56                            }
57                        }
58                    }
59                }
60            ],
61            "meta": {
62                "total_records": 4,
63                "api_version": "2026-11-19"
64            },
65            "links": {
66                "first": "https://api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50",
67                "last": "https://api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50"
68            }
69        }

Other Responses#

Code

Success

Description

400

No

Bad Request. Malformed request: unknown filter, bad pagination or bad sort field.

401

No

Unauthorized

429

No

The request budget of the account for the current window is spent (too_many_requests). Retry-After gives the number of seconds to wait.