GET https://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 mxcep_••••'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response 200 BanxicoPublicStatusResponse — Current Banxico CEP service status.
Field Type Description
type * string

JSON:API resource type.

id * string

Fixed `current` identifier (the current status entry).

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.

status_label * string

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

message * string

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

last_verified_at * union

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

estimated_recovery_at union

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

check_interval_seconds integer

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.

Response status codes GET /v1/status/banxico
Status Class Description Body
200 2xx Current Banxico CEP service status. BanxicoPublicStatusResponse
401 4xx Authentication is required or the provided credentials are invalid. ErrorResponse
Response headers 200
Header Type Description
Cache-Control string Public-view cache TTL (configurable; defaults to 60 s).
Vary string Origin-based variation marker (CORS).
Errors from GET /v1/status/banxico
Status Code Detail
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9