Create onboarding
curl --request POST \
--url https://api.sandbox.trio.com.br/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"tax_number": "37.335.118/0001-80",
"name": "Entity Test",
"external_id": "12345ET",
"business_infos": {
"average_ticket_amount": {
"amount": 10000000,
"currency": "BRL"
},
"annual_revenue_amount": {
"amount": 500000,
"currency": "BRL"
}
},
"representatives": [
{
"tax_number": "111.444.777-35",
"email": "john@gcorp.com",
"phone": "+5541999990000",
"name": "John",
"is_pep": false,
"is_us_person": false
}
],
"consent": {
"tax_number": "111.444.777-35",
"ip_address": "8.8.8.8",
"consent_at": "2026-08-25T07:00:00.000Z"
}
}
'import requests
url = "https://api.sandbox.trio.com.br/onboarding"
payload = {
"tax_number": "37.335.118/0001-80",
"name": "Entity Test",
"external_id": "12345ET",
"business_infos": {
"average_ticket_amount": {
"amount": 10000000,
"currency": "BRL"
},
"annual_revenue_amount": {
"amount": 500000,
"currency": "BRL"
}
},
"representatives": [
{
"tax_number": "111.444.777-35",
"email": "john@gcorp.com",
"phone": "+5541999990000",
"name": "John",
"is_pep": False,
"is_us_person": False
}
],
"consent": {
"tax_number": "111.444.777-35",
"ip_address": "8.8.8.8",
"consent_at": "2026-08-25T07:00:00.000Z"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tax_number: '37.335.118/0001-80',
name: 'Entity Test',
external_id: '12345ET',
business_infos: {
average_ticket_amount: {amount: 10000000, currency: 'BRL'},
annual_revenue_amount: {amount: 500000, currency: 'BRL'}
},
representatives: [
{
tax_number: '111.444.777-35',
email: 'john@gcorp.com',
phone: '+5541999990000',
name: 'John',
is_pep: false,
is_us_person: false
}
],
consent: {
tax_number: '111.444.777-35',
ip_address: '8.8.8.8',
consent_at: '2026-08-25T07:00:00.000Z'
}
})
};
fetch('https://api.sandbox.trio.com.br/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/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([
'tax_number' => '37.335.118/0001-80',
'name' => 'Entity Test',
'external_id' => '12345ET',
'business_infos' => [
'average_ticket_amount' => [
'amount' => 10000000,
'currency' => 'BRL'
],
'annual_revenue_amount' => [
'amount' => 500000,
'currency' => 'BRL'
]
],
'representatives' => [
[
'tax_number' => '111.444.777-35',
'email' => 'john@gcorp.com',
'phone' => '+5541999990000',
'name' => 'John',
'is_pep' => false,
'is_us_person' => false
]
],
'consent' => [
'tax_number' => '111.444.777-35',
'ip_address' => '8.8.8.8',
'consent_at' => '2026-08-25T07:00:00.000Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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/onboarding"
payload := strings.NewReader("{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/onboarding")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"entity_id": "01a06ee8-4973-caa8-eda0-dc64b5aa648e",
"company_id": "01a06ee8-44d4-d879-95ca-28d9c0eb78fc",
"org_id": "1162d769-b68b-47bd-a844-d6f9d2cb2636",
"counterparty_id": "382f53d3-aeae-059b-bd3e-ca79ff706b8f",
"external_id": "123ENTITY",
"tax_number": "61775921000110",
"status": "in_validation",
"address": {
"address": null,
"address_additional_details": null,
"address_number": null,
"birth_state": null,
"city": null,
"constitution_date": null,
"district": null,
"zip_code": null
},
"business_infos": {
"id": "01a06ee8-4975-608f-570d-05ff13d49dd0",
"annual_revenue_amount": {
"amount": 5000000,
"currency": "BRL"
},
"average_ticket_amount": {
"amount": 500000,
"currency": "BRL"
},
"company_activity": null,
"company_secondary_activity": [],
"legal_name": null,
"legal_nature": null,
"name": "Entity Name"
},
"contact": {
"email": null,
"phone_number": null
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000000Z",
"entity_representative_id": "bf35e7b3-2858-4ede-999e-e17e6e434071",
"id": "9d4ddbc2-7eb0-4ca4-ba75-36a10599306f",
"inserted_at": "2026-09-05T00:11:52.055275Z",
"ip_address": "8.8.8.8",
"updated_at": "2026-09-05T00:11:52.055275Z"
},
"representatives": [
{
"counterparty_id": "00012832-71f4-ec93-62e8-9cb657b86eef",
"email": "representative.name@entity.com",
"id": "bf35e7b3-2858-4ede-999e-e17e6e434071",
"inserted_at": "2026-09-05T00:11:52.054493Z",
"liveness_link": null,
"name_linked": "Representative Name",
"status": "in_validation",
"tax_number_linked": "12345678912",
"required_documents": [
"identification"
],
"updated_at": "2026-09-05T00:11:52.054493Z"
}
],
"required_documents": [
"company_contract",
"financial_statement"
],
"inserted_at": "2026-09-05T00:11:52.015299Z",
"updated_at": "2026-09-05T00:11:52.015299Z"
}
}{
"error": {
"error_code": "UNAUTHORIZED",
"error_message": "Invalid credentials"
}
}{
"error": {
"error_code": "Forbidden",
"message": "A organização não está habilitada para onboarding via API."
}
}{
"error": {
"error_code": "UNAUTHORIZED",
"error_message": "Invalid credentials"
}
}Onboarding
Create onboarding
Creates an org and an entity, and sends them to compliance approval.
POST
/
onboarding
Create onboarding
curl --request POST \
--url https://api.sandbox.trio.com.br/onboarding \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"tax_number": "37.335.118/0001-80",
"name": "Entity Test",
"external_id": "12345ET",
"business_infos": {
"average_ticket_amount": {
"amount": 10000000,
"currency": "BRL"
},
"annual_revenue_amount": {
"amount": 500000,
"currency": "BRL"
}
},
"representatives": [
{
"tax_number": "111.444.777-35",
"email": "john@gcorp.com",
"phone": "+5541999990000",
"name": "John",
"is_pep": false,
"is_us_person": false
}
],
"consent": {
"tax_number": "111.444.777-35",
"ip_address": "8.8.8.8",
"consent_at": "2026-08-25T07:00:00.000Z"
}
}
'import requests
url = "https://api.sandbox.trio.com.br/onboarding"
payload = {
"tax_number": "37.335.118/0001-80",
"name": "Entity Test",
"external_id": "12345ET",
"business_infos": {
"average_ticket_amount": {
"amount": 10000000,
"currency": "BRL"
},
"annual_revenue_amount": {
"amount": 500000,
"currency": "BRL"
}
},
"representatives": [
{
"tax_number": "111.444.777-35",
"email": "john@gcorp.com",
"phone": "+5541999990000",
"name": "John",
"is_pep": False,
"is_us_person": False
}
],
"consent": {
"tax_number": "111.444.777-35",
"ip_address": "8.8.8.8",
"consent_at": "2026-08-25T07:00:00.000Z"
}
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
tax_number: '37.335.118/0001-80',
name: 'Entity Test',
external_id: '12345ET',
business_infos: {
average_ticket_amount: {amount: 10000000, currency: 'BRL'},
annual_revenue_amount: {amount: 500000, currency: 'BRL'}
},
representatives: [
{
tax_number: '111.444.777-35',
email: 'john@gcorp.com',
phone: '+5541999990000',
name: 'John',
is_pep: false,
is_us_person: false
}
],
consent: {
tax_number: '111.444.777-35',
ip_address: '8.8.8.8',
consent_at: '2026-08-25T07:00:00.000Z'
}
})
};
fetch('https://api.sandbox.trio.com.br/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/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([
'tax_number' => '37.335.118/0001-80',
'name' => 'Entity Test',
'external_id' => '12345ET',
'business_infos' => [
'average_ticket_amount' => [
'amount' => 10000000,
'currency' => 'BRL'
],
'annual_revenue_amount' => [
'amount' => 500000,
'currency' => 'BRL'
]
],
'representatives' => [
[
'tax_number' => '111.444.777-35',
'email' => 'john@gcorp.com',
'phone' => '+5541999990000',
'name' => 'John',
'is_pep' => false,
'is_us_person' => false
]
],
'consent' => [
'tax_number' => '111.444.777-35',
'ip_address' => '8.8.8.8',
'consent_at' => '2026-08-25T07:00:00.000Z'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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/onboarding"
payload := strings.NewReader("{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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/onboarding")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.trio.com.br/onboarding")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"tax_number\": \"37.335.118/0001-80\",\n \"name\": \"Entity Test\",\n \"external_id\": \"12345ET\",\n \"business_infos\": {\n \"average_ticket_amount\": {\n \"amount\": 10000000,\n \"currency\": \"BRL\"\n },\n \"annual_revenue_amount\": {\n \"amount\": 500000,\n \"currency\": \"BRL\"\n }\n },\n \"representatives\": [\n {\n \"tax_number\": \"111.444.777-35\",\n \"email\": \"john@gcorp.com\",\n \"phone\": \"+5541999990000\",\n \"name\": \"John\",\n \"is_pep\": false,\n \"is_us_person\": false\n }\n ],\n \"consent\": {\n \"tax_number\": \"111.444.777-35\",\n \"ip_address\": \"8.8.8.8\",\n \"consent_at\": \"2026-08-25T07:00:00.000Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"entity_id": "01a06ee8-4973-caa8-eda0-dc64b5aa648e",
"company_id": "01a06ee8-44d4-d879-95ca-28d9c0eb78fc",
"org_id": "1162d769-b68b-47bd-a844-d6f9d2cb2636",
"counterparty_id": "382f53d3-aeae-059b-bd3e-ca79ff706b8f",
"external_id": "123ENTITY",
"tax_number": "61775921000110",
"status": "in_validation",
"address": {
"address": null,
"address_additional_details": null,
"address_number": null,
"birth_state": null,
"city": null,
"constitution_date": null,
"district": null,
"zip_code": null
},
"business_infos": {
"id": "01a06ee8-4975-608f-570d-05ff13d49dd0",
"annual_revenue_amount": {
"amount": 5000000,
"currency": "BRL"
},
"average_ticket_amount": {
"amount": 500000,
"currency": "BRL"
},
"company_activity": null,
"company_secondary_activity": [],
"legal_name": null,
"legal_nature": null,
"name": "Entity Name"
},
"contact": {
"email": null,
"phone_number": null
},
"consent": {
"consent_at": "2026-08-25T07:00:00.000000Z",
"entity_representative_id": "bf35e7b3-2858-4ede-999e-e17e6e434071",
"id": "9d4ddbc2-7eb0-4ca4-ba75-36a10599306f",
"inserted_at": "2026-09-05T00:11:52.055275Z",
"ip_address": "8.8.8.8",
"updated_at": "2026-09-05T00:11:52.055275Z"
},
"representatives": [
{
"counterparty_id": "00012832-71f4-ec93-62e8-9cb657b86eef",
"email": "representative.name@entity.com",
"id": "bf35e7b3-2858-4ede-999e-e17e6e434071",
"inserted_at": "2026-09-05T00:11:52.054493Z",
"liveness_link": null,
"name_linked": "Representative Name",
"status": "in_validation",
"tax_number_linked": "12345678912",
"required_documents": [
"identification"
],
"updated_at": "2026-09-05T00:11:52.054493Z"
}
],
"required_documents": [
"company_contract",
"financial_statement"
],
"inserted_at": "2026-09-05T00:11:52.015299Z",
"updated_at": "2026-09-05T00:11:52.015299Z"
}
}{
"error": {
"error_code": "UNAUTHORIZED",
"error_message": "Invalid credentials"
}
}{
"error": {
"error_code": "Forbidden",
"message": "A organização não está habilitada para onboarding via API."
}
}{
"error": {
"error_code": "UNAUTHORIZED",
"error_message": "Invalid credentials"
}
}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.
Body
application/json
The onboarding attributes
Parameters for onboarding an org and entity.
Tax number of the entity
Name of the entity
Business information parameters for creating the onboarding.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Consent parameters for creating the onboarding.
Show child attributes
Show child attributes
External ID of the entity
Response
Compliance
The result of onboarding an org and an entity for compliance.
An entity for onboarding.
Show child attributes
Show child attributes