curl --request GET \
--url https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}', 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.fintoc.com/v2/entities/{entity_id}/onboardings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding",
"entity_id": "ent_8anBwgZktbZH6ydyHa6Tm0eM",
"status": "in_progress",
"source": "api",
"submitted_at": null,
"reviewed_at": null,
"submittable": false,
"data": {
"company_information": {
"incorporation_date": "2020-01-15T00:00:00.000Z",
"business_activity": "Servicios financieros",
"fiscal_address": "Av. Reforma 123, CDMX",
"business_address": "Av. Insurgentes 456, CDMX",
"settlement_account": "000000000000000000",
"phone": "+521111111111"
},
"transactional_profile": {
"resource_origins": [
"trusts",
"investments"
],
"monthly_amount_range": "1_500000",
"monthly_operations_range": "1_15000",
"declaration_accepted": true
}
},
"legal_representatives": [
{
"id": "onblr_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding_legal_representative",
"first_name": "Test Customer 1",
"last_name": "Customer",
"email": "rep@example.com",
"nationality": "mx",
"identification_number": "AAAA010101HDFAAA01",
"position": "Director General",
"documents": [
{
"slot_key": "identification",
"status": "missing"
},
{
"slot_key": "power_of_attorney",
"status": "missing"
}
]
}
],
"shareholders": [
{
"id": "onbsh_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding_shareholder",
"type": "natural_person",
"name": "Test Customer 2",
"last_name": "Customer",
"percentage": 60,
"holder_id": "AAAA010101AAA",
"parent_id": null,
"document": {
"slot_key": "identification",
"status": "missing"
}
},
{
"id": "onbsh_8anBwgZktbZH6ydyHa6Tm0eM",
"object": "onboarding_shareholder",
"type": "legal_entity",
"name": "Acme SA",
"percentage": 40,
"holder_id": "AAA010101AAA",
"parent_id": null,
"document": {
"slot_key": "articles_of_incorporation",
"status": "missing"
}
},
{
"id": "onbsh_9bnCxhAlucAI7zezIb7Un1fN",
"object": "onboarding_shareholder",
"type": "natural_person",
"name": "Test Customer 3",
"last_name": "Customer",
"percentage": 80,
"holder_id": "AAAA010101AAA",
"parent_id": "onbsh_8anBwgZktbZH6ydyHa6Tm0eM",
"document": {
"slot_key": "identification",
"status": "missing"
}
}
],
"documents": [
{
"slot_key": "tax_registration_certificate",
"status": "missing"
},
{
"slot_key": "settlement_bank_statement",
"status": "missing"
},
{
"slot_key": "proof_of_address",
"status": "missing"
},
{
"slot_key": "shareholder_structure",
"status": "missing"
},
{
"slot_key": "articles_of_incorporation",
"status": "missing"
}
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API Key: invalid-*oken"
}
}{
"error": {
"type": "invalid_request_error",
"code": "missing_resource",
"param": "id",
"message": "No such onboarding: onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
"doc_url": "https://docs.fintoc.com/reference/errors"
}
}Get an onboarding
Retrieves the onboarding with the given id for the entity. Only onboardings belonging to the organization of the API key used are visible. Requesting an onboarding that does not exist or belongs to another organization or entity returns a 404 Not Found error.
curl --request GET \
--url https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}', 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.fintoc.com/v2/entities/{entity_id}/onboardings/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)
func main() {
url := "https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fintoc.com/v2/entities/{entity_id}/onboardings/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding",
"entity_id": "ent_8anBwgZktbZH6ydyHa6Tm0eM",
"status": "in_progress",
"source": "api",
"submitted_at": null,
"reviewed_at": null,
"submittable": false,
"data": {
"company_information": {
"incorporation_date": "2020-01-15T00:00:00.000Z",
"business_activity": "Servicios financieros",
"fiscal_address": "Av. Reforma 123, CDMX",
"business_address": "Av. Insurgentes 456, CDMX",
"settlement_account": "000000000000000000",
"phone": "+521111111111"
},
"transactional_profile": {
"resource_origins": [
"trusts",
"investments"
],
"monthly_amount_range": "1_500000",
"monthly_operations_range": "1_15000",
"declaration_accepted": true
}
},
"legal_representatives": [
{
"id": "onblr_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding_legal_representative",
"first_name": "Test Customer 1",
"last_name": "Customer",
"email": "rep@example.com",
"nationality": "mx",
"identification_number": "AAAA010101HDFAAA01",
"position": "Director General",
"documents": [
{
"slot_key": "identification",
"status": "missing"
},
{
"slot_key": "power_of_attorney",
"status": "missing"
}
]
}
],
"shareholders": [
{
"id": "onbsh_0ujsswThIGTUYm2K8FjOOfXtY1K",
"object": "onboarding_shareholder",
"type": "natural_person",
"name": "Test Customer 2",
"last_name": "Customer",
"percentage": 60,
"holder_id": "AAAA010101AAA",
"parent_id": null,
"document": {
"slot_key": "identification",
"status": "missing"
}
},
{
"id": "onbsh_8anBwgZktbZH6ydyHa6Tm0eM",
"object": "onboarding_shareholder",
"type": "legal_entity",
"name": "Acme SA",
"percentage": 40,
"holder_id": "AAA010101AAA",
"parent_id": null,
"document": {
"slot_key": "articles_of_incorporation",
"status": "missing"
}
},
{
"id": "onbsh_9bnCxhAlucAI7zezIb7Un1fN",
"object": "onboarding_shareholder",
"type": "natural_person",
"name": "Test Customer 3",
"last_name": "Customer",
"percentage": 80,
"holder_id": "AAAA010101AAA",
"parent_id": "onbsh_8anBwgZktbZH6ydyHa6Tm0eM",
"document": {
"slot_key": "identification",
"status": "missing"
}
}
],
"documents": [
{
"slot_key": "tax_registration_certificate",
"status": "missing"
},
{
"slot_key": "settlement_bank_statement",
"status": "missing"
},
{
"slot_key": "proof_of_address",
"status": "missing"
},
{
"slot_key": "shareholder_structure",
"status": "missing"
},
{
"slot_key": "articles_of_incorporation",
"status": "missing"
}
]
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API Key: invalid-*oken"
}
}{
"error": {
"type": "invalid_request_error",
"code": "missing_resource",
"param": "id",
"message": "No such onboarding: onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K",
"doc_url": "https://docs.fintoc.com/reference/errors"
}
}Autorizaciones
Parámetros de ruta
The unique identifier of the entity (for example ent_8anBwgZktbZH6ydyHa6Tm0eM).
The unique identifier of the onboarding (for example onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K).
Respuesta
Returns the onboarding object with its current status, reviewed data, declared legal representatives and shareholders, and the status of every required document slot.
Unique identifier of the onboarding.
"onbprc_0ujsswThIGTUYm2K8FjOOfXtY1K"
Type of the object. Always onboarding.
Reviewed data for the onboarding, grouped by type. Onboardings created through the API include company_information and transactional_profile. Fintoc sets declaration_accepted to true on creation and returns incorporation_date as an ISO 8601 datetime in UTC.
{
"company_information": {
"incorporation_date": "2020-01-15T00:00:00.000Z",
"business_activity": "Servicios financieros",
"fiscal_address": "Av. Reforma 123, CDMX",
"business_address": "Av. Insurgentes 456, CDMX",
"settlement_account": "000000000000000000",
"phone": "+521111111111"
},
"transactional_profile": {
"resource_origins": ["trusts", "investments"],
"monthly_amount_range": "1_500000",
"monthly_operations_range": "1_15000",
"declaration_accepted": true
}
}
Document slots for the onboarding, with their upload status.
Show child attributes
Show child attributes
Identifier of the entity this onboarding belongs to. null if not associated with an entity.
"ent_8anBwgZktbZH6ydyHa6Tm0eM"
Legal representatives declared for the entity.
Show child attributes
Show child attributes
ISO 8601 datetime, in UTC, of when the onboarding was reviewed. null until it is reviewed.
"2026-01-16T09:00:00Z"
Shareholders declared for the entity.
Show child attributes
Show child attributes
Channel the onboarding is being completed through. One of api or dashboard.
api, dashboard "api"
Current status of the onboarding. One of pending, in_progress, submitted, approved, rejected or cancelled.
pending, in_progress, submitted, approved, rejected, cancelled "pending"
Whether the onboarding has every required field and document completed and can be submitted for review.
false
ISO 8601 datetime, in UTC, of when the onboarding was submitted for review. null until it is submitted.
"2026-01-15T14:30:00Z"
Type of the onboarding: account_holder or settlement_recipient.
account_holder, settlement_recipient "account_holder"
¿Esta página le ayudó?