Update an identity

patch

https://api.dev.cfx.to/v1/identity/{identityId}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identityId

string

required

Unique identifier for this identity

Body Params

status

string

enum

Allowed:

referenceId

string

Customer's unique identifier for this identity

dateOfBirth

string

Date of birth in ISO-8601 format: yyyy-MM-dd

taxId

string

The identity's tax identification number — SSN or ITIN for a US person, the local equivalent elsewhere.

string

Email to contact the identity

phone

string

Contact phone number for the identity, in any common format, e.g. +1 (212) 555-1234. On create, a number without a country code is read in the country of residence. Stored and returned in E.164.

customerVerification

object

Customer provides their own verification

metadata

object

Keys to set on this identity's metadata: the keys you send replace the stored ones and the rest are kept. Set a key to null to remove it; an empty string is stored as a value. At most 50 keys. A key is 1 to 40 characters and cannot contain [ or ]; a value is a string of at most 500 characters. The limit of 50 keys applies to the stored result.

Headers

Idempotency-Key

string

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

400Default Response

401The access to this resource has been denied

403The credentials are valid but the caller is not permitted to transact

404The resource was not found

409An identical request (the same Idempotency-Key, or on a keyless v1 money route the same body) is still executing. Wait for Retry-After seconds and send the same request unchanged; the retry returns the first request's response. Do not change the body or treat this as a failure.

422Another request with this idempotency key was made using a different body

defaultCatch-all error response for any unexpected internal errors