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}

Update Identity

cURL

curl --request PUT \
  --url https://api.paxos.com/v2/identity/identities/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "f190b163-208f-4d73-8deb-4fb8b24add00",
  "person_details": {
    "first_name": "John"
  }
}
'

200

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

OAuth Scope

identity:write_identity

Authorizations

Authorization · string · header · required

Paxos APIs use OAuth 2 with the client credentials grant flow.

Token URLs:

• Production: https://oauth.paxos.com/oauth2/token
• Sandbox: https://oauth.sandbox.paxos.com/oauth2/token

Learn more in the API credentials guide →

Path Parameters

id · string · required

Body

application/json

person_details · object

Show child attributes

metadata · API User-facing metadata · object

Show child attributes

set_user_disabled · boolean

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

institution_details · object

Show child attributes

ref_id · string

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

tax_details · list of tax details associated with the identity · object[]

Show child attributes

set_tax_details_not_required · boolean

Set to true if tax details are not legally required.

customer_due_diligence · object

Show child attributes

is_merchant · boolean

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

last_kyc_refresh_date · string<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.

Response

200 - application/json

A successful response.

id · string · required

metadata · API User-facing metadata · object

Show child attributes

status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

status_details · object

Show child attributes

summary_status · enum<string>

Available options: PENDING, ERROR, APPROVED, DENIED, DISABLED

user_disabled · boolean

admin_disabled · boolean

person_details · object

Show child attributes

type · enum<string>

Available options: PERSON, INSTITUTION

ref_id · string

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

institution_details · object

Show child attributes

institution_members · members associated with institution identity type · object[]

Show child attributes

created_at · string<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_at · string<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 · tax payer details · object[]

Show child attributes

tax_details_not_required · boolean

summary_tin_verification_status · enum<string>

The TIN verification status for the associated tax_payer_id.

Available options: TIN_VERIFICATION_PENDING, TIN_VERIFICATION_ERROR, TIN_VERIFICATION_VALID

customer_due_diligence · object

Show child attributes

is_merchant · boolean

True if the identity is a merchant.

last_kyc_refresh_date · string<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.