List Legal Person Onboardings

GET 
/v1/users/onboardings/legal-person

Get all legal person onboardings for the authenticated 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

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.

Responses

200

The legal person 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
Legal person onboarding data.
Array [
id stringrequired
Legal person onboarding ID.
legal_person_name stringrequired
Legal person name.
cnpj stringrequired
Legal person CNPJ.
status stringrequired
Possible values: [pending, invalid, in_process, approved, rejected, finished, expired, failed, in_process_delayed]
Onboarding Status.
address object
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 city.
federative_unit objectrequired
User address federative unit.
country objectrequired
User address country.
complement object
User address complement.
company_revenue number
Legal person annual revenue in R$ cents.
failed_code string
Possible values: [ONBOARDING_REJECTED, ONBOARDING_REJECTED_BY_COMPLIANCE, ONBOARDING_FAILED]
Failure code returned for legal person onboarding.
failed_message object
Failure message returned for legal person onboarding.
created_at date-timerequired
Legal person onboarding created at.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
      "legal_person_name": "ACME LTDA",
      "cnpj": "12345678000190",
      "status": "finished",
      "address": {
        "id": 1234,
        "zip_code": "96075858",
        "street": "Alameda",
        "number": 10,
        "neighborhood": "Alphaville",
        "city": "São Paulo",
        "federative_unit": "SP",
        "country": "Brasil",
        "complement": "flat 1201"
      },
      "company_revenue": 10000000,
      "failed_code": "ONBOARDING_FAILED",
      "failed_message": "Onboarding failed in provider.",
      "created_at": "2026-03-26T14:02:59.207Z"
    }
  ]
}

401

User authentication failed.

403

If the authenticated user does not have permission.

422

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

Loading...