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

Exportar validaciones

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

Descarga en un archivo las validaciones que cumplen los filtros.

El formato se elige con format: csv de forma predeterminada, o xlsx.

La exportación admite hasta 100 000 filas, y limit permite reducir ese máximo.

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

Filtro — Importe máximo inclusivo. Se aplica de forma independiente de amount_min.

p. ej. 50000
amount_minquerynumber (float)opcional

Filtro — Importe mínimo inclusivo. Se aplica de forma independiente de amount_max.

p. ej. 1000.5
bankquerystringopcional

Filtro — Código SPEI del banco emisor o receptor. (1-5 dígitos. Más o menos dígitos provoca que el campo sea ignorado).

p. ej. 012
batch_idqueryintegeropcional

Filtro — Identificador del trabajo de importación que generó las validaciones.

p. ej. 42
client_refquerystringopcional

Coincidencia exacta con la client_ref enviada al validar. Distingue mayúsculas, acentos y espacios internos. Un valor vacío o que no cumple las reglas de client_ref devuelve un estado HTTP 422 (con invalid_filter en el cuerpo).

p. ej. orden-4812
formatquerystringopcional

Formato del archivo: csv o xlsx.

Predeterminado: csv

p. ej. csv
fromquerystring (date)opcional

Filtro — Fecha inicial inclusiva, aplicada sobre la creación de la validación.

p. ej. 2025-01-01
limitqueryintegeropcional

Filtro — Máximo de filas solicitado. Solo reduce el límite general de 100000; los valores fuera del intervalo conservan el límite general.

p. ej. 500
playgroundquerystringopcional

Filtro — Muestra solo las validaciones del banco de pruebas (Playground). Si se envía, el único valor admitido es 1; cualquier otro devuelve un estado HTTP 422.

p. ej. 1
retry_statequerystringopcional

Filtro — Estado del ciclo de reintentos: pending, resolved, exhausted o cancelled. Cualquier otro valor devuelve un estado HTTP 422 con invalid_filter.

p. ej. pending
searchquerystringopcional

Filtro — Texto buscado, sin distinguir mayúsculas y minúsculas, en los datos enviados, normalizados y devueltos por Banxico. % y _ se tratan como caracteres literales.

p. ej. MXBA20250315001234
statusquerystringopcional

Filtro — Estado del ciclo de vida. Acepta un valor o una lista separada por comas: queued, processing, valid, not_found, cep_unavailable, invalid, returned, failed o error. Los valores no admitidos se ignoran.

p. ej. valid
toquerystring (date)opcional

Filtro — Fecha final inclusiva, aplicada sobre la creación de la validación.

p. ej. 2025-03-31
typequerystringopcional

Filtro — Modalidad: direct para validación manual; ocr para validación a partir de una imagen.

p. ej. direct
with_deletedquerystringopcional

Filtro — Alcance de los registros retirados: omitido incluye activos y retirados; 0 deja solo activos y 1 solo retirados.

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 o XLSX según format. El nombre del archivo es <slug>_validaciones_<YYYY-MM-DD>.<ext>, donde <slug> identifica al despliegue.Cuerpo sin schema
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
c4d5e6f7a8b99b8a7f6e5d4c
422invalid_filter

El filtro `retry_state` trae un valor no admitido.

Envelope
meta.request_id
d4e5f6a1b2c33c2b1a6f5e4d