List Onboardings with Steps

GET 
/v1/users/onboardings/with-steps

Get all onboardings for the authenticated user with their verification steps.

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, updated_at]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

status string

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

Onboarding status.

created_at_start date-time

Filter by created at start.

created_at_end date-time

Filter by created at end.

search string

Search by name, CPF or CNPJ.

person_type string

Possible values: [NATURAL_PERSON, LEGAL_PERSON]

Person type filter.

Header Parameters

nonce stringrequired

The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.

x-product-uuid string

UUID (v4) of the product that the request should use. Send it explicitly when the authenticated user has more than one product or when the integration must select a specific product. If omitted and the endpoint does not require it, the API uses the authenticated user's default product.

x-product-target-user-uuid string

UUID (v4) of the user on whose behalf the request should run within the selected product. If omitted, the request runs as the authenticated user. Requires x-product-uuid.

x-lang string

Possible values: [pt-BR, en-US]

Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.

Responses

200

The onboardings with steps 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 with steps.
Array [
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.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
      "document": "36131399988",
      "full_name": "John Doe",
      "status": "finished",
      "nationality": "Brasileiro",
      "pep": false,
      "pep_since": "2026-01-01",
      "occupation_cbo_code": 212405,
      "occupation_income": 0,
      "patrimony": 1299,
      "failed_code": "ONBOARDING_REJECTED_BY_COMPLIANCE",
      "failed_message": "Rejected by compliance",
      "rejected_legal_representative_id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
      "address": {
        "id": 1234,
        "zip_code": "96075858",
        "street": "Alameda",
        "number": 10,
        "neighborhood": "Alphaville",
        "city": "São Paulo",
        "federative_unit": "SP",
        "country": "Brasil",
        "complement": "flat 1201"
      },
      "steps": [
        {
          "id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
          "name": "BC_PROTEGE",
          "status": "APPROVED",
          "order": 1,
          "finished_at": "2026-05-29T21:41:49.588Z",
          "legal_representative_id": "8fc58500-b12e-49d7-892c-dfd704b94c2d"
        }
      ],
      "created_at": "2026-05-29T21:41:49.588Z",
      "updated_at": "2026-05-29T21:41:49.588Z"
    }
  ]
}

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