v1

latestOpenAPI 3.1.02026-07-228956435.8 KB

Entities

Create entity

Creates an entity in your organization for the mode (live or test) of the API key used. An entity is a legal holder of accounts. Returns the created entity.

post/entities

Request body

country_codestring required

ISO 3166-1 alpha-2 country code of the entity. Use MX for a Mexican entity, or another code such as US for a foreign entity.

holder_namestring required

Legal name of the entity owner.

holder_idstring

Mexican tax ID (RFC) of the entity owner, without dots or hyphens. Required for a Mexican entity (country_code is MX). For a foreign entity, omit this field or send the generic foreign RFC XEXX010101000; Fintoc rejects any other value. Must be unique within your organization, except the generic foreign RFC XEXX010101000, which can repeat across foreign entities.

Example request

{
  "country_code": "MX",
  "holder_name": "Test Entity 1",
  "holder_id": "AAA010101AAA"
}

Response

The created 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.

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