Upload a beneficiary document
curl --request POST \
--url https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--form 'body={
"documentType": "CUSTODY_ATTESTATION"
}' \
--form file='@example-file'import requests
url = "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "body": "{
\"documentType\": \"CUSTODY_ATTESTATION\"
}" }
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('body', '{
"documentType": "CUSTODY_ATTESTATION"
}');
form.append('file', '{
"fileName": "example-file"
}');
const options = {
method: 'POST',
headers: {'X-Idempotency-Key': '<x-idempotency-key>', Authorization: 'Bearer <token>'}
};
options.body = form;
fetch('https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data",
"X-Idempotency-Key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_bodyUpload a beneficiary document
Uploads a compliance document, such as a custody attestation, for a beneficiary’s payment instruction.
POST
/
v1
/
beneficiaries
/
{beneficiaryId}
/
payment-instructions
/
{paymentInstructionId}
/
documents
Upload a beneficiary document
curl --request POST \
--url https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--header 'X-Idempotency-Key: <x-idempotency-key>' \
--form 'body={
"documentType": "CUSTODY_ATTESTATION"
}' \
--form file='@example-file'import requests
url = "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "body": "{
\"documentType\": \"CUSTODY_ATTESTATION\"
}" }
headers = {
"X-Idempotency-Key": "<x-idempotency-key>",
"Authorization": "Bearer <token>"
}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('body', '{
"documentType": "CUSTODY_ATTESTATION"
}');
form.append('file', '{
"fileName": "example-file"
}');
const options = {
method: 'POST',
headers: {'X-Idempotency-Key': '<x-idempotency-key>', Authorization: 'Bearer <token>'}
};
options.body = form;
fetch('https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data",
"X-Idempotency-Key: <x-idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Idempotency-Key", "<x-idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents")
.header("X-Idempotency-Key", "<x-idempotency-key>")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tracefinance.com/v1/beneficiaries/{beneficiaryId}/payment-instructions/{paymentInstructionId}/documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Idempotency-Key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body\"\r\n\r\n{\r\n \"documentType\": \"CUSTODY_ATTESTATION\"\r\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_bodyAuthorizations
JWT bearer token. Include as Authorization: Bearer <token>. See the Authentication guide for how to obtain one.
Headers
API version. Omit to use the default version.
Example:
"1"
Unique key to ensure idempotent request processing. Required on all POST, PUT, and PATCH requests.
Path Parameters
UUID of the beneficiary.
UUID of the payment instruction.
Body
multipart/form-data
Response
Document uploaded.
Was this page helpful?
⌘I