Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Identity

Get Identity

Get an Identity by its (identity) id. You can only see identities created by you.

You can use the query parameter include_details to include identity details (person_details or institution_details) in the response and the query parameter include_institution_members to include institution members in the response.

get/identity/identities/{id}

Path parameters

idstring required

id associated with the identity

Query parameters

include_detailsboolean

query param; details are encrypted, so we do not want to include them by default

include_institution_membersboolean

query param; to include institution members for institution identity

Response

A successful response.

idstring required
metadataobject
status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
summary_status'PENDING' | 'ERROR' | 'APPROVED' | 'DENIED' | 'DISABLED'
user_disabledboolean

Deprecated: use status_details.active_controls instead.

admin_disabledboolean

Deprecated: use status_details.active_controls instead.

type'PERSON' | 'INSTITUTION'
ref_idstring

A user-facing ID to prevent duplicate account creation. Unique for all accounts created by the same API user.

created_atstring date-time

The time at which the identity is created at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

updated_atstring date-time

The time at which the identity is updated at. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

tax_details_not_requiredboolean
summary_tin_verification_status'TIN_VERIFICATION_PENDING' | 'TIN_VERIFICATION_ERROR' | 'TIN_VERIFICATION_VALID'

The TIN verification status for the associated tax_payer_id.

is_merchantboolean

True if the identity is a merchant.

last_kyc_refresh_datestring date-time

The last timestamp the identity has undergone a periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

Example response

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