v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB

Identity

List Identities

This endpoint enables you to fetch a list of Identities. You can use query parameters to filter the results returned by created_at, updated_at, summary_status and identity_type

Note that this endpoint supports pagination and returns a cursor token for fetching next pages.

get/identity/identities

Query parameters

summary_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'

Summary Status of the Identity.

created_at.ltstring date-time

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.ltestring date-time

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.eqstring date-time

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtestring date-time

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

created_at.gtstring date-time

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.ltstring date-time

Include timestamps strictly less than lt. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.ltestring date-time

Include timestamps less than or equal to lte. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.eqstring date-time

Include timestamps exactly equal to eq. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.gtestring date-time

Include timestamps greater than or equal to gte. RFC3339 format, like 2006-01-02T15:04:05Z.

updated_at.gtstring date-time

Include timestamps strictly greater than gt. RFC3339 format, like 2006-01-02T15:04:05Z.

limitinteger

Number of results to return.

order'DESC' | 'ASC'

Return items in ascending (ASC) or descending (DESC) order. Defaults to DESC.

order_by'CREATED_AT'

The specific method by which the returned results will be ordered.

page_cursorstring

Cursor token for fetching the next page.

identity_type'PERSON' | 'INSTITUTION'

Optionally filter by Identity type

control_typesstring[]

Optionally filter by active identity control types. Only returns identities with active controls matching any of these types.

control_reason_codesstring[]

Optionally filter by active identity control reason codes. Only returns identities with active controls matching any of these reason codes.

OTHER: Miscellaneous reason not captured by existing categories.
END_USER_REQUEST: Control applied at the end user's request.
INACTIVITY: Control applied due to prolonged inactivity in accordance with dormancy or lifecycle management policies.
COMPLIANCE_KYC: Control applied due to unmet KYC requirements, including missing, expired, failed, or unresponsiveness to refresh obligations.
COMPLIANCE_EDD: Control applied due to Enhanced Due Diligence (EDD) requirements, including failure to complete EDD reviews, provide requested information, or satisfy heightened risk assessment criteria.
COMPLIANCE_SCREENING: Control applied as a result of sanctions, politically exposed person (PEP), or adverse media screening hits.
COMPLIANCE_INVESTIGATION: Control applied while an identity is under active compliance, risk, or regulatory investigation, including reviews triggered by monitoring alerts or external inquiries.
COMPLIANCE_INCOMPLETE: Control applied because the onboarding process was not successfully completed, including failure to respond to requests for information or provide required documentation.
RISK_FRAUD: Control applied due to suspected or confirmed fraud, abuse, or security risk, including account compromise, transaction fraud, or policy violations.
LEGAL_ORDER: Control applied to comply with a legal, regulatory, or law-enforcement directive, including court orders, asset preservation requests, or regulatory instructions.
ADMINISTRATIVE: Control applied for operational or platform-initiated reasons not attributable to the end user or compliance failure, such as system remediation or account restructuring.

Response

A successful response.

next_page_cursorstring

Cursor token required for fetching the next page.

Example response

{
  "items": [
    {
      "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
      "summary_status": "PENDING"
    }
  ]
}