Customer Onboarding Guide

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.

This guide explains the onboarding flow for an integration in which an organization acts as an distributor for its customers’ organizations. The process allows the distributor organization to submit the data required to open the customer’s account, track the Compliance analysis through webhooks and, once approved, perform operations on behalf of the customer’s organization.

Important: this guide explains the flow and the concepts involved. To check all available fields, types, and responses, see the onboarding creation API reference.

1. How the organization model works

In this model, there are two main parties:

Distributor organization: the organization that holds the API credentials and controls the flow for its customers.
Customer organization: the organization created during onboarding, which will be used for the customer’s transactions.

The flow can be summarized as follows:

Distributor organization
        |
        | POST /onboarding
        v
Customer creation
        |
        +--> Organization
        |
        +--> Entity
        |
        +--> Representative data
        |
        v
Compliance analysis
        |
        +--> in_review
        |
        +--> approved
        |
        └--> rejected
        |
        v
Approved organization
        |
        v
Operations via API using
Trio-Target-Org-Id

The distributor organization continues to use its own credentials. To perform an operation on a customer’s organization, simply provide the target organization’s identifier in the Trio-Target-Org-Id header. Also see Acting on another organization.

2. Creating the onboarding

Onboarding is created through the endpoint:

POST /onboarding

In Sandbox:

https://api.sandbox.trio.com.br/onboarding

Authentication uses Basic Authentication, with the distributor organization’s client_id and client_secret.

Authorization: Basic <encoded-value>
Content-Type: application/json

Required data

To start onboarding, send the company’s data, the representative’s data, and the consent data.

Field	Description
`tax_number`	Tax ID (CNPJ) of the company being registered
`name`	Entity name
`external_id`	External identifier used by your system
`business_infos`	Company business information
`representatives`	Company representative data
`consent`	Consent data for opening the account

Within business_infos, information such as the following is provided:

annual revenue;
average ticket.

The representative must have:

name;
tax ID (CPF);
phone number;
email.

Each representative can also include two optional compliance flags. Both default to false when omitted:

is_pep: whether the representative is a politically exposed person (PEP);
is_us_person: whether the representative is a US person for tax purposes.

The consent must have:

the tax ID (CPF) of the person responsible for the consent;
IP address;
date and time of the authorization.

3. Creation example

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"
    }
  }'

Monetary values are sent in cents. For example:

{
  "amount": 500000,
  "currency": "BRL"
}

represents R$ 5,000.00.

4. What happens after creation

Onboarding creation is synchronous. After the request is processed, the API returns the main identifiers of the structure that was created, including:

entity_id;
org_id;
company_id;
external_id;
tax_number;
status.

Example:

{
  "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"
  }
}

Best practice: save the org_id, entity_id, and external_id in your system. The org_id will be used later to perform operations on the customer’s organization.

Required documents

The response includes a required_documents field in two places, based on the documents configured for your distribution channel:

at the entity level (data.required_documents): the documents the company must provide, such as company_contract, power_of_attorney, and financial_statement;
inside each representative (data.representatives[].required_documents): the documents that representative must provide, typically identification.

Both fields are null when no document is required. Use them to know exactly which documents to upload in the next step.

5. Uploading entity and representative documents

Depending on the distribution channel configuration, Compliance may require supporting documents to be uploaded for the entity and/or its representatives. Documents are sent after the onboarding is created, using the identifiers returned by POST /onboarding. Each document is uploaded individually through:

POST /onboarding/documents

The request uses multipart/form-data and the same Basic Authentication as the onboarding creation. Only PDF files are accepted.

Fields

Field	Description
`reference_type`	`entity` or `entity_representative`
`reference_id`	The `entity_id` (for `entity`) or the representative `id` (for `entity_representative`)
`document_type`	Document classification (see below)
`file`	The PDF file

Document types by reference:

Entity (reference_type: entity): company_contract, power_of_attorney, financial_statement;
Representative (reference_type: entity_representative): identification.

The entity_id and the representative id are both returned in the POST /onboarding response.

Upload example

Uploading a financial statement for the entity:

