Skip to main content

V1GetAllOnboardingWithStepsRestResponseItem

    id stringrequired

    Onboarding ID.

    document string

    User document.

    full_name string

    User full name.

    status stringrequired

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

    Onboarding Status.

    nationality string

    User nationality.

    pep boolean

    User PEP.

    pep_since stringnullable

    User PEP initial date.

    occupation_cbo_code numbernullable

    User occupation cbo code.

    occupation_income number

    User occupation income in cents.

    patrimony number

    User patrimony in cents.

    failed_code string

    Onboarding failed code.

    failed_message string

    Onboarding failed message.

    rejected_legal_representative_id stringnullable

    Rejected legal representative ID when rejection is representative-scoped.

    address object
    id numberrequired

    User address ID.

    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.

    steps object[]

    Onboarding steps. Company-level steps have legal_representative_id = null.

  • Array [
  • id stringrequired

    Step ID.

    name stringrequired

    Possible values: [BC_PROTEGE, CAF, DICT, RUFRA]

    Step name.

    status stringrequired

    Possible values: [PENDING, PROCESSING, APPROVED, REJECTED, ERROR, MANUAL_REVIEW]

    Step status.

    order numberrequired

    Step order.

    finished_at date-time

    Step finished at.

    legal_representative_id string

    Legal representative ID linked to the step. Null means company-level step.

  • ]
  • created_at date-timerequired

    Onboarding created at.

    updated_at date-timerequired

    Onboarding updated at.