Skip to main content

Create Onboarding (v2)

POST 
/v2/users/onboardings

Create an onboarding for user account. It must be created after user account entity.

This version requires the accepted_terms field set to true to register that the user accepted the terms of service.

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 string

    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
    address objectrequired
    zip_code stringrequired

    User address zip code.

    street stringrequired

    User address street.

    number numberrequired

    User address number.

    neighborhood string

    User address neighborhood.

    city stringrequired

    User address city.

    federative_unit stringrequired

    User address federative unit.

    country stringrequired

    User address country.

    complement string

    User address complement.

    nationality stringrequired

    User nationality.

    pep booleanrequired

    User PEP (Politically Exposed Person).

    pep_since YYYY-MM-DD

    User PEP (Politically Exposed Person) initial date.

    occupation_cbo_code number

    User occupation cbo (Brazilian Classification of Occupations (CBO) code.

    occupation_income number

    User occupation income in R$ cents.

    patrimony number

    User patrimony value in R$ cents.

    accepted_terms booleanrequired

    Indicates the user has read and accepted the terms of service. Must be true to proceed.

Responses​

Onboarding created.

Schema
    id stringrequired

    Onboarding ID.

    status stringrequired

    Possible values: [pending, finished, failed, rejected, expired]

    Onboarding Status.

    created_at date-timerequired

    Onboarding Created at.

Loading...