curl --request POST \
  --url https://api.sandbox.trio.com.br/onboarding/documents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'reference_type=entity' \
  --form 'reference_id=01a06ee8-4973-caa8-eda0-dc64b5aa648e' \
  --form 'document_type=financial_statement' \
  --form 'file=@./financial_statement.pdf'

Uploading an identification document for a representative:

curl --request POST \
  --url https://api.sandbox.trio.com.br/onboarding/documents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'reference_type=entity_representative' \
  --form 'reference_id=bf35e7b3-2858-4ede-999e-e17e6e434071' \
  --form 'document_type=identification' \
  --form 'file=@./identification.pdf'

Response

{
  "message": "Document uploaded successfully",
  "data": {
    "id": "d9f3b1a2-8c4d-4e5f-a6b7-1c2d3e4f5a6b",
    "reference_type": "entity",
    "reference_id": "01a06ee8-4973-caa8-eda0-dc64b5aa648e",
    "document_type": "financial_statement",
    "inserted_at": "2026-09-24T11:25:00.000000Z",
    "updated_at": "2026-09-24T11:25:00.000000Z"
  }
}

Tip: upload one document per request. Repeat the call for each required document of the entity and of each representative. See the upload document API reference.

6. Liveness step

After creation, onboarding moves on to the validation process. The representative needs to complete the facial recognition (liveness) check required to open the account. Example:

{
  "representatives": [
    {
      "id": "0191148f-b189-8e42-27a5-1368cc00dea8",
      "status": "in_review",
      "tax_number_linked": "11144477735",
      "name_linked": "John",
      "email": "john@gcorp.com",
      "liveness_link": "https://liveness.link/example?123"
    }
  ]
}

The customer must use this link to complete the facial recognition step.

7. Compliance analysis

Once liveness is completed, the customer’s information moves on to Compliance analysis. The distributor organization does not need to keep polling the API to find out whether the analysis has finished. Tracking should be done through entity webhooks. Events in the entity category are sent whenever the Compliance status of an entity created through onboarding changes. See the Entity events reference.

8. Onboarding webhooks

The main events related to onboarding are:

Event	Status	Description
`entity.in_review`	`in_review`	The entity is under Compliance analysis
`entity.approved`	`approved`	The entity has been approved and is ready to operate
`entity.rejected`	`rejected`	The entity was rejected by Compliance analysis

`entity.in_review`

Indicates that the entity has entered the analysis stage. When applicable, the event also contains the representative’s liveness_link.

{
  "data": {
    "entity_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "company_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "org_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "status": "in_review",
    "external_id": "12345ET",
    "tax_number": "37335118000180",
    "representatives": [
      {
        "status": "in_review",
        "liveness_link": "https://liveness.link/example?123"
      }
    ]
  },
  "timestamp": "2026-08-25T07:05:00.000Z",
  "type": "in_review",
  "category": "entity"
}

`entity.approved`

Indicates that the entity was approved by Compliance and is ready to operate.

{
  "data": {
    "entity_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "company_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "org_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "status": "approved",
    "external_id": "12345ET",
    "tax_number": "37335118000180"
  },
  "timestamp": "2026-08-25T09:30:00.000Z",
  "type": "approved",
  "category": "entity"
}

From this event onward, your application can consider the customer’s organization ready for the operations supported by the product.

`entity.rejected`

Indicates that the entity was rejected by Compliance. In this case, the event contains a reason field describing the reason for the rejection.

{
  "data": {
    "entity_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "company_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "org_id": "0191148f-b189-8e42-27a5-1368cc00dea8",
    "status": "rejected",
    "reason": "Documentation could not be validated.",
    "external_id": "12345ET",
    "tax_number": "37335118000180"
  },
  "timestamp": "2026-08-25T09:30:00.000Z",
  "type": "rejected",
  "category": "entity"
}

9. Using the customer’s organization

Once onboarding has been approved, the distributor organization can make calls on behalf of the customer’s organization. To do this, use the same credentials as the distributor organization and provide the customer’s org_id in the header:

Trio-Target-Org-Id: {target_org_id}

Example:

curl https://api.sandbox.trio.com.br/banking/entities \
  -H "Content-Type: application/json" \
  -H "Trio-Target-Org-Id: 1162d769-b68b-47bd-a844-d6f9d2cb2636" \
  -u {client_id}:{client_secret}

In this scenario:

Credentials used
        |
        v
Distributor organization
        |
        | Trio-Target-Org-Id
        v
Customer organization
        |
        v
Requested operation

Access is validated by Trio on every request. If the distributor organization does not have access to the specified organization, the API returns 403.

Important: access to the organization is configured at the organization level and must be enabled for the integration.

10. Complete flow

The complete flow can be understood as follows:

1. Customer requests account opening
              |
              v
2. Distributor collects the data
              |
              v
3. POST /onboarding
              |
              v
4. Trio creates the organization and entity
              |
              v
5. API returns the identifiers
   - org_id
   - entity_id
   - company_id
              |
              v
6. Webhook: entity.in_review
              |
              v
7. Representative completes liveness
              |
              v
8. Compliance analyzes the data
              |
        +-----+-----+
        |           |
        v           v
   approved      rejected
        |           |
        v           v
9. Organization   Handling
   ready           flow
        |
        v
10. API with
    Trio-Target-Org-Id
        |
        v
11. Operations on the
    customer's organization

11. Integration recommendations

Save the identifiers

After POST /onboarding, store at least the following in your system:

external_id;
org_id;
entity_id;
company_id;
tax_number;
current status.

This makes it easier to reconcile your system with Trio.

Use `external_id` as your system’s reference

The external_id should be a reference that lets you easily identify the customer within your application. Example:

customer_12345

or:

company_98765

update the corresponding status in your system.

Only enable operations after approval

Keep the customer in an onboarding state while Compliance is analyzing the entity. After receiving:

entity.approved

the customer can move on to the operations supported by the integration.

Handle rejections

When you receive:

entity.rejected

store the reason returned by the webhook so the customer’s case can be handled appropriately.

References

Retrieving the bank account after approval

Once the entity is approved (entity.approved), the customer’s bank account is typically made available within a few minutes. It is not created at the exact same instant as the approval event, so you should not assume the account identifier is available immediately. To retrieve it, call the list virtual accounts endpoint, passing the customer’s org_id in the header:

Trio-Target-Org-Id: {org_id}

Use this call to list the virtual accounts created for the customer’s organization and collect the account identifier you’ll need in order to perform transactions on their behalf. This guide is also available in Portuguese: /guides/onboarding-guide-pt-br.

Getting Started

Trio SDK

Onboarding

Pix

Receivables

Payments

Boleto

Webhooks

Operations

Customer Onboarding Guide

1. How the organization model works

2. Creating the onboarding

Required data

3. Creation example

4. What happens after creation

Required documents

5. Uploading entity and representative documents

Fields

Upload example

Response

6. Liveness step

7. Compliance analysis

8. Onboarding webhooks

`entity.in_review`

`entity.approved`

`entity.rejected`

9. Using the customer’s organization

10. Complete flow

11. Integration recommendations

Save the identifiers

Use `external_id` as your system’s reference

Only enable operations after approval

Handle rejections

References

Retrieving the bank account after approval

​1. How the organization model works

​2. Creating the onboarding

​Required data

​3. Creation example

​4. What happens after creation

​Required documents

​5. Uploading entity and representative documents

​Fields

​Upload example

​Response

​6. Liveness step

​7. Compliance analysis

​8. Onboarding webhooks

​entity.in_review

​entity.approved

​entity.rejected

​9. Using the customer’s organization

​10. Complete flow

​11. Integration recommendations

​Save the identifiers

​Use external_id as your system’s reference

​Only enable operations after approval

​Handle rejections

​References

​Retrieving the bank account after approval

1. How the organization model works

2. Creating the onboarding

Required data

3. Creation example

4. What happens after creation

Required documents

5. Uploading entity and representative documents

Fields

Upload example

Response

6. Liveness step

7. Compliance analysis

8. Onboarding webhooks

`entity.in_review`

`entity.approved`

`entity.rejected`

9. Using the customer’s organization

10. Complete flow

11. Integration recommendations

Save the identifiers

Use `external_id` as your system’s reference

Only enable operations after approval

Handle rejections

References

Retrieving the bank account after approval