Set Identity

post

https://example.com/v1/users/{id}/identity

Store a user's identity data.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Body Params

Core identity data stored in the users.identity_data column.

firstName

string

required

The first name

lastName

string

required

The last name

secondLastName

string | null

The second last name

middleName

string | null

The middle name

taxId

string | null

The tax identification number

nationalIdNumber

string | null

The national identification number

nationalIdExpirationDate

date | null

The national identification expiration date

dateOfBirth

date

required

The date of birth

string | null

The email address

phone

string | null

The phone number

activity

string | null

The activity or occupation

sex

string | null

enum

The sex

Allowed:

citizenship

string | null

Citizenship country code

occupationCode

string | null

Occupation code

employmentStatus

string | null

enum

The employment status

Allowed:

sourceOfFunds

string | null

enum

Primary source of funds

accountPurpose

string | null

enum

Primary purpose of the account

accountPurposeOther

string | null

Other account purpose (required if accountPurpose is 'Other')

monthlyAmounts

string | null

enum

The expected monthly amounts on the account in USD

Allowed:

actingAsIntermediary

boolean | null

Whether the person is acting as an intermediary for another party

address

object

required

A postal address.

Responses

400

A path parameter could not be parsed into its expected type.

401

Not authenticated

404

unknown user

409

user is archived

422

The request body is valid JSON but does not match the expected schema.

500

Possible reasons:

database error
failed to serialize identity data

Language

Credentials

Loading…

Response

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

application/json

200OK