Skip to main content

V1GetOnboardingByIdRestResponse

    id stringrequired

    Onboarding ID.

    status stringrequired

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

    Onboarding Status.

    address objectrequired
    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 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.