Finish onboarding: capture submission and deliver a ToS link to the seller
curl --request POST \
--url https://api.example.com/v1/accounts/{id}/request-tos \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"submit": {
"legalName": "Fazenda Boa Vista Café LTDA",
"cnpj": "12345678000190",
"email": "finance@fazendaboavista.com.br",
"country": "BR"
},
"payout": {
"pixKey": "acme@pix.example.com",
"accountHolderName": "Fazenda Boa Vista Café LTDA"
}
}
'import requests
url = "https://api.example.com/v1/accounts/{id}/request-tos"
payload = {
"submit": {
"legalName": "Fazenda Boa Vista Café LTDA",
"cnpj": "12345678000190",
"email": "finance@fazendaboavista.com.br",
"country": "BR"
},
"payout": {
"pixKey": "acme@pix.example.com",
"accountHolderName": "Fazenda Boa Vista Café LTDA"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
submit: {
legalName: 'Fazenda Boa Vista Café LTDA',
cnpj: '12345678000190',
email: 'finance@fazendaboavista.com.br',
country: 'BR'
},
payout: {
pixKey: 'acme@pix.example.com',
accountHolderName: 'Fazenda Boa Vista Café LTDA'
}
})
};
fetch('https://api.example.com/v1/accounts/{id}/request-tos', 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.example.com/v1/accounts/{id}/request-tos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'submit' => [
'legalName' => 'Fazenda Boa Vista Café LTDA',
'cnpj' => '12345678000190',
'email' => 'finance@fazendaboavista.com.br',
'country' => 'BR'
],
'payout' => [
'pixKey' => 'acme@pix.example.com',
'accountHolderName' => 'Fazenda Boa Vista Café LTDA'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.example.com/v1/accounts/{id}/request-tos"
payload := strings.NewReader("{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.example.com/v1/accounts/{id}/request-tos")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts/{id}/request-tos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}"
response = http.request(request)
puts response.read_body{
"connectedAccountId": "ckacc042",
"acceptUrl": "https://api.caratuva.com/v1/public/tos/start?t=abc123",
"emailSent": true
}{
"statusCode": 400,
"error": "SellerEmailRequired",
"message": "A seller email is required to send the ToS acceptance link (also: TosRequestSellerOnly, TosAlreadyRequested)."
}Accounts
Finish onboarding: capture submission and deliver a ToS link to the seller
Final step of seller onboarding. Captures the seller’s full KYB submission body and PIX payout config, then mints a single-use link to accept the settlement partner’s terms. delivery: 'email' (default) emails the seller (requires the account’s email); delivery: 'link' returns the acceptUrl for you to deliver yourself. The BlindPay submission (then payout registration) fires automatically once the seller accepts. Seller accounts only; the account must still be created.
POST
/
v1
/
accounts
/
{id}
/
request-tos
Finish onboarding: capture submission and deliver a ToS link to the seller
curl --request POST \
--url https://api.example.com/v1/accounts/{id}/request-tos \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"submit": {
"legalName": "Fazenda Boa Vista Café LTDA",
"cnpj": "12345678000190",
"email": "finance@fazendaboavista.com.br",
"country": "BR"
},
"payout": {
"pixKey": "acme@pix.example.com",
"accountHolderName": "Fazenda Boa Vista Café LTDA"
}
}
'import requests
url = "https://api.example.com/v1/accounts/{id}/request-tos"
payload = {
"submit": {
"legalName": "Fazenda Boa Vista Café LTDA",
"cnpj": "12345678000190",
"email": "finance@fazendaboavista.com.br",
"country": "BR"
},
"payout": {
"pixKey": "acme@pix.example.com",
"accountHolderName": "Fazenda Boa Vista Café LTDA"
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
submit: {
legalName: 'Fazenda Boa Vista Café LTDA',
cnpj: '12345678000190',
email: 'finance@fazendaboavista.com.br',
country: 'BR'
},
payout: {
pixKey: 'acme@pix.example.com',
accountHolderName: 'Fazenda Boa Vista Café LTDA'
}
})
};
fetch('https://api.example.com/v1/accounts/{id}/request-tos', 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.example.com/v1/accounts/{id}/request-tos",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'submit' => [
'legalName' => 'Fazenda Boa Vista Café LTDA',
'cnpj' => '12345678000190',
'email' => 'finance@fazendaboavista.com.br',
'country' => 'BR'
],
'payout' => [
'pixKey' => 'acme@pix.example.com',
'accountHolderName' => 'Fazenda Boa Vista Café LTDA'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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.example.com/v1/accounts/{id}/request-tos"
payload := strings.NewReader("{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
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.example.com/v1/accounts/{id}/request-tos")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/accounts/{id}/request-tos")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"submit\": {\n \"legalName\": \"Fazenda Boa Vista Café LTDA\",\n \"cnpj\": \"12345678000190\",\n \"email\": \"finance@fazendaboavista.com.br\",\n \"country\": \"BR\"\n },\n \"payout\": {\n \"pixKey\": \"acme@pix.example.com\",\n \"accountHolderName\": \"Fazenda Boa Vista Café LTDA\"\n }\n}"
response = http.request(request)
puts response.read_body{
"connectedAccountId": "ckacc042",
"acceptUrl": "https://api.caratuva.com/v1/public/tos/start?t=abc123",
"emailSent": true
}{
"statusCode": 400,
"error": "SellerEmailRequired",
"message": "A seller email is required to send the ToS acceptance link (also: TosRequestSellerOnly, TosAlreadyRequested)."
}Authorizations
apiKeybearer
Path Parameters
Body
application/json
⌘I