V1GetAllOnboardingRestResponse

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Onboarding data.
Array [
id stringrequired
Onboarding ID.
status stringrequired
Possible values: [pending, finished, failed, rejected, expired]
Onboarding Status.
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.
nationality string
User nationality.
pep booleanrequired
User PEP (Politically Exposed Person).
pep_since YYYY-MM-DDnullable
User PEP (Politically Exposed Person) initial date.
occupation_cbo_code numbernullable
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 string
Failure message returned for onboarding.
rejected_legal_representative_id stringnullable
Rejected legal representative ID when rejection is representative-scoped.
created_at date-timerequired
Onboarding Created at.
updated_at date-timerequired
Onboarding Updated at.
]