Saltar al contenido principal
GET
List entities
v2 · Base URL https://api.fintoc.com/v2

Autorizaciones

Authorization
string
header
requerido

Parámetros de consulta

starting_after
string

Cursor that fetches the next page of entities. Use the ID of the last entity from the current page.

Ejemplo:

"ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

ending_before
string

Cursor that fetches the previous page of entities. Use the ID of the first entity from the current page.

Ejemplo:

"ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"

limit
integer

Maximum number of entities to return per page. Ranges from 1 to 300. Defaults to 30.

Ejemplo:

50

Respuesta

List of entities for the current mode.

id
string
requerido

Unique identifier of the entity.

Ejemplo:

"ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN"

object
any
requerido

Type of the object. Always entity.

country_code
string | null
requerido

ISO 3166-1 alpha-2 country code of the entity, in lowercase, or null when not set. For example, cl or mx.

Ejemplo:

"mx"

holder_id
string
requerido

Mexican tax ID (RFC) of the entity owner, without dots or hyphens. For a foreign entity, the value is the generic foreign RFC XEXX010101000.

Ejemplo:

"AAA010101AAA"

holder_name
string
requerido

Legal name of the entity owner.

Ejemplo:

"Test Entity 1"

is_root
boolean
requerido

Whether this entity is your organization's root entity.

Ejemplo:

true

mode
enum<string>
requerido

Whether the entity belongs to live or test data. One of live or test.

Opciones disponibles:
live,
test
Ejemplo:

"test"

status
enum<string>
requerido

Current status of the entity. One of draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, or paused.

Opciones disponibles:
draft,
under_review,
pending_signature,
canceled,
waiting_initialization,
operational,
rejected,
paused
Ejemplo:

"operational"