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

    The product ID is a UUID (v4) used to identify the Z.ro product configuration.

    x-product-target-user-uuid string

    The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.

Responses​

The onboarding returned successfully.

Schema
    id stringrequired

    Onboarding ID.

    status stringrequired

    Possible values: [pending, invalid, in_process, approved, rejected, finished, expired]

    Onboarding Status.

    address object[]required

    User address information.

  • Array [
    • 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 neighborhood.

    federative_unit objectrequired

    User address federative unit.

    country objectrequired

    User address country.

    complement object

    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.

    failed_code stringnullable

    Error code returned when onboarding is expired.

    failed_message stringnullable

    Error description returned when onboarding is expired.

    created_at date-timerequired

    Onboarding Created at.

Loading...