Initial Onboarding

Creates a new user and submits initial onboarding data. Supports incremental updates — only provided fields are stored. Returns the user object with current onboarding status.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Email validation

email must be printable ASCII across the whole address — local part and domain. Unicode look-alike characters (e.g. Cyrillic а for Latin a) and invisible control characters are rejected, even when the rest of the address is otherwise valid, because they would let two visually identical addresses create two different users.

A rejected email returns a 400 with correctPattern: [email protected]:

{
  "internalStatus": "BAD_REQUEST",
  "message": "Bad request.",
  "errors": [
    "email has wrong value john@gmаil.com. Value should be [email protected]."
  ]
}
Body Params

Request body

string

An external ID to assign to the User

string
required
^[\x21-\x7E]+$

A valid email address. Only printable ASCII characters are accepted, across the whole address (local part and domain) — an address containing Unicode or control characters is rejected with a 400, even if otherwise RFC-valid, since it'd create a second user visually indistinguishable from an existing one.

string
required

National tax ID (e.g., CUIT in Argentina, CPF in Brazil).

string
enum
Allowed:
string
enum

Possible values: INDIVIDUAL, BUSINESS

Allowed:
string
enum
required

Country the user operates in. Use GLOBAL only when the user's country is not in this list. GLOBAL is not a nationality, so those users are stored without a legal ID nationality. legalIdNationality is the country of the legal ID and can differ from exchange (for example, a foreign company operating in BRAZIL): sent together with exchange, a valid legalIdNationality is kept and an invalid one is ignored.

string
enum

Country that issued the user's legal ID (e.g. CUIT for Argentina, CPF for Brazil). Optional but recommended — send it whenever known. Accepts any country value from the extended country list except GLOBAL, which is an exchange, not a nationality. Omit it if unknown.

personalData
object
banking
object

Bank accounts are not required to operate; however, if the user wants to move funds, one will be necessary. The address used in the /withdraw endpoint will automatically be saved to the user, as long as it is valid.

Headers
string

Your API Key

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json