curl --request GET \
--url https://api.fintoc.com/v2/entities/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.fintoc.com/v2/entities/{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/{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/{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/{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/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fintoc.com/v2/entities/{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": "ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
"object": "entity",
"holder_id": "AAA010101AAA",
"holder_name": "Test Entity 1",
"is_root": true,
"mode": "test",
"status": "operational",
"country_code": "mx",
"capabilities": {
"account_holder": {
"status": "operational"
},
"settlement_recipient": {
"status": "under_review"
}
}
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API Key: invalid-*oken"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "Entity not found: ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN"
}
}Get an entity
Returns details for the entity with the specified id in your organization.
curl --request GET \
--url https://api.fintoc.com/v2/entities/{id} \
--header 'Authorization: <api-key>'import requests
url = "https://api.fintoc.com/v2/entities/{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/{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/{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/{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/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.fintoc.com/v2/entities/{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": "ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
"object": "entity",
"holder_id": "AAA010101AAA",
"holder_name": "Test Entity 1",
"is_root": true,
"mode": "test",
"status": "operational",
"country_code": "mx",
"capabilities": {
"account_holder": {
"status": "operational"
},
"settlement_recipient": {
"status": "under_review"
}
}
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API Key: invalid-*oken"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_not_found",
"message": "Entity not found: ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN"
}
}Authorizations
Path Parameters
Unique identifier of the entity.
Response
The requested entity.
Unique identifier of the entity.
"ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN"
Type of the object. Always entity.
Statuses for the entity's capabilities. A capability is a role the entity can take in Fintoc, such as holding accounts or receiving settlements. Each capability has its own onboarding, so the statuses can differ.
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code of the entity, in lowercase, or null when not set. For example, cl or mx.
"mx"
Mexican tax ID (RFC) of the entity owner, without dots or hyphens. For a foreign entity, the value is the generic foreign RFC XEXX010101000.
"AAA010101AAA"
Legal name of the entity owner.
"Test Entity 1"
Whether this entity is your organization's root entity.
true
Whether the entity belongs to live or test data. One of live or test.
live, test "test"
Overall status of the entity. The value is operational when any capability is operational. Otherwise, the value matches the account_holder capability status. Use capabilities to check each capability on its own. One of draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, or paused.
draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, paused "operational"
Was this page helpful?