Get All Counterparty Documents

GET 
/v1/crossborder/counterparties/:id/documents

Retrieve a list of all documents associated with a specific crossborder counterparty. Optional filter parameters can be used to refine your search.

Request

Path Parameters

id stringrequired

Counterparty ID.

Query Parameters

page number

Default value: 1

Page number.

size number

Possible values: <= 100

Default value: 20

Page size. Max size is 100.

sort string

Possible values: [created_at, updated_at, name]

Page sort attribute.

order string

Possible values: [asc, desc]

Default value: asc

Page order.

document_type string

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

Filter by document type.

status string

Possible values: [PENDING_ANALYSIS, APPROVED, REJECTED]

Filter by document status.

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.

x-wallet-uuid string

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

Responses

200

Counterparty documents returned successfully.

application/json

Schema

Schema

page numberrequired

Page number.

page_size numberrequired

Page size.

page_total numberrequired

Page total.

total numberrequired

Total of elements.

data object[]required
Counterparty documents data.
Array [
id stringrequired
Counterparty document ID.
counterparty_id stringrequired
Counterparty ID.
user_id stringrequired
User ID.
file_id string
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.
rejection_reason string
Document rejection reason.
created_at date-timerequired
Document created date.
updated_at date-timerequired
Document updated date.
]

Example (from schema)

{
  "page": 1,
  "page_size": 20,
  "page_total": 20,
  "total": 100,
  "data": [
    {
      "id": "f6e2e084-29b9-4935-a059-5473b13033aa",
      "counterparty_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",
      "rejection_reason": "Document is expired",
      "created_at": "2026-03-26T14:02:59.414Z",
      "updated_at": "2026-03-26T14:02:59.414Z"
    }
  ]
}

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