Saltar al contenido principal
GET
Obtener una prueba
Devuelve los metadatos de una prueba y un downloadUrl firmado de corta duración para obtener el archivo.
  • El host, la caducidad y la firma de downloadUrl están abreviados en el ejemplo.
  • El acceso a los archivos se audita con el usuario de tu token de acceso.
  • Si la URL caduca, vuelva a llamar a este endpoint para obtener una nueva.
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

proofId
string<uuid>
requerido

ID de la prueba.

Ejemplo:

"2c4c2f74-7179-4113-83fb-f11dbce9e07d"

Respuesta

OK.

id
string

Identificador de prueba (proofId).

Ejemplo:

"2c4c2f74-7179-4113-83fb-f11dbce9e07d"

documentId
string<uuid>

Documento al que da soporte el archivo.

Ejemplo:

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

proofType
enum<string>

FRONT, BACK, SELFIE, DOCUMENT, OTHER.

Opciones disponibles:
FRONT,
BACK,
SELFIE,
DOCUMENT,
OTHER
Ejemplo:

"FRONT"

fileName
string

Metadatos del archivo tal como se cargaron. Verifica que sizeBytes > 0 después de una carga.

Ejemplo:

"id_front.jpg"

mimeType
string

Metadatos del archivo tal como se cargaron. Verifica que sizeBytes > 0 después de una carga.

Ejemplo:

"image/jpeg"

sizeBytes
integer

Metadatos del archivo tal como se cargaron. Verifica que sizeBytes > 0 después de una carga.

Ejemplo:

102400

verificationStatus
enum<string>

PENDING, IN_REVIEW, APPROVED, REJECTED. Establecido por Localpayment Compliance.

Opciones disponibles:
PENDING,
IN_REVIEW,
APPROVED,
REJECTED
Ejemplo:

"PENDING"

verifiedBy
string | null

Resultado de la verificación. verificationReason se completa en caso de rechazo.

verifiedAt
string<date-time> | null

Resultado de la verificación. verificationReason se completa en caso de rechazo.

verificationReason
string | null

Resultado de la verificación. verificationReason se completa en caso de rechazo.

uploadedBy
string

Usuario de tu cuenta que subió el archivo (desde el token de acceso) y hora de subida.

Ejemplo:

"12345"

uploadedAt
string<date-time>

Usuario de tu cuenta que subió el archivo (desde el token de acceso) y hora de subida.

Ejemplo:

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

status
enum<string>

Ciclo de vida de la prueba: CURRENT (activa), SUPERSEDED (reemplazada por una carga más reciente del mismo proofType) o DELETED. Independiente de verificationStatus.

Opciones disponibles:
CURRENT,
SUPERSEDED,
DELETED
Ejemplo:

"CURRENT"

supersededAt
string<date-time> | null

Establecido cuando se reemplazó la prueba.

supersededBy
string | null

Establecido cuando se reemplazó la prueba.

replacedByProofId
string<uuid> | null

Establecido cuando se reemplazó la prueba.

deletedAt
string<date-time> | null

Establecido cuando se eliminó la prueba.

deletedBy
string | null

Establecido cuando se eliminó la prueba.

inVerification
boolean

verdadero mientras la prueba sea parte de una revisión en curso (entidad IN_REVIEW); no se puede reemplazar ni eliminar entonces.

Ejemplo:

true

downloadUrl
string

URL firmada válida durante 10 minutos. Solicítala justo antes de descargar; no la guardes.

Ejemplo:

"https://files.example.com/<object-path>?expires=600&signature=<redacted>"

Última modificación el 10 de noviembre de 2026