Sign in

v1

latestOpenAPI 3.0.02026-07-26117342409.6 KB
Identity

Update Identity

Updates an Identity, this action performs a delta of what is submitted in the update and the existing identity.

  • Updating details (person_details or institution_details) might lead to the identity being re-verified (e.g. re-screening name changes), which could impact the identity's ability to transact on the Platform.
  • Setting set_user_disabled to true will make the Identity DISABLED (read more here on what this means)
  • Setting tax_details will update all the tax details for the identity
  • Setting last_kyc_refresh_date indicates this is not an adhoc-update, and instead an update for a periodic kyc refresh

Changing an Institution Identity to a Person and vice-versa is not supported.

put/identity/identities/{id}

Path parameters

idstring required

Request body

metadataobject
set_user_disabledboolean

true disables the identity. false re-enables it, unless it has been disabled by a Paxos admin.

ref_idstring

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

set_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.

last_kyc_refresh_datestring date-time

Set to the timestamp the identity has last undergone a periodic kyc refresh. If unset, the update is not for periodic kyc refresh. RFC3339 format, like YYYY-MM-DDTHH:MM:SS.sssZ. ex: 2006-01-02T15:04:05Z.

Example request

{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "person_details": {
    "first_name": "John"
  }
}

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