Upload Client Account Document File

POST 
/v1/crossborder/clients/:client_id/accounts/:account_id/documents

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

Request

Path Parameters

client_id stringrequired

Client ID.

account_id stringrequired

Account 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

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.

x-wallet-uuid string

Sender Wallet UUID (if empty, your default Wallet UUID will be settled)

multipart/form-data

Body

required

name stringrequired

Document name.

description string

Document description.

document_type stringrequired

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

Document type.

file binaryrequired

Document file. Required.

Responses

201

The file upload returned successfully.

application/json

Schema

Schema

id stringrequired

Client account document ID.

client_id stringrequired

Client ID.

account_id stringrequired

Account ID.

user_id stringrequired

User ID.

file_id stringrequired

File ID.

name stringrequired

Document name.

description string

Document description.

type stringrequired

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

Document type.

status stringrequired

Possible values: [PENDING_ANALYSIS, APPROVED, REJECTED]

Document status.

created_at date-timerequired

Document created date.

updated_at date-timerequired

Document updated date.

Example (from schema)

{
  "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "client_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "account_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "user_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "file_id": "f6e2e084-29b9-4935-a059-5473b13033aa",
  "name": "Identity Document",
  "description": "Front side of identity document",
  "type": "IDENTITY",
  "status": "PENDING_ANALYSIS",
  "created_at": "2026-03-26T14:02:59.409Z",
  "updated_at": "2026-03-26T14:02:59.409Z"
}

401

User authentication failed.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 401,
  "error": "USER",
  "message": "Access is denied."
}

403

User access denied.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 403,
  "error": "USER",
  "message": "Access denied to requested resource. User may not have sufficient permission."
}

422

If any required params are missing or have invalid format or type.

application/json

Schema

Schema

any

Example (from schema)

{
  "statusCode": 422,
  "error": "USER",
  "message": "Invalid quote currency amount. The minimum allowed is 100, and you requested 61.",
  "code": "INVALID_QUOTE_CURRENCY_MIN_AMOUNT"
}

Loading...