Get Identities

Description

Returns a list of Identities on your account.

Request

HTTP Method: GET

URI Path: /v3/identities

URI Query Parameters:

Name

Type

Is Required?

Description

filter[<filter_name>]

integer, string, DateTime

Optional

Filtering

includes

string

Optional

Inclusion

sort

string

Optional

Inclusion

Includes:

Value

Description

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:

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.

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.

Fielding:

Value

Returns:

first_name

The first_name attribute.

last_name

The last_name attribute.

phone_number

The phone_number attribute.

id_number

The id_number attribute.

birth_date

The birth_date attribute.

company_name

The company_name attribute.

company_reg_number

The company_reg_number attribute.

vat_id

The vat_id attribute.

description

The description attribute.

personal_tax_id

The personal_tax_id attribute.

identity_type

The identity_type attribute.

created_at

The created_at attribute.

external_reference_id

The external_reference_id attribute.

verified

The verified attribute.

Examples

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 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
                    },
                    "relationships": {
                        "country": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
                                "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/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": "2022-05-10"
            },
            "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"
            }
        }

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 '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
                    },
                    "relationships": {
                        "country": {
                            "links": {
                                "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
                                "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/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": "2022-05-10"
            },
            "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"
            }
        }

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 '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": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d",
          "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
          },
          "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"
                }
             },
             "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": "2022-05-10"
       },
       "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"
       }
    }

Other Responses

Code

Success

Description

401

No

Unauthorized