Skip to main content

Get Onboarding by ID

GET 
/v1/users/onboardings/:id

Get onboarding by id related to the logged or target user.

Request​

Path Parameters

    id stringrequired

    Onboarding ID.

Header Parameters

    nonce stringrequired

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

    x-lang string

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

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

    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.

Responses​

The onboarding returned successfully.

Schema
    id stringrequired

    Onboarding ID.

    status stringrequired

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

    Onboarding Status.

    address object
    id objectrequired

    User address ID.

    zip_code objectrequired

    User address zip code.

    street objectrequired

    User address street.

    number objectrequired

    User address number.

    neighborhood object

    User address neighborhood.

    city objectrequired

    User address city.

    federative_unit objectrequired

    User address federative unit.

    country objectrequired

    User address country.

    complement object

    User address complement.

    nationality string

    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.

    failed_code string

    Possible values: [ONBOARDING_REJECTED, ONBOARDING_REJECTED_BY_COMPLIANCE, ONBOARDING_FAILED]

    Failure code returned for onboarding.

    failed_message object

    Failure message returned for onboarding.

    created_at date-timerequired

    Onboarding Created at.

Loading...