Skip to main content

Upload Client Document File

POST 
/v1/crossborder/clients/:id/documents

Upload a document file for a crossborder client (max size: 25 MB). The file will be associated with the specified client ID.

Request​

Path Parameters

    id stringrequired

    Client 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
    name stringrequired

    Document name.

    description string

    Document description.

    expiration_date date

    Document expiration date (YYYY-MM-DD).

    document_type stringrequired

    Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]

    Document type.

    file binaryrequired

    Document file. Required.

Responses​

The file upload returned successfully.

Schema
    id stringrequired

    Client document ID.

    client_id stringrequired

    Client ID.

    user_id stringrequired

    User ID.

    file_id stringrequired

    File ID.

    file_state stringrequired

    Possible values: [PENDING, WAITING_UPLOAD, READY, ERROR, ABORTED]

    File state.

    name stringrequired

    Document name.

    description string

    Document description.

    expiration_date string

    Document expiration date.

    type stringrequired

    Possible values: [IDENTITY, PROOF_OF_ADDRESS, BANK_STATEMENT, INVOICE, CONTRACT, OTHER]

    Document type.

    status stringrequired

    Possible values: [PENDING, APPROVED, REJECTED, EXPIRED]

    Document status.

    created_at date-timerequired

    Document created date.

    updated_at date-timerequired

    Document updated date.

Loading...