Qodex.ai

Get Identities

GET https://{{host}}/v3/identities

Returns a list of Identities on your account.

Request Params

KeyDatatypeRequiredDescription
includenullComma-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 | | filter[first_name] | null | | string - Filters by the first_name field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[first_name_contains] | null | | string - Filters by the first_name_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[last_name] | null | | string - Filters by the last_name field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[last_name_contains] | null | | string - Filters by the last_name_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[phone_number] | null | | string - Filters by the phone_number field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[phone_number_contains] | null | | string - Filters by the phone_number_contains field.

  • Allow blank - Yes.

  • Allow array - No. | | filter[id_number] | null | | string - Filters by the id_number field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[id_number_contains] | null | | string - Filters by the id_number_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[birth_date] | null | | string[DateTime] - Filters by the birth_date field.

  • Allow blank - No.

  • Allow array - Yes. | | filter[company_name] | null | | string - Filters by the company_name field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[company_name_contains] | null | | string - Filters by the company_name_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[company_reg_number] | null | | string - Filters by the company_reg_number field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[company_reg_number_contains] | null | | string - Filters by the company_reg_number_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[vat_id] | null | | string - Filters by the vat_id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[vat_id_contains] | null | | string - Filters by the vat_id_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[description] | null | | string - Filters by the description field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[description_contains] | null | | string - Filters by the description_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[personal_tax_id] | null | | string - Filters by the personal_tax_id field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[personal_tax_id_contains] | null | | string - Filters by the personal_tax_id_contains field.

  • Allow blank - Yes.

  • Allow array - Yes. | | filter[identity_type] | null | | string - Filters by the identity_type field.

  • Allow blank - No.

  • Allow array - No. | | filter[country.id] | null | | string - Filters by the country.id field.

  • Allow blank - No.

  • Allow array - No. | | fields[identities] | null | | The value of the fields parameter MUST be a comma-separated (U+002C COMMA, “,”) list that refers to the name(s) of the fields to be returned.
    An empty value indicates that no fields should be returned.

Allowed values:

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.

identity_type - The identity_type field.

created_at - The created_at field.

external_reference_id - The external_reference_id field.

verified - The verified field. *** | | sort | null | | Used for sorting the fields returned by the request, with a comma , separating the included fields. Details in Sorting Article.

first_name - Sorts by the first_name field.

last_name - Sorts by the last_name field.

phone_number - Sorts by the phone_number field.

id_number - Sorts by the id_number field.

birth_date - Sorts by the birth_date field.

company_name - Sorts by the company_name field.

company_reg_number - Sorts by the company_reg_number field.

vat_id - Sorts by the vat_id field.

description - Sorts by the description field.

personal_tax_id - Sorts by the personal_tax_id field. *** |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring
Content-Typestring
Api-Keystring

RESPONSES

status: OK

{"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\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50","last":"https://api.didww.com/v3/identities?include=country\u0026page%5Bnumber%5D=1\u0026page%5Bsize%5D=50"}}