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

Get validation statistics for the account

Audience
public
Auth
API key
Permission
validations:read
How-to guide →

Returns aggregate counters for the account's validations:

  • The top-level counters —valid, not_found, cep_unavailable, returned, error and pending— group by banxico_status.
  • by_status groups by lifecycle status.
  • by_type separates the direct and ocr modes.

It accepts the same filters as GET /v1/validations, with one exception: status is admitted but does not change the counters, because each one already carries its own target.

Parameters
ParameterInTypeRequiredDescription
amount_maxquerynumber (float)optional

Inclusive maximum amount for the counted validations.

e.g. 50000
amount_minquerynumber (float)optional

Inclusive minimum amount for the counted validations.

e.g. 1000.5
bankquerystringoptional

SPEI code of the sending or receiving bank in the original request. Values outside 1 to 5 digits are ignored.

e.g. 012
banksquerystringoptional

Comma-separated SPEI codes (up to 50); returns the validations whose sending or receiving bank is any of them. If an element does not have 1 to 5 digits, the response is HTTP status 422 with invalid_filter. Combines with bank: if you send both, both must hold.

e.g. 40012,40014,40072
batch_idqueryintegeroptional

Identifier of the import job that generated the validations.

e.g. 42
client_refquerystringoptional

Exact match with the client_ref sent when validating. It distinguishes case, accents, and inner spaces. An empty value, or one that does not meet the client_ref rules, returns an HTTP status 422 (with invalid_filter in the body).

e.g. orden-4812
fromquerystring (date)optional

Inclusive start date, applied to the validation creation date.

e.g. 2025-01-01
playgroundquerystringoptional

Keeps only playground validations. The only accepted value is 1; any other value returns HTTP status 422.

e.g. 1
retry_statequerystringoptional

Retry cycle state: pending, resolved, exhausted, or cancelled. Any other value returns HTTP status 422 with invalid_filter.

e.g. pending
searchquerystringoptional

Case-insensitive text search over the submitted, normalized, and Banxico response data. % and _ are treated as literal characters.

e.g. MXBA
statusquerystringoptional

Accepted for parity with GET /v1/validations, but it does not change any counter.

e.g. valid
toquerystring (date)optional

Inclusive end date, applied to the validation creation date.

e.g. 2025-03-31
typequerystringoptional

Mode: direct for manual validation; ocr for image-based validation.

e.g. direct
with_deletedquerystringoptional

Scope for withdrawn records: omitted includes active and withdrawn records; 0 keeps active records only and 1, withdrawn records only.

e.g. 0
Request
curl -X GET 'https://api.veriko.mx/v1/validations/stats' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200ValidationStats — Aggregated validation statistics for the account.
FieldTypeDescription
typestring

JSON:API resource type. Always validation_stats.

e.g. validation_stats
attributesobject

Aggregated counters under the request filters.

totalinteger

Validations matching the filters, regardless of verdict.

e.g. 47
validinteger

Number of validations confirmed by Banxico (CEP available).

e.g. 35
not_foundinteger

Number of transfers with no match in Banxico.

e.g. 5
cep_unavailableinteger

Number of validations whose CEP was not available even though Banxico recognized the transaction.

e.g. 2
returnedinteger

Number of validations whose transfer was settled and later returned.

e.g. 0
errorinteger

Validations without a conclusive verdict because of an error.

e.g. 1
pendinginteger

Number of validations whose processing is under way.

e.g. 1
deletedinteger

Withdrawn validations matching the remaining filters.

e.g. 2
otherinteger

Difference between total and the six verdict counters.

e.g. 1
by_typeobject

Breakdown by validation type. direct + ocr always sums to total.

direct*integer

Manual validations using CLABE, card, or phone fields.

e.g. 30
ocr*integer

OCR validations (from a receipt image).

e.g. 17
by_statusobject

Breakdown by lifecycle state. All nine properties are always present and add up to total.

queued*integer

Accepted validations awaiting processing.

e.g. 3
processing*integer

Validations currently being processed.

e.g. 1
valid*integer

Validations with a transfer confirmed in the CEP.

e.g. 35
not_found*integer

Validations with no matching transfer in the CEP.

e.g. 5
cep_unavailable*integer

Number of validations whose CEP was not available even though Banxico recognized the transaction.

e.g. 2
invalid*integer

Validations rejected because of invalid data.

e.g. 1
returned*integer

Validations whose transfer was settled and later returned.

e.g. 0
failed*integer

Validations with a terminal processing failure.

e.g. 0
error*integer

Validations whose processing ended with an error.

e.g. 1
Response status codesGET /v1/validations/stats
StatusClassDescriptionBody
2002xxAggregated validation statistics for the account.ValidationStats
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
4224xxA filter carries a value outside its allowed list. The code is invalid_filter and the detail names the parameter.ErrorResponse
Errors from GET /v1/validations/stats
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b99b8a7f6e5d4c
422invalid_filter

The `retry_state` filter has an unsupported value.

Envelope
meta.request_id
c3d4e5f6a1b22b1a6f5e4d3c