Saltar al contenido principal
GET
Obtener una entidad
Devuelve la entidad completa: datos de KYC, documentos declarados con sus pruebas activas, estados derivados y, para una COMPANY, el resumen de UBO.
  • El ejemplo es una COMPANY con dos propietarios vinculados: uboCount: 2, uboRequirementMet: true.
  • Las entidades CLOSED siguen siendo accesibles por id.
  • Un entityId que no sea UUID devuelve 400.
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"

Parámetros de ruta

entityId
string<uuid>
requerido

internalId de la entidad.

Ejemplo:

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

Respuesta

OK.

internalId
string<uuid>

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

Ejemplo:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

externalId
string

Tu identificador, tal como fue enviado.

Ejemplo:

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

type
enum<string>

INDIVIDUAL o COMPANY.

Opciones disponibles:
INDIVIDUAL,
COMPANY
Ejemplo:

"COMPANY"

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:

"Example Company S.A."

lastname
string | null
birthdate
string<date> | null
gender
string | null
nationality
string | null
birthCountry
string | null
residenceCountry
string | null
occupation
string | null
isPep
boolean
Ejemplo:

false

incorporationDate
string<date>
Ejemplo:

"2020-01-15"

incorporationCountry
string
Ejemplo:

"BRA"

website
string
Ejemplo:

"https://www.example.com/new"

Ejemplo:

"Jane Doe"

email
string
Ejemplo:

"test@example.com"

phone
object
address
object
attributes
object
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:

"COMPLETE"

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:

3

createdAt
string<date-time>

Marcas de tiempo UTC ISO 8601.

Ejemplo:

"2024-01-15T17:18:53Z"

updatedAt
string<date-time>

Marcas de tiempo UTC ISO 8601.

Ejemplo:

"2024-01-15T17:19:26Z"

customFieldSchemaVersion
integer

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

Ejemplo:

9

uboCount
integer

Número de vínculos UBO activos. Solo en el detalle de una COMPANY; null en caso contrario.

Ejemplo:

2

uboRequirementMet
boolean

Verdadero cuando uboCount es 1 o más. Solo en el detalle de una COMPANY.

Ejemplo:

true

Última modificación el 10 de noviembre de 2026