GEThttps://api.veriko.mx/v1/status/banxico

Get the Banxico service status (public view)

Audience
public
Auth
API key

Returns the current operational status of the Banxico CEP validation service, derived from periodic health checks. Designed for health badges in customer dashboards; hides internal monitoring details. The response is cached 60 s on the client via Cache-Control (deploy-configurable). Requires API key authentication to identify the caller in logs and metrics but does not require a specific permission — any authenticated user can query it. When the status is degraded or down, synchronous validations may return 503 banxico_rate_limit_exhausted; configure PUT /v1/validations/{id}/retry-policy to retry automatically once the service recovers.

Request
curl -X GET 'https://api.veriko.mx/v1/status/banxico' \
  -H 'Authorization: Bearer veriko_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200BanxicoPublicStatusResponse — Current Banxico CEP service status.
FieldTypeDescription
dataobject

Main response payload. Shape varies by endpoint (object, array, or JSON:API envelope with type, id, attributes).

type*string

JSON:API resource type. Always banxico_status.

e.g. banxico_status
id*string

Fixed current identifier (the current status entry).

e.g. current
attributes*object

Public Banxico CEP service status. Returned by GET /v1/banxico/status without authentication. Shows the current operational status and a human-readable explanation.

status*string

Aggregated service status: operational — all checks pass and latency is normal; degraded — partial issues (high latency, intermittent errors); down — service unreachable; unknown — no health check data available yet.

e.g. operational
status_label*string

Human-readable status label, resolved to the request locale.

e.g. Operativo
message*string

Short explanation of the current service status, resolved to the request locale.

e.g. El servicio de verificación está operando normalmente.
last_verified_at*TimestampUTC | null

Timestamp of the last health check executed. null if no check has been run yet.

e.g. 2026-04-11T15:30:00Z
estimated_recovery_atTimestampUTC | null

Estimated service recovery time. Only set when status is degraded and a known recovery window is available. null in all other states.

e.g. null
check_interval_secondsinteger

Cadence (in seconds) of the automated full health check — the source of truth the status page uses to render "updates every X" and the countdown to the next check. Pulled live from the editable health-banxico-check scheduled task, so an admin can retune it without a deploy. Falls back to 300 when the task is missing or cron-typed.

e.g. 300
metaobject

Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.

versionstring

API version that processed the request.

e.g. 1.47.0
api_versionstring

API route prefix version (e.g. v1).

e.g. v1
request_idstring

Unique request identifier (hex).

e.g. a1b2c3d4e5f6
datetimeobject

Companion descriptor present in every response's meta block (and in outgoing webhook payloads). Lets clients assert the timezone contract without re-reading the spec.

e.g. {"timezone":"UTC","format":"ISO 8601"}
timezone*string

Always UTC — the canonical timezone for every datetime field in the body.

e.g. UTC
format*string

Always ISO 8601 — explicit Z suffix on every datetime.

e.g. ISO 8601
linksobject

Pagination or related links, present only when the endpoint returns a paginated collection.

Response status codesGET /v1/status/banxico
StatusClassDescriptionBody
2002xxCurrent Banxico CEP service status.BanxicoPublicStatusResponse
4014xxAuthentication is required or the provided credentials are invalid.ErrorResponse
Response headers200
HeaderTypeDescription
Cache-ControlstringPublic-view cache TTL (configurable; defaults to 60 s).
VarystringOrigin-based variation marker (CORS).
Errors from GET /v1/status/banxico
StatusCodeExample
401unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9