List Onboarding

GET 
/v1/users/onboardings

Get all onboardings related to the logged or target user.

Request

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [created_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

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

200

The onboardings returned successfully.

application/json

Schema

Schema

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, 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.
created_at date-timerequired
Onboarding Created at.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
      "status": "finished",
      "address": [
        {
          "zip_code": "96075858",
          "street": "Alameda",
          "number": 10,
          "neighborhood": "Alphaville",
          "city": "São Paulo",
          "federative_unit": "SP",
          "country": "Brasil",
          "complement": "flat 1201"
        }
      ],
      "nationality": "Brasileiro",
      "pep": true,
      "pep_since": "2015-03-11T19:15:54.409Z",
      "occupation_cbo_code": 0,
      "occupation_income": 0,
      "patrimony": 1299,
      "created_at": "2025-03-11T19:15:54.409Z"
    }
  ]
}

400

If any required params are missing or has invalid format or type.

401

User authentication failed.

422

If any required params are missing or has invalid format or type.

Loading...