Saltar al contenido principal
GET
Obtener un documento
Devuelve un documento declarado con su estado derivado y sus pruebas activas.
  • El primer ejemplo muestra un documento VERIFIED (su única prueba activa está APPROVED); el segundo, uno REJECTED, con el motivo en la prueba.
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"

docId
string<uuid>
requerido

documentId del documento.

Ejemplo:

"e0ea9515-442e-4bc5-bc82-b8d278255c37"

Respuesta

OK.

documentId
string<uuid>

Identificador del documento (docId). Úsalo para cargar y listar pruebas.

Ejemplo:

"2e16d844-4fa9-4295-9a21-83ec32ef241a"

entityId
string<uuid>

Entidad propietaria.

Ejemplo:

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

type
enum<string>

Tipo de documento.

Opciones disponibles:
DNI,
NATIONAL_ID,
DRIVER_LICENSE,
PASSPORT,
CE,
CC,
CUIT,
CUIL,
RFC,
CURP,
CPF,
CNPJ,
RUC,
NIT,
TAX_ID,
ARTICLES_OF_INCORPORATION,
POWER_OF_ATTORNEY,
TAX_CERTIFICATE,
PAYSLIP,
ARCA_REGISTRATION,
PROOF_OF_ADDRESS,
PROOF_OF_FUNDS,
OTHER
Ejemplo:

"CPF"

id
string

Número de documento según lo declarado.

Ejemplo:

"00000000000"

issuingCountry
string

Emisión de datos según lo declarado.

Ejemplo:

"BRA"

issueDate
string<date> | null

Emisión de datos según lo declarado.

expirationDate
string<date> | null

Emisión de datos según lo declarado.

isPrimary
boolean

Documento identificativo de la entidad.

Ejemplo:

true

status
enum<string>

Estado derivado del documento: EXPIRED si expirationDate ha pasado, REJECTED si alguna prueba activa está rechazada, VERIFIED si todas las pruebas activas están aprobadas; de lo contrario, PENDING.

Opciones disponibles:
PENDING,
VERIFIED,
REJECTED,
EXPIRED
Ejemplo:

"VERIFIED"

metadata
object | null

Metadatos de formato libre.

proofs
object[]

Pruebas vigentes del documento (los archivos reemplazados no se muestran).

createdAt
string<date-time>
Ejemplo:

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

updatedAt
string<date-time>
Ejemplo:

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

Última modificación el 10 de noviembre de 2026