Update Identity

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

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

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}

Update Identity

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

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

OAuth Scope

identity:write_identity

Authorizations

Authorization

string

header

required

Path Parameters

string

required

Body

application/json

person_details

object

Show child attributes

metadata

object

Show child attributes

set_user_disabled

boolean

institution_details

object

Show child attributes

ref_id

string

tax_details

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

Show child attributes

set_tax_details_not_required

boolean

customer_due_diligence

object

Show child attributes

is_merchant

boolean

last_kyc_refresh_date

string<date-time>

Response

200 - application/json

string

required

metadata

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

institution_details

object

Show child attributes

institution_members

members associated with institution identity type · object[]

Show child attributes

created_at

string<date-time>

updated_at

string<date-time>

tax_details

tax payer details · object[]

Show child attributes

tax_details_not_required

boolean

summary_tin_verification_status

enum<string>

Available options:

TIN_VERIFICATION_PENDING,

TIN_VERIFICATION_ERROR,

TIN_VERIFICATION_VALID

customer_due_diligence

object

Show child attributes

is_merchant

boolean

last_kyc_refresh_date

string<date-time>

Get Identity Overview

⌘I

API Documentation

Deposits and Withdrawals

Identity

Profiles

Sandbox

Settlements

Orchestrations / Conversions

Taxes

Trading

Rewards

Events

API Credentials

Websockets

Webhooks

Problems

Update Identity

Authorizations

Path Parameters

Body

Response