Skip to main content

Create User Account (v3)

POST 
/v3/users/accounts

Create an user account. User account is a base for all other entities. It must be created as first entity.

Changed in v3 (compliance/KYC required data):

  • email is now required for every payload. Sending only phone_number is no longer accepted.
  • birth_date is now required for NATURAL_PERSON payloads.
  • issue_date is now required for LEGAL_PERSON payloads.

Version 2 keeps accepting the previous, looser payload and is deprecated.

Request​

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    nonce stringrequired

    The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

    x-product-uuid stringrequired

    UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

    x-product-target-user-uuid string

    UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

    x-lang string

    Possible values: [pt-BR, en-US]

    Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Body

required

Create user account payload.

    oneOf
    name stringrequired

    User short name or company trade name.

    full_name stringrequired

    User full name or company name.

    genre string

    Possible values: [male, female, non_binary, other, prefer_not_to_say]

    User gender:

    • female.
    • male.
    • non_binary.
    • other.
    • prefer_not_to_say.

    mother_name string

    User mother name.

    birth_date daterequired

    User birth date. Required for NATURAL_PERSON payloads, not allowed for LEGAL_PERSON ones.

    document stringrequired

    User CPF or company CNPJ, without mask. The CNPJ may be alphanumeric.

    phone_number string

    User or company phone number.

    email stringrequired

    User or company e-mail.

    active booleanrequired

    User should start as active?

    person_type stringrequired

    Possible values: [NATURAL_PERSON]

    Person type:

    • NATURAL_PERSON.
    • LEGAL_PERSON.

Responses​

User account created.

Schema
    id stringrequired

    User account ID.

    state stringrequired

    Possible values: [pending, active, expired, deactivated, deleting]

    User state.

    created_at date-timerequired

    User created date.

Loading...