https://api.veriko.mx/v1/validations/statsGet validation statistics for the account
How-to guide →Returns aggregate counters for the account's validations:
- The top-level counters —
valid,not_found,cep_unavailable,returned,errorandpending— group bybanxico_status. by_statusgroups by lifecycle status.by_typeseparates thedirectandocrmodes.
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.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
amount_max | query | number (float) | optional | Inclusive maximum amount for the counted validations. e.g.50000 |
amount_min | query | number (float) | optional | Inclusive minimum amount for the counted validations. e.g.1000.5 |
bank | query | string | optional | SPEI code of the sending or receiving bank in the original request. Values outside 1 to 5 digits are ignored. e.g.012 |
banks | query | string | optional | 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 40012,40014,40072 |
batch_id | query | integer | optional | Identifier of the import job that generated the validations. e.g.42 |
client_ref | query | string | optional | Exact match with the orden-4812 |
from | query | string (date) | optional | Inclusive start date, applied to the validation creation date. e.g.2025-01-01 |
playground | query | string | optional | Keeps only playground validations. The only accepted value is 1 |
retry_state | query | string | optional | Retry cycle state: pending |
search | query | string | optional | Case-insensitive text search over the submitted, normalized, and Banxico response data. MXBA |
status | query | string | optional | Accepted for parity with valid |
to | query | string (date) | optional | Inclusive end date, applied to the validation creation date. e.g.2025-03-31 |
type | query | string | optional | Mode: direct |
with_deleted | query | string | optional | Scope for withdrawn records: omitted includes active and withdrawn records; 0 |
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.
| Field | Type | Description |
|---|---|---|
type | string | JSON:API resource type. Always validation_stats |
attributes | object | Aggregated counters under the request filters. |
total | integer | Validations matching the filters, regardless of verdict. e.g.47 |
valid | integer | Number of validations confirmed by Banxico (CEP available). e.g.35 |
not_found | integer | Number of transfers with no match in Banxico. e.g.5 |
cep_unavailable | integer | Number of validations whose CEP was not available even though Banxico recognized the transaction. e.g.2 |
returned | integer | Number of validations whose transfer was settled and later returned. e.g.0 |
error | integer | Validations without a conclusive verdict because of an error. e.g.1 |
pending | integer | Number of validations whose processing is under way. e.g.1 |
deleted | integer | Withdrawn validations matching the remaining filters. e.g.2 |
other | integer | Difference between 1 |
by_type | object | Breakdown by validation type. |
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_status | object | Breakdown by lifecycle state. All nine properties are always present and add up to |
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 |
| Status | Class | Description | Body |
|---|---|---|---|
| 200 | 2xx | Aggregated validation statistics for the account. | ValidationStats |
| 401 | 4xx | Authentication is required or the provided credentials are invalid. | ErrorResponse |
| 422 | 4xx | A filter carries a value outside its allowed list. The code is invalid_filter and the detail names the parameter. | ErrorResponse |
| Status | Code | Example |
|---|---|---|
| 401 | unauthorized | Invalid or missing authentication credentials. Envelope
|
| 422 | invalid_filter | The `retry_state` filter has an unsupported value. Envelope
|