Onboard entity
curl --request POST \
--url https://api.sandbox.trio.com.br/v2/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Trio-Version: <trio-version>' \
--data '
{
"business_infos": {
"annual_revenue": {
"amount": 500000,
"currency": "BRL"
},
"average_ticket": {
"amount": 10000000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000Z",
"ip_address": "8.8.8.8",
"tax_number": "04969361908"
},
"external_id": "12345ET",
"name": "Entity Test",
"representatives": [
{
"email": "john@gcorp.com",
"is_pep": false,
"is_us_person": false,
"name": "John",
"phone": "+5541999990000",
"tax_number": "04969361908"
}
],
"tax_number": "61775921000110"
}
'import requests
url = "https://api.sandbox.trio.com.br/v2/onboarding"
payload = {
"business_infos": {
"annual_revenue": {
"amount": 500000,
"currency": "BRL"
},
"average_ticket": {
"amount": 10000000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000Z",
"ip_address": "8.8.8.8",
"tax_number": "04969361908"
},
"external_id": "12345ET",
"name": "Entity Test",
"representatives": [
{
"email": "john@gcorp.com",
"is_pep": False,
"is_us_person": False,
"name": "John",
"phone": "+5541999990000",
"tax_number": "04969361908"
}
],
"tax_number": "61775921000110"
}
headers = {
"Trio-Version": "<trio-version>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Trio-Version': '<trio-version>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
business_infos: {
annual_revenue: {amount: 500000, currency: 'BRL'},
average_ticket: {amount: 10000000, currency: 'BRL'}
},
consent: {
consent_at: '2026-08-25T07:00:00.000Z',
ip_address: '8.8.8.8',
tax_number: '04969361908'
},
external_id: '12345ET',
name: 'Entity Test',
representatives: [
{
email: 'john@gcorp.com',
is_pep: false,
is_us_person: false,
name: 'John',
phone: '+5541999990000',
tax_number: '04969361908'
}
],
tax_number: '61775921000110'
})
};
fetch('https://api.sandbox.trio.com.br/v2/onboarding', 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.trio.com.br/v2/onboarding",
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([
'business_infos' => [
'annual_revenue' => [
'amount' => 500000,
'currency' => 'BRL'
],
'average_ticket' => [
'amount' => 10000000,
'currency' => 'BRL'
]
],
'consent' => [
'consent_at' => '2026-08-25T07:00:00.000Z',
'ip_address' => '8.8.8.8',
'tax_number' => '04969361908'
],
'external_id' => '12345ET',
'name' => 'Entity Test',
'representatives' => [
[
'email' => 'john@gcorp.com',
'is_pep' => false,
'is_us_person' => false,
'name' => 'John',
'phone' => '+5541999990000',
'tax_number' => '04969361908'
]
],
'tax_number' => '61775921000110'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Trio-Version: <trio-version>"
],
]);
$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.trio.com.br/v2/onboarding"
payload := strings.NewReader("{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Trio-Version", "<trio-version>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.sandbox.trio.com.br/v2/onboarding")
.header("Trio-Version", "<trio-version>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/v2/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_infos": {
"annual_revenue": {
"amount": 5000000,
"currency": "BRL"
},
"average_ticket": {
"amount": 500000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000000Z",
"ip_address": "8.8.8.8",
"tax_number": "52998224725"
},
"entity_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f",
"external_id": "404ANVIL",
"inserted_at": "2026-09-29T19:23:42.485921Z",
"name": "ACME INC",
"org_id": "92b0f620-7105-4c10-84a1-f5a034a14efa",
"representatives": [
{
"email": "w.coyote@acme.com",
"id": "8c61c7fd-3509-4306-9fec-9090e82fe121",
"name": "Willy Coyote",
"phone": "+5541999990000",
"required_documents": [
"identification"
],
"status": "in_validation",
"tax_number": "52998224725"
}
],
"required_documents": [
"company_contract"
],
"status": "in_validation",
"tax_number": "61775921000110",
"updated_at": "2026-09-29T19:23:42.485921Z"
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}Onboarding
Onboard entity
Onboards an entity
POST
/
v2
/
onboarding
Onboard entity
curl --request POST \
--url https://api.sandbox.trio.com.br/v2/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'Trio-Version: <trio-version>' \
--data '
{
"business_infos": {
"annual_revenue": {
"amount": 500000,
"currency": "BRL"
},
"average_ticket": {
"amount": 10000000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000Z",
"ip_address": "8.8.8.8",
"tax_number": "04969361908"
},
"external_id": "12345ET",
"name": "Entity Test",
"representatives": [
{
"email": "john@gcorp.com",
"is_pep": false,
"is_us_person": false,
"name": "John",
"phone": "+5541999990000",
"tax_number": "04969361908"
}
],
"tax_number": "61775921000110"
}
'import requests
url = "https://api.sandbox.trio.com.br/v2/onboarding"
payload = {
"business_infos": {
"annual_revenue": {
"amount": 500000,
"currency": "BRL"
},
"average_ticket": {
"amount": 10000000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000Z",
"ip_address": "8.8.8.8",
"tax_number": "04969361908"
},
"external_id": "12345ET",
"name": "Entity Test",
"representatives": [
{
"email": "john@gcorp.com",
"is_pep": False,
"is_us_person": False,
"name": "John",
"phone": "+5541999990000",
"tax_number": "04969361908"
}
],
"tax_number": "61775921000110"
}
headers = {
"Trio-Version": "<trio-version>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Trio-Version': '<trio-version>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
business_infos: {
annual_revenue: {amount: 500000, currency: 'BRL'},
average_ticket: {amount: 10000000, currency: 'BRL'}
},
consent: {
consent_at: '2026-08-25T07:00:00.000Z',
ip_address: '8.8.8.8',
tax_number: '04969361908'
},
external_id: '12345ET',
name: 'Entity Test',
representatives: [
{
email: 'john@gcorp.com',
is_pep: false,
is_us_person: false,
name: 'John',
phone: '+5541999990000',
tax_number: '04969361908'
}
],
tax_number: '61775921000110'
})
};
fetch('https://api.sandbox.trio.com.br/v2/onboarding', 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.trio.com.br/v2/onboarding",
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([
'business_infos' => [
'annual_revenue' => [
'amount' => 500000,
'currency' => 'BRL'
],
'average_ticket' => [
'amount' => 10000000,
'currency' => 'BRL'
]
],
'consent' => [
'consent_at' => '2026-08-25T07:00:00.000Z',
'ip_address' => '8.8.8.8',
'tax_number' => '04969361908'
],
'external_id' => '12345ET',
'name' => 'Entity Test',
'representatives' => [
[
'email' => 'john@gcorp.com',
'is_pep' => false,
'is_us_person' => false,
'name' => 'John',
'phone' => '+5541999990000',
'tax_number' => '04969361908'
]
],
'tax_number' => '61775921000110'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"Trio-Version: <trio-version>"
],
]);
$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.trio.com.br/v2/onboarding"
payload := strings.NewReader("{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Trio-Version", "<trio-version>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.sandbox.trio.com.br/v2/onboarding")
.header("Trio-Version", "<trio-version>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/v2/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Trio-Version"] = '<trio-version>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"business_infos\": {\n \"annual_revenue\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n },\n \"average_ticket\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n }\n },\n \"consent\": {\n \"consent_at\": \"2026-08-25T07:00:00.000Z\",\n \"ip_address\": \"8.8.8.8\",\n \"tax_number\": \"04969361908\"\n },\n \"external_id\": \"12345ET\",\n \"name\": \"Entity Test\",\n \"representatives\": [\n {\n \"email\": \"john@gcorp.com\",\n \"is_pep\": false,\n \"is_us_person\": false,\n \"name\": \"John\",\n \"phone\": \"+5541999990000\",\n \"tax_number\": \"04969361908\"\n }\n ],\n \"tax_number\": \"61775921000110\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"business_infos": {
"annual_revenue": {
"amount": 5000000,
"currency": "BRL"
},
"average_ticket": {
"amount": 500000,
"currency": "BRL"
}
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000000Z",
"ip_address": "8.8.8.8",
"tax_number": "52998224725"
},
"entity_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f",
"external_id": "404ANVIL",
"inserted_at": "2026-09-29T19:23:42.485921Z",
"name": "ACME INC",
"org_id": "92b0f620-7105-4c10-84a1-f5a034a14efa",
"representatives": [
{
"email": "w.coyote@acme.com",
"id": "8c61c7fd-3509-4306-9fec-9090e82fe121",
"name": "Willy Coyote",
"phone": "+5541999990000",
"required_documents": [
"identification"
],
"status": "in_validation",
"tax_number": "52998224725"
}
],
"required_documents": [
"company_contract"
],
"status": "in_validation",
"tax_number": "61775921000110",
"updated_at": "2026-09-29T19:23:42.485921Z"
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}{
"error": {
"error_code": "INVALID_PARAMETER",
"error_message": "Invalid parameters: /amount: Invalid integer. Got: string",
"errors": [
{
"field": "/amount",
"message": "Invalid integer. Got: string"
}
]
}
}IMPORTANT: This feature is only available after a distribution channel has been created for your organization.To request the creation of a distribution channel, contact Trio Support or your Trio Account Manager.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
Version of the v2 contract the client is written against. Each breaking change publishes a new version.
Available options:
2026-10-19.v2 ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.
Body
application/json
The onboard entity attributes
Onboard parameters for creating entity
Onboard business information parameters for creating entity
Show child attributes
Show child attributes
Example:
{
"annual_revenue": { "amount": 500000, "currency": "BRL" },
"average_ticket": { "amount": 10000000, "currency": "BRL" }
}
Onboard consent parameters for creating entity
Show child attributes
Show child attributes
Example:
{
"consent_at": "2026-08-25T07:00:00.000Z",
"ip_address": "8.8.8.8",
"tax_number": "04969361908"
}
Name of the Entity
Show child attributes
Show child attributes
Tax number of the Entity
External ID of the Entity
Response
Compliance
Entity onboard response
The entity as Trio registered it to onboard, with the fields of the onboarding request under the same names
Show child attributes
Show child attributes
Example:
{
"business_infos": {
"annual_revenue": { "amount": 5000000, "currency": "BRL" },
"average_ticket": { "amount": 500000, "currency": "BRL" }
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000000Z",
"ip_address": "8.8.8.8",
"tax_number": "52998224725"
},
"entity_id": "01a0ee9f-7418-625f-e4b2-624b4ad4959f",
"external_id": "404ANVIL",
"inserted_at": "2026-09-29T19:23:42.485921Z",
"name": "ACME INC",
"org_id": "92b0f620-7105-4c10-84a1-f5a034a14efa",
"representatives": [
{
"email": "w.coyote@acme.com",
"id": "8c61c7fd-3509-4306-9fec-9090e82fe121",
"name": "Willy Coyote",
"phone": "+5541999990000",
"required_documents": ["identification"],
"status": "in_validation",
"tax_number": "52998224725"
}
],
"required_documents": ["company_contract"],
"status": "in_validation",
"tax_number": "61775921000110",
"updated_at": "2026-09-29T19:23:42.485921Z"
}