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

Export validations

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

Downloads to a file the validations matching the filters.

The format is chosen with format: csv by default, or xlsx.

The export admits up to 100,000 rows, and limit lowers that maximum.

Parameters
ParameterInTypeRequiredDescription
amount_maxquerynumber (float)optional

Inclusive maximum amount. Applied independently of amount_min.

e.g. 50000
amount_minquerynumber (float)optional

Inclusive minimum amount. Applied independently of amount_max.

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
formatquerystringoptional

File format: csv (default) or xlsx.

Default: csv

e.g. csv
fromquerystring (date)optional

Inclusive start date, applied to the validation creation date.

e.g. 2025-01-01
limitqueryintegeroptional

Requested row maximum. It only lowers the 100000-row general limit; out-of-range values keep the general limit.

e.g. 500
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. MXBA20250315001234
statusquerystringoptional

Lifecycle state. Accepts one value or a comma-separated list: queued, processing, valid, not_found, cep_unavailable, invalid, returned, failed, or error. Unsupported values are ignored.

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

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response status codesGET /v1/validations/export
StatusClassDescriptionBody
2002xxCSV or XLSX file, based on format. The filename is <slug>_validaciones_<YYYY-MM-DD>.<ext>, where <slug> identifies the deployment.Body without schema
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
Response headers200
HeaderTypeDescription
Content-DispositionstringDownload header with the canonical filename.
Errors from GET /v1/validations/export
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
d4e5f6a1b2c33c2b1a6f5e4d