Finalize Legal Person Onboarding
POST/v1/users/onboardings/legal-person/:id/finalize
Triggers validation and finalization of legal person onboarding.
Validation Checklist:
- Legal Person Onboarding exists and is in
PENDINGstatus - Shareholders created (equity structure) via
POST /users/shareholders - Company Documents Uploaded (API values):
social_contract+ (balance_sheetORrevenue_statement) - At least one Legal Representative is registered
- All Legal Representatives are linked to a shareholder (via
shareholder_id) - Legal Representative Documents Uploaded (for ALL reps):
selfie,identity_document,qualification_declaration
Important Notes:
- All legal representatives (natural persons) must be linked to a shareholder (natural person or legal person) from the equity structure
- If a shareholder is a legal person, it must have at least one linked legal representative (natural person)
- The CEP (zip code) of the company will be sent to CAF for validation
Outcome:
- Success: Status changes to
IN_PROCESS. The compliance team will review the application. - Failure: Returns
422 Unprocessable Entitywith details about missing documents or requirements.
Request
Path Parameters
Onboarding ID to finalize.
Header Parameters
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
Possible values: [pt-BR, en-US]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
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
- 400
- 401
- 403
- 422
Legal person onboarding finalized. Status is IN_PROCESS after successful validation.
- application/json
- Schema
- Example (from schema)
Schema
Onboarding ID.
Possible values: [pending, invalid, in_process, approved, rejected, finished, expired, failed, in_process_delayed]
Onboarding Status. Status will be IN_PROCESS after successful finalization.
{
"id": "8fc58500-b12e-49d7-892c-dfd704b94c2d",
"status": "in_process"
}
If any required params are missing or has invalid format or type.
User authentication failed.
If the authenticated user does not have permission.
If validation fails (missing documents, missing legal representatives, etc.) or onboarding is in invalid status.