Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Identity

Create Identity

Creates a new Person or Institution Identity on the Paxos Platform.

A successful response indicates that the identity has been created and is PENDING approval. The identity is only available to use on the Platform once it is APPROVED. For a full description of statuses read the status guide here.

For detailed guidance on which fields are required for your integration or the lifecycle of an Identity on the platform, please read the Identity Developer Guide.

post/identity/identities

Request body

metadataobject
ref_idstring

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

tax_details_not_requiredboolean

Set to true if tax details are not legally required. Must not be true when cip_id_country is USA.

is_merchantboolean

Set to true to indicate that this identity is a merchant.

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"
}