Skip to main content

Upload Legal Person Onboarding Document

POST 
/v1/users/onboardings/legal-person/:id/documents

Uploads one legal person document per request for legal person onboarding (max size: 10 MB).

This endpoint only stores the selected legal person document; finalize enforces the full onboarding rules.

Accepted document types for this endpoint (API values):

  • social_contract
  • balance_sheet
  • revenue_statement
  • kyc_aml_policy

Required for finalize:

  • social_contract
  • At least one of balance_sheet or revenue_statement

kyc_aml_policy is accepted here, but it is not required for finalize.

Related endpoint: POST /users/onboardings/legal-person/{id}/finalize.

Request​

Path Parameters

    id stringrequired

    Legal person onboarding ID.

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.

Body

required
    type stringrequired

    Possible values: [social_contract, balance_sheet, revenue_statement, kyc_aml_policy]

    Document type (API values).

    file binaryrequired

    Allowed file formats: image/jpg, image/jpeg, application/pdf.

Responses​

The onboarding document uploaded successfully.

Schema
    id stringrequired

    Legal person onboarding ID.

    status stringrequired

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

    Onboarding status.

    created_at date-timerequired

    Onboarding creation date.

    updated_at date-timerequired

    Onboarding update date.

    document_id stringrequired

    Legal person document ID created by this upload.

    file_id stringrequired

    File ID associated with the uploaded onboarding document.

    document_type stringrequired

    Possible values: [social_contract, balance_sheet, revenue_statement, kyc_aml_policy]

    Document type.

    document_created_at date-timerequired

    Onboarding document creation date.

    document_updated_at date-timerequired

    Onboarding document update date.

Loading...