List entities
Lists the entities of your organization for the mode (live or test) of the API key used. An entity is a legal holder of accounts and defines ownership and identity in Transfers. The list is paginated. Use the starting_after, ending_before, and limit query parameters to move through the list. The Link response header carries the URLs to navigate the paginated list.
Authorizations
Query Parameters
Tax ID of the entity owner. Fintoc normalizes the value by removing dots, hyphens, leading zeros, and surrounding whitespace, then uppercases letters before matching.
"AAA010101AAA"
One or more statuses to match: draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, and paused. Returns entities whose status matches any value you provide.
draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, paused If true, returns only the root entity of your organization. If false, returns only the non-root entities.
true
Cursor that fetches the next page of entities. Use the ID of the last entity from the current page.
"ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"
Cursor that fetches the previous page of entities. Use the ID of the first entity from the current page.
"ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0"
Maximum number of entities to return per page. Ranges from 1 to 300. Defaults to 30.
50
Response
List of entities for the current mode.
Unique identifier of the entity.
"ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN"
Type of the object. Always entity.
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"
Current status of the entity. 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"