Saltar al contenido principal
POST
Registra una persona física (INDIVIDUAL) o una persona jurídica (COMPANY) con su documento de identificación. La entidad se crea con estado PENDING_KYC y sin archivos; sube los archivos de respaldo posteriormente con «Subir una prueba».
  • Los datos mínimos de KYC se validan en la creación: name y lastname para INDIVIDUAL, name para COMPANY. De lo contrario, la API devuelve 422 INCOMPLETE_KYC_DATA.
  • Las propiedades desconocidas se rechazan con 400 VALIDATION_ERROR. Incluye cualquier dato adicional en attributes.
  • Los códigos de país deben ser ISO 3166-1 alpha-3 (BRA, no BR).
  • Un identificador fiscal (CPF, CNPJ, CUIT, RFC, …) es un documento, no un campo de la entidad. Envíalo en document; documents[] no se acepta en la creación (400 VALIDATION_ERROR).
  • Agrega los demás documentos (documento de identidad, comprobante de domicilio, acta constitutiva) con «Agregar un documento».
  • Conserve document.documentId de la respuesta: es el docId que se usa para subir archivos al documento principal.
Los errores usan application/problem+json con un code estable. Catálogo completo: Estados de entidad y códigos de error.

Autorizaciones

Authorization
string
header
requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

Authorization
string
requerido

Token de acceso Bearer para la autenticación. Este token se obtiene de los endpoints Get Access Token o Refresh Access Token. Tu cuenta de comerciante y el usuario que actúa se determinan a partir de él.

Ejemplo:

"Bearer <your_access_token>"

X-Correlation-ID
string

Identificador de seguimiento (UUID). Se incluye en la respuesta; Localpayment lo genera si no está presente.

Ejemplo:

"0e8f6a2c-5b3d-4c1e-9a7f-6d5e4c3b2a10"

Cuerpo

application/json
externalId
string
requerido

Tu propio identificador para la entidad. Único por comerciante, de 1 a 64 caracteres.

Ejemplo:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

type
enum<string>
requerido

INDIVIDUAL (persona física) o COMPANY (entidad jurídica).

Opciones disponibles:
INDIVIDUAL,
COMPANY
Ejemplo:

"COMPANY"

name
string
requerido

Nombre (INDIVIDUAL) o razón social (COMPANY). Hasta 255 caracteres.

Ejemplo:

"Example Company S.A."

document
object
requerido

El documento que identifica a la entidad (número de identificación fiscal o documento de identidad). Este se convierte en el documento principal. Los demás documentos se añaden posteriormente mediante la opción "Añadir documento".

lastname
string

Apellido. Obligatorio para INDIVIDUAL. Hasta 255 caracteres.

Ejemplo:

"Doe"

birthdate
string<date>

AAAA-MM-DD. Recomendado para INDIVIDUAL.

Ejemplo:

"1990-01-15"

gender
enum<string>

MALE, FEMALE, OTHER o UNDISCLOSED.

Opciones disponibles:
MALE,
FEMALE,
OTHER,
UNDISCLOSED
Ejemplo:

"FEMALE"

nationality
string

ISO 3166-1 alfa-3 (BRA, ARG, MEX).

Ejemplo:

"BRA"

birthCountry
string

ISO 3166-1 alfa-3.

Ejemplo:

"BRA"

residenceCountry
string

ISO 3166-1 alfa-3. Para una COMPANY, país de residencia fiscal.

Ejemplo:

"BRA"

occupation
string

Ocupación de la persona. Hasta 100 caracteres.

Ejemplo:

"Engineer"

isPep
boolean

Persona políticamente expuesta. Valor predeterminado: falso.

Ejemplo:

false

incorporationDate
string<date>

AAAA-MM-DD. Solo COMPANY.

Ejemplo:

"2020-01-15"

incorporationCountry
string

ISO 3166-1 alfa-3. Solo para COMPANY.

Ejemplo:

"BRA"

website
string

Página web de la empresa. Hasta 255 caracteres.

Ejemplo:

"https://www.example.com"

Nombre del representante legal (COMPANY). Hasta 255 caracteres.

Ejemplo:

"Jane Doe"

email
string

Correo electrónico de contacto. Hasta 255 caracteres.

Ejemplo:

"test@example.com"

phone
object

Teléfono de contacto, solo dígitos en cada parte.

address
object

Dirección postal. Si se envía, el país es obligatorio.

attributes
object

Campos personalizados definidos por tu esquema custom-fields (consulta Campos personalizados). Hasta 64 KB.

Respuesta

Creado.

internalId
string<uuid>

Identificador de Localpayment de la entidad. Úsalo en todos los demás endpoints de Entidades.

Ejemplo:

"5aced5da-40c1-4bec-85ff-c8cd1bcb4526"

externalId
string

Tu identificador, tal como fue enviado.

Ejemplo:

"550e8400-e29b-41d4-a716-446655440000"

type
enum<string>

INDIVIDUAL o COMPANY.

Opciones disponibles:
INDIVIDUAL,
COMPANY
Ejemplo:

"INDIVIDUAL"

status
enum<string>

Estado de la entidad. Consulta Estados de las entidades y códigos de error.

Opciones disponibles:
PENDING_KYC,
IN_REVIEW,
ACTIVE,
REJECTED,
BLOCKED,
CLOSED
Ejemplo:

"PENDING_KYC"

name
string
Ejemplo:

"Jane"

lastname
string
Ejemplo:

"Doe"

birthdate
string<date>
Ejemplo:

"1990-01-15"

gender
string | null
nationality
string
Ejemplo:

"BRA"

birthCountry
string
Ejemplo:

"BRA"

residenceCountry
string
Ejemplo:

"BRA"

occupation
string | null
isPep
boolean
Ejemplo:

false

incorporationDate
string<date> | null
incorporationCountry
string | null
website
string | null
email
string
Ejemplo:

"jane.doe@example.com"

phone
object
address
object
attributes
object | null
documentationStatus
enum<string>

NO_FILES, PARTIAL o COMPLETE: indica si ninguno, algunos o todos los documentos declarados tienen al menos un archivo. Mide la presencia de archivos, no la aprobación.

Opciones disponibles:
NO_FILES,
PARTIAL,
COMPLETE
Ejemplo:

"NO_FILES"

document
object

El documento principal con su documentId (necesario para cargar archivos), el estado derivado y las proofs[] actuales.

documents
object[]

Los demás documentos declarados (el principal está solo en document), con la misma forma.

version
integer

Versión de la entidad. Es igual al encabezado ETag; se envía de vuelta como If-Match en PATCH.

Ejemplo:

0

createdAt
string<date-time>

Marcas de tiempo UTC ISO 8601.

Ejemplo:

"2024-01-15T17:03:10Z"

updatedAt
string<date-time>

Marcas de tiempo UTC ISO 8601.

Ejemplo:

"2024-01-15T17:03:10Z"

customFieldSchemaVersion
integer | null

Versión del esquema de campos personalizados utilizado para validar atributos, o nulo.

Última modificación el 10 de noviembre de 2026