Skip to main content
POST
Upload a beneficiary document

Authorizations

Authorization
string
header
required

JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.

Headers

X-Trace-Version
string

API version. Omit to use the default version.

Example:

"1"

X-Idempotency-Key
string<uuid>
required

Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.

Path Parameters

beneficiaryId
string<uuid>
required

UUID of the beneficiary.

paymentInstructionId
string<uuid>
required

UUID of the payment instruction.

Body

multipart/form-data
body
object
required

Metadata for a compliance document submitted for a beneficiary's payment instruction. Sent as the JSON body part of the multipart request; the document file itself is the file part.

file
file
required

Document file content (PDF, JPEG, PNG, DOC or DOCX).

Response

Document uploaded.