GEThttps://api.veriko.mx/v1/validations/export

Exportar verificaciones

Audiencia
public
Autenticación
API key
Permiso
validations:read
Guía de uso →

Descarga el historial de verificaciones como archivo, con los mismos filtros que GET /v1/validations: lo que se ve en la lista es lo que sale en el archivo. El formato se elige con ?format: csv por defecto, xlsx como alternativa. El tope es de 100 000 filas y ?limit sirve para pedir menos, nunca más. El nombre del archivo lleva la marca y la fecha del periodo.

Parámetros
ParámetroUbicaciónTipoObligatorioDescripción
amount_maxquerynumber (float)opcional

Monto máximo inclusive. Se compara contra el monto de la verificación (normalized_data, con respaldo en request_data). Independiente de amount_min.

p. ej. 50000
amount_minquerynumber (float)opcional

Monto mínimo inclusive. Se compara contra el monto de la verificación (normalized_data, con respaldo en request_data). Independiente de amount_max.

p. ej. 1000.5
bankquerystringopcional

Filtra por la clave SPEI de 3 dígitos del banco (receptor o emisor). Solo dígitos, máximo 5 caracteres; cualquier otro valor se ignora.

p. ej. 012
batch_idqueryintegeropcional

Filtra a las validaciones de una importación de import masivo.

p. ej. 42
formatquerystringopcional

Formato del archivo: csv (defecto) o xlsx.

Predeterminado: csv

p. ej. csv
fromquerystring (date)opcional

Fecha inicial inclusive (YYYY-MM-DD).

p. ej. 2025-01-01
limitqueryintegeropcional

Recorta el número de filas del archivo. Solo baja el tope: un valor mayor que 100 000, o menor que 1, deja el tope por defecto.

p. ej. 500
playgroundquerystringopcional

Deja solo las validaciones hechas desde el banco de pruebas. El único valor admitido es 1: cualquier otro —incluido true— responde 422 en vez de ignorarse, para que quede claro que el filtro no se aplicó.

p. ej. 1
retry_statequerystringopcional

Estado de los reintentos automáticos de la validación. pending tiene un intento por delante. resolved acabó encontrando el comprobante. exhausted agotó los intentos sin lograrlo, y cancelled se detuvo a petición. Solo tienen reintentos las validaciones que terminaron en not_found, cep_unavailable o error; el resto no aparece con ningún valor aquí.

p. ej. pending
searchquerystringopcional

Búsqueda en clave de rastreo, referencia, emisor y receptor.

p. ej. MXBA20250315001234
statusquerystringopcional

Estado en el que terminó la validación. queued y processing aún no terminaron. valid encontró el comprobante y cuadra. not_found no lo encontró —lo más común cuando la transferencia es muy reciente—. invalid lo encontró pero los datos no coinciden. cep_unavailable significa que Banxico no pudo responder, y failed o error, que la validación se rompió por nuestro lado. La diferencia que más importa: not_found es un resultado, cep_unavailable es una avería. El primero no se arregla reintentando enseguida; el segundo sí.

p. ej. valid
toquerystring (date)opcional

Fecha final inclusive (YYYY-MM-DD).

p. ej. 2025-03-31
typequerystringopcional

Cómo se pidió la validación: direct con los campos escritos a mano, ocr a partir de una imagen del comprobante.

p. ej. direct
with_deletedquerystringopcional

Si incluir las validaciones borradas. 0 deja solo las vivas —el comportamiento por omisión— y 1 incluye también las que se borraron. Las borradas conservan su resultado: sirven para cuadrar un histórico que ya se había exportado.

p. ej. 0
Petición
curl -X GET 'https://api.veriko.mx/v1/validations/export' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Códigos de respuestaGET /v1/validations/export
CódigoClaseDescripciónCuerpo
2002xxArchivo CSV (con BOM UTF-8) o XLSX según format. El nombre del archivo es <slug>_validaciones_<AAAA-MM-DD>.<ext>, donde <slug> identifica al despliegue.Sin cuerpo
4014xxSe requiere autenticación o las credenciales son inválidasErrorResponse
4224xxUn filtro trae un valor fuera de su lista admitida. El código es invalid_filter y el detail nombra el parámetro.ErrorResponse
Cabeceras de respuesta200
CabeceraTipoDescripción
Content-DispositionstringCabecera de descarga con el nombre canónico del archivo.
Errores de GET /v1/validations/export
CódigoClaveEjemplo
401unauthorized

Credenciales de autenticación ausentes o inválidas.

Envelope
meta.request_id
c4d5e6f7a8b9
422invalid_filter

El filtro `retry_state` trae un valor no admitido.

Envelope
meta.request_id
d4e5f6a1b2c3