Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Entities

Get entity

Returns details for the entity with the specified id in your organization.

get/entities/{id}

Path parameters

idstring required

Unique identifier of the entity.

Response

The requested entity.

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.

status'draft' | 'under_review' | 'pending_signature' | 'canceled' | 'waiting_initialization' | 'operational' | 'rejected' | 'paused' required

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"
}