Skip to main content

Update Counterparty Document

PATCH 
/v1/crossborder/counterparties/:id/documents/:doc_id

Update metadata (name, description, type) of a counterparty document.

Request​

Path Parameters

    id stringrequired

    Counterparty ID.

    doc_id stringrequired

    Counterparty document ID.

Header Parameters

    x-include-replay-protection-schema string

    The replay-protection-schema allows the user to choose between 3 options:

    • If there's no value: The default protection checks that the values in this request are equal: { method, params, path, query, body, userId }. This means that if a request repeats the same values, it will be blocked.
    • 'nonce': The nonce and { method, params, path, query, body, userId } value are checked. When the protection schema is this, requests will be OK if this nonce value is different in each request.
    • 'x-transaction-uuid': The transactionId and { method, params, path, query, body, userId } value are checked. Requests will be OK if this x-transaction-uuid value is different in each request.
    • 'x-transaction-uuid&nonce' or 'nonce&x-transaction-uuid': The nonce, transactionId value and { method, params, path, query, body, userId } are checked, i.e. if requests are repeated the same value in both fields, they will be blocked. But if any field has a different value, the request is OK.

    x-wallet-uuid string

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

    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.

Body

required
    name string

    Document name.

    description string

    Document description.

    document_type string

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

    Document type.

Responses​

The counterparty document was updated successfully.

Schema
    id stringrequired

    Counterparty document ID.

    counterparty_id stringrequired

    Counterparty ID.

    user_id stringrequired

    User ID.

    file_id stringrequired

    File ID.

    name string

    Document name.

    description string

    Document description.

    type string

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

    Document type.

    status string

    Possible values: [PENDING_ANALYSIS, APPROVED, REJECTED]

    Document status.

    rejection_reason string

    Document rejection reason.

    created_at date-time

    Document created date.

    updated_at date-time

    Document updated date.

Loading...