Skip to main content

Upload Legal Representative Document (v2)

POST 
/v2/users/legal-representatives/:id/documents

Uploads one legal representative document per request (max size: 25 MB).

Integration model: use document_type + optional document_side as metadata and send a single binary file.

Identity documents:

  • document_type = identity_document
  • identity_document_type is required (national_id, driver_license, passport)
  • if identity_document_type is national_id or driver_license, document_side is required (front or back)
  • if identity_document_type is passport, document_side must not be sent (internally mapped to FRONT)

Other document types: selfie, qualification_declaration, income_declaration, address_proof (without document_side/identity_document_type).

Request​

Path Parameters

    id stringrequired

    Legal representative 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

    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
    oneOf
    document_type stringrequired

    Possible values: [identity_document]

    identity_document_type stringrequired

    Possible values: [passport]

    file binaryrequired

    Document file. Formats: application/pdf, image/jpeg, image/jpg.

Responses​

The file upload returned successfully.

Schema
    id stringrequired

    Legal representative document ID.

    file_id objectrequired

    Uploaded file ID.

    file_name objectrequired

    Uploaded file name.

    created_at objectrequired

    Upload creation date.

    identity_document_type string

    Possible values: [national_id, driver_license, passport]

    Identity document type (national_id, driver_license, passport). Present for identity documents.

    type stringrequired

    Possible values: [selfie, identity_document, identity_document_front, identity_document_back, qualification_declaration, income_declaration, address_proof]

    Stored legal representative document type.

Loading...