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>] |
|
Optional |
|
include |
|
Optional |
|
sort |
|
Optional |
Includes:
Value |
Description |
|---|---|
country |
|
proofs |
|
addresses |
|
addresses.country |
|
proofs.proof_type |
|
permanent_documents |
|
permanent_documents.template |
Filters:
Filter Name |
Type |
Allow Blank |
Allow Array |
Filters by: |
|---|---|---|---|---|
first_name |
|
Yes |
Yes |
The |
first_name_contains |
|
Yes |
Yes |
The |
last_name |
|
Yes |
Yes |
The |
last_name_contains |
|
Yes |
Yes |
The |
phone_number |
|
Yes |
Yes |
The |
phone_number_contains |
|
Yes |
No |
The |
id_number |
|
Yes |
Yes |
The |
id_number_contains |
|
Yes |
Yes |
The |
birth_date |
|
No |
Yes |
The |
company_name |
|
Yes |
Yes |
The |
company_name_contains |
|
Yes |
Yes |
The |
company_reg_number |
|
Yes |
Yes |
The |
company_reg_number_contains |
|
Yes |
Yes |
The |
vat_id |
|
Yes |
Yes |
The |
vat_id_contains |
|
Yes |
Yes |
The |
description |
|
Yes |
Yes |
The |
description_contains |
|
Yes |
Yes |
The |
personal_tax_id |
|
Yes |
Yes |
The |
personal_tax_id_contains |
|
Yes |
Yes |
The |
identity_type |
|
No |
No |
The |
country.id |
|
No |
No |
The |
external_reference_id |
|
No |
No |
The |
Sorting:
Value |
Sorts by: |
|---|---|
first_name |
The |
last_name |
The |
phone_number |
The |
id_number |
The |
birth_date |
The |
company_name |
The |
company_reg_number |
The |
vat_id |
The |
description |
The |
personal_tax_id |
The |
Sparse Fieldsets:
Value |
Returns: |
|---|---|
first_name |
The |
last_name |
The |
phone_number |
The |
id_number |
The |
birth_date |
The |
company_name |
The |
company_reg_number |
The |
vat_id |
The |
description |
The |
personal_tax_id |
The |
identity_type |
The |
created_at |
The |
external_reference_id |
The |
verified |
The |
contact_email |
The |
Examples#
http
1GET /v3/identities HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -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
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": "353-1-9015266",
13 "id_number": "0000000000",
14 "birth_date": "2000-01-01",
15 "company_name": null,
16 "company_reg_number": null,
17 "vat_id": null,
18 "description": "Personal details",
19 "personal_tax_id": null,
20 "identity_type": "Personal",
21 "created_at": "2020-09-14T07:29:41.393Z",
22 "external_reference_id": null,
23 "verified": false,
24 "contact_email": "contact@email.com"
25 },
26 "relationships": {
27 "country": {
28 "links": {
29 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
30 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
31 }
32 },
33 "proofs": {
34 "links": {
35 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
36 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
37 }
38 },
39 "addresses": {
40 "links": {
41 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
42 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
43 }
44 },
45 "permanent_documents": {
46 "links": {
47 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
48 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
49 }
50 }
51 }
52 }
53 ],
54 "meta": {
55 "total_records": 4,
56 "api_version": "2021-12-15"
57 },
58 "links": {
59 "first": "https://sandbox-api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50",
60 "last": "https://sandbox-api.didww.com/v3/identities?page%5Bnumber%5D=1&page%5Bsize%5D=50"
61 }
62 }
http
1GET /v3/identities/v3/identities?filter%5Bfirst_name_contains%5D=Jane HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -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
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": "353-1-9015266",
13 "id_number": "0000000000",
14 "birth_date": "2000-01-01",
15 "company_name": null,
16 "company_reg_number": null,
17 "vat_id": null,
18 "description": "Personal details",
19 "personal_tax_id": null,
20 "identity_type": "Personal",
21 "created_at": "2020-09-14T07:29:41.393Z",
22 "external_reference_id": null,
23 "verified": false,
24 "contact_email": "contact@email.com"
25 },
26 "relationships": {
27 "country": {
28 "links": {
29 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/country",
30 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/country"
31 }
32 },
33 "proofs": {
34 "links": {
35 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/proofs",
36 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/proofs"
37 }
38 },
39 "addresses": {
40 "links": {
41 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/addresses",
42 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/addresses"
43 }
44 },
45 "permanent_documents": {
46 "links": {
47 "self": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/relationships/permanent_documents",
48 "related": "https://sandbox-api.didww.com/v3/identities/0c95a4c3-c5e6-4ea0-a8ba-bfb65850913c/permanent_documents"
49 }
50 }
51 }
52 }
53 ],
54 "meta": {
55 "total_records": 4,
56 "api_version": "2021-12-15"
57 },
58 "links": {
59 "first": "https://sandbox-api.didww.com/v3/identities?filter%5Bfirst_name_contains%5D=Jane&page%5Bnumber%5D=1&page%5Bsize%5D=50",
60 "last": "https://sandbox-api.didww.com/v3/identities?filter%5Bfirst_name_contains%5D=Jane&page%5Bnumber%5D=1&page%5Bsize%5D=50"
61 }
62 }
http
1GET /v3/identities/v3/identities?include=country HTTP/1.1
2Host: api.didww.com
3Content-Type: application/vnd.api+json
4Accept: application/vnd.api+json
5Api-Key: [API token]
curl
1curl -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
1HTTP/1.1 200 OK
2Content-Type: application/vnd.api+json
3
4
5 {
6 "data": [ {
7 "id": "6c832a1d-b19d-471b-b416-9b5bf2b6ef9d",
8 "type": "identities",
9 "attributes": {
10 "first_name": "Jane",
11 "last_name": "Smith",
12 "phone_number": "353-1-9015266",
13 "id_number": "0000000000",
14 "birth_date": "2000-01-01",
15 "company_name": null,
16 "company_reg_number": null,
17 "vat_id": null,
18 "description": "Personal details",
19 "personal_tax_id": null,
20 "identity_type": "Personal",
21 "created_at": "2020-09-14T07:29:41.393Z",
22 "external_reference_id": null,
23 "verified": false,
24 "contact_email": "contact@email.com"
25 },
26 "relationships": {
27 "country": {
28 "links": {
29 "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/country",
30 "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/country"
31 },
32 "data": {
33 "type": "countries",
34 "id": "683c77a5-fcb0-48a0-8501-4de6284a2889"
35 }
36 },
37 "proofs": {"links": {
38 "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/proofs",
39 "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/proofs"
40 }},
41 "addresses": {"links": {
42 "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/addresses",
43 "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/addresses"
44 }},
45 "permanent_documents": {"links": {
46 "self": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/relationships/permanent_documents",
47 "related": "https://api.didww.com/v3/identities/6c832a1d-b19d-471b-b416-9b5bf2b6ef9d/permanent_documents"
48 }}
49 }
50 }],
51 "included": [ {
52 "id": "683c77a5-fcb0-48a0-8501-4de6284a2889",
53 "type": "countries",
54 "attributes": {
55 "name": "Lithuania",
56 "prefix": "370",
57 "iso": "LT"
58 },
59 "relationships": {"regions": {"links": {
60 "self": "https://api.didww.com/v3/countries/683c77a5-fcb0-48a0-8501-4de6284a2889/relationships/regions",
61 "related": "https://api.didww.com/v3/countries/683c77a5-fcb0-48a0-8501-4de6284a2889/regions"
62 }}}
63 }],
64 "meta": {
65 "total_records": 1,
66 "api_version": "2021-12-15"
67 },
68 "links": {
69 "first": "https://api.didww.com/v3/identities?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50",
70 "last": "https://api.didww.com/v3/identities?include=country&page%5Bnumber%5D=1&page%5Bsize%5D=50"
71 }
72 }
Other Responses#
Code |
Success |
Description |
|---|---|---|
401 |
No |