VerikoDocs

Escribe para buscar. Enter abre el primer resultado.

EN
GEThttps://api.veriko.mx/v1/validations/stats

Obtener las estadísticas de validaciones de la cuenta de usuario

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

Devuelve contadores agregados de las validaciones de la cuenta:

  • Los contadores de primer nivel —valid, not_found, cep_unavailable, returned, error y pending— agrupan por banxico_status.
  • by_status agrupa por estado del ciclo de vida.
  • by_type separa las modalidades direct y ocr.

Acepta los mismos filtros que GET /v1/validations, con una excepción: status se admite pero no modifica los contadores (cada uno lleva ya su propio objetivo).

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

Filtro — Importe máximo inclusivo de las validaciones contadas.

p. ej. 50000
amount_minquerynumber (float)opcional

Filtro — Importe mínimo inclusivo de las validaciones contadas.

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
fromquerystring (date)opcional

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

p. ej. 2025-01-01
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. 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. MXBA
statusquerystringopcional

Filtro — Se acepta para mantener paridad con GET /v1/validations, pero no modifica ningún contador.

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/stats' \
  -H 'Authorization: Bearer veriko_••••'

Ejemplo en Python — próximamente.

Ejemplo en JavaScript — próximamente.

Ejemplo en PHP — próximamente.

Probar en el playground →
Respuesta 200ValidationStats — Estadísticas agregadas de las validaciones de la cuenta.
CampoTipoDescripción
typestring

Tipo de recurso JSON:API. Siempre validation_stats.

p. ej. validation_stats
attributesobject

Contadores agregados bajo los filtros de la petición.

totalinteger

Cantidad de validaciones que cumplen los filtros, sin distinguir veredicto.

p. ej. 47
validinteger

Cantidad de validaciones confirmadas por Banxico (CEP disponible).

p. ej. 35
not_foundinteger

Cantidad de validaciones sin CEP y sin coincidencia en Banxico.

p. ej. 5
cep_unavailableinteger

Cantidad de validaciones cuyo CEP no estaba disponible aunque Banxico reconoció la transacción.

p. ej. 2
returnedinteger

Cantidad de validaciones cuya operación se liquidó y después se devolvió.

p. ej. 0
errorinteger

Cantidad de validaciones sin veredicto concluyente por un error.

p. ej. 1
pendinginteger

Cantidad de validaciones cuyo procesamiento está en curso.

p. ej. 1
deletedinteger

Cantidad de validaciones retiradas que cumplen los demás filtros.

p. ej. 2
otherinteger

Diferencia entre total y los seis contadores de veredicto.

p. ej. 1
by_typeobject

Desglose por tipo de validación. direct + ocr siempre suma total.

direct*integer

Cantidad de validaciones realizadas mediante captura manual.

p. ej. 30
ocr*integer

Cantidad de validaciones realizadas mediante imagen (OCR).

p. ej. 17
by_statusobject

Desglose por estado del ciclo de vida. Las propiedades siempre están presentes y suman total.

queued*integer

Cantidad de validaciones aceptadas que esperan procesamiento.

p. ej. 3
processing*integer

Cantidad de validaciones cuyo procesamiento está en curso.

p. ej. 1
valid*integer

Cantidad de validaciones confirmadas por Banxico (CEP disponible).

p. ej. 35
not_found*integer

Cantidad de validaciones sin CEP y sin coincidencia en Banxico.

p. ej. 5
cep_unavailable*integer

Cantidad de validaciones cuyo CEP no estaba disponible aunque Banxico reconoció la transacción.

p. ej. 2
invalid*integer

Cantidad de validaciones rechazadas por datos inválidos.

p. ej. 1
returned*integer

Cantidad de validaciones cuya operación se liquidó y después se devolvió.

p. ej. 0
failed*integer

Cantidad de validaciones con un fallo terminal de procesamiento.

p. ej. 0
error*integer

Cantidad de validaciones cuyo procesamiento terminó con un error.

p. ej. 1
Códigos de respuestaGET /v1/validations/stats
CódigoClaseDescripciónCuerpo
2002xxEstadísticas agregadas de las validaciones de la cuenta.ValidationStats
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
Errores de GET /v1/validations/stats
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
c3d4e5f6a1b22b1a6f5e4d3c