Skip to main content

Upload Legal Person Onboarding Document

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

Uploads one required company document for legal person onboarding (max size: 10 MB).

Validation dependencies:

  • At least one legal representative must be created
  • Documents must be uploaded for all legal representatives

Required documents (API values):

  • social_contract (Social Contract) - Always required
  • balance_sheet (Balance Sheet) - Required OR revenue_statement
  • revenue_statement (Revenue Statement) - Required OR balance_sheet

Note: Upload social_contract and at least one of (balance_sheet, revenue_statement).

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

Request​

Path Parameters

    id stringrequired

    Onboarding ID.

Header Parameters

    x-transaction-uuid stringrequired

    The transaction ID is a UUID (v4) used to uniquely identify the object that will be created. All objects must have an identifier.

    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.

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

    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

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