v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Entities

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.

get/entities

Query parameters

starting_afterstring

Example:ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

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

ending_beforestring

Example:ent_2rNxBkOrlHoOYsZTyQYhA0o8Ek0

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

limitinteger

Example:50

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

Response

List of entities for the current mode.

idstring required

Unique identifier of the entity.

object'entity' required

Type of the object. Always entity.

country_codestring nullable required

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

holder_idstring required

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

holder_namestring required

Legal name of the entity owner.

is_rootboolean required

Whether this entity is your organization's root entity.

mode'live' | 'test' required

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

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

Example response

[
  {
    "id": "ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
    "country_code": "mx",
    "holder_id": "AAA010101AAA",
    "holder_name": "Test Entity 1",
    "is_root": true,
    "mode": "test",
    "status": "operational"
  }
]