A legal holder of accounts. Entities define ownership and identity in Transfers.
The Entity object
An Entity represents the legal holder that owns your Accounts, identified in Mexico by an RFC (Mexican tax ID) or a CURP (unique population registry code). You receive an Entity object when you list or retrieve the entities in your organization. Each Account belongs to an Entity, and your organization has one root Entity, marked with is_root. An Entity moves through a status lifecycle from draft to operational before it can transact.
{
"id": "ent_2daFu0zqqDtZGJaSi2TGI2Mm1nN",
"object": "entity",
"country_code": "mx",
"holder_id": "AAA010101AAA",
"holder_name": "Test Entity 1",
"is_root": true,
"mode": "test",
"status": "operational"
}| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the entity. |
object | string | Type of the object. Always entity. |
country_code | string | ISO 3166-1 alpha-2 country code of the entity, in lowercase, for example cl or mx. null when not set. |
holder_id | string | Mexican tax ID (RFC) of the entity owner, without dots or hyphens. The JSON example above uses the placeholder value AAA010101AAA; for a foreign entity, the literal value is the generic foreign RFC XEXX010101000. |
holder_name | string | Legal name of the entity owner. |
is_root | boolean | If true, this entity is your organization's root entity. |
mode | string | One of live or test. Entities created with a live API key are live; entities created with a test API key are test. |
status | string | Current status of the entity. One of draft, under_review, pending_signature, canceled, waiting_initialization, operational, rejected, or paused. |