Search for identities

get

https://api.dev.cfx.to/v1/identity

If no results are found, an empty array is returned.

To return deleted identities, DELETED status must be supplied explicitly for statuses query param.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

ids

string

Return all identities matching these IDs (comma-separated list).

referenceIds

string

Return all identities matching these customer reference IDs (comma-separated list).

statuses

string

Return all identities matching these statuses (comma-separated list).

countriesOfResidence

string

Return all identities matching these countries of residence (comma-separated list).

emails

string

Return all identities matching these emails (comma-separated list).

phones

string

Return all identities matching these phone numbers (comma-separated list).

nameLike

string

Return all identities whose name partially matches first name, middle name, last name or full name (case-insensitive).

referenceIdLike

string

Return all identities whose customer reference ID partially matches this value (case-insensitive).

emailLike

string

Return all identities whose email partially matches this value (case-insensitive).

phoneLike

string

Return all identities whose phone number partially matches this value (case-insensitive).

hasCustomerVerification

boolean

Return only identities that have customer verification or don't. Omit to return identities regardless of customer verification.

amlVerificationStatuses

string

Anti-money laundering verification statuses (comma-separated list).

identityDocumentVerificationStatuses

string

Identity document verification statuses (comma-separated list).

createdBefore

date-time

Filter identities created before the specified date-time

createdAfter

date-time

Filter identities created after the specified date-time

updatedBefore

date-time

Filter identities updated before the specified date-time

updatedAfter

date-time

Filter identities updated after the specified date-time

orderBy

string

Comma-separated list of fields and directions to order the results by.

Format: <field name>:<direction>,...

<field name>: createdAt, updatedAt
<direction>: ASC, DESC

page

integer

Defaults to 1

Result page number to return, starting from 1

pageSize

integer

≤ 50

Defaults to 10

Items per page to return

Responses

200Default Response

401The access to this resource has been denied

defaultCatch-all error response for any unexpected internal errors