Docs
ES

← Back to schema index

ErrorResponse

Standard error response wrapper. The `code` field within each error is the stable, machine-readable contract — clients must branch on `code`, not `detail`.

Properties

Field Type Description
errors * array List of one or more errors that occurred during the request. Each entry includes `status`, `code`, `detail` and, optionally, `source.pointer` referencing the field that failed.
meta * object Response metadata including API version, route prefix, unique request identifier, and the server timestamp in UTC.
version string API version that processed the request.
api_version string API route prefix version (e.g. `v1`).
request_id string Unique request identifier (hex).
datetime object 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.
timezone * string Always `"UTC"` — the canonical timezone for every datetime field in the body.
format * string Always `"ISO 8601"` — explicit `Z` suffix on every datetime.

Used in operations

  • POST /v1/auth/login
  • POST /v1/auth/register
  • POST /v1/auth/forgot-password
  • POST /v1/auth/restore-account
  • POST /v1/auth/logout
  • POST /v1/auth/2fa/verify-challenge
  • PUT /v1/users/me
  • DELETE /v1/users/me
  • GET /v1/users/me/api-key
  • POST /v1/users/me/api-key/regenerate
  • POST /v1/users/me/api-key/reveal
  • DELETE /v1/users/me/sessions
  • DELETE /v1/users/me/sessions/{id}
  • PUT /v1/users/me/subscription
  • POST /v1/users/me/email/request-verify
  • POST /v1/users/me/email/confirm-verify
  • POST /v1/users/me/email/request-change
  • POST /v1/users/me/email/verify-otp-change
  • POST /v1/users/me/email/apply-change
  • POST /v1/users/me/2fa/request-enable
  • POST /v1/users/me/2fa/confirm-enable
  • POST /v1/users/me/2fa/request-method-change
  • POST /v1/users/me/2fa/confirm-method-change
  • POST /v1/users/me/2fa/request-disable
  • POST /v1/users/me/2fa/confirm-disable
  • POST /v1/validate
  • POST /v1/validate-ocr
  • GET /v1/validations
  • GET /v1/validations/{id}
  • DELETE /v1/validations/{id}
  • GET /v1/validations/{id}/cep
  • GET /v1/validations/{id}/image
  • GET /v1/validations/{id}/retry-attempts
  • PUT /v1/validations/{id}/retry-policy
  • POST /v1/validations/{id}/cancel-retries
  • POST /v1/beneficiaries
  • PUT /v1/beneficiaries/{id}
  • GET /v1/beneficiaries/validate-account
  • GET /v1/beneficiaries/lookup
  • GET /v1/beneficiaries/imports/template
  • POST /v1/beneficiaries/imports
  • DELETE /v1/beneficiaries/imports/{id}
  • PATCH /v1/beneficiaries/imports/{id}/rows/{row_id}
  • POST /v1/beneficiaries/imports/{id}/commit
  • POST /v1/validations/imports
  • GET /v1/validations/imports/template
  • GET /v1/validations/imports/{id}
  • DELETE /v1/validations/imports/{id}
  • GET /v1/validations/imports/{id}/preview
  • PATCH /v1/validations/imports/{id}/rows/{row_id}
  • DELETE /v1/validations/imports/{id}/rows/{row_id}
  • POST /v1/validations/imports/{id}/commit
  • PUT /v1/users/me/retry-policy
  • PUT /v1/users/me/changelog/cursor
  • POST /v1/users/me/changelog/subscribe
  • POST /v1/users/me/subscription/checkout-intent
  • POST /v1/webhook-subscribers
  • DELETE /v1/webhook-subscribers/{id}
  • POST /v1/webhook-subscribers/{id}/rotate-secret
  • POST /v1/webhook-subscribers/{id}/test
  • GET /v1/admin/users
  • POST /v1/admin/users
  • GET /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}
  • DELETE /v1/admin/users/{id}
  • PUT /v1/admin/users/{id}/suspend
  • POST /v1/admin/users/{id}/regenerate-key
  • GET /v1/admin/users/{id}/validations-series
  • POST /v1/admin/users/{id}/reset-2fa
  • POST /v1/admin/users/{id}/force-logout
  • POST /v1/admin/users/{id}/restore
  • GET /v1/admin/users/segment-counts
  • GET /v1/admin/roles
  • PUT /v1/admin/roles/{role}
  • GET /v1/admin/roles/stats
  • GET /v1/admin/roles/{role}/users
  • DELETE /v1/admin/validations/{id}
  • GET /v1/admin/users/export
  • GET /v1/admin/security/events/{id}
  • GET /v1/admin/security/audit-log/{id}
  • POST /v1/admin/security/rate-limits/reset
  • GET /v1/admin/security/otps/{id}
  • POST /v1/admin/beneficiaries
  • DELETE /v1/admin/beneficiaries/{id}
  • DELETE /v1/admin/account-directory/{accountNumber}
  • POST /v1/webhooks
  • PUT /v1/webhooks/{id}
  • DELETE /v1/webhooks/{id}
  • POST /v1/webhooks/{id}/test
  • GET /v1/webhooks/{id}/deliveries
  • POST /v1/webhooks/{id}/regenerate-secret
  • POST /v1/admin/banxico/probes
  • PUT /v1/admin/banxico/probes/{id}
  • GET /v1/admin/plans
  • POST /v1/admin/plans/create/prepare
  • POST /v1/admin/plans/create/execute
  • GET /v1/admin/plans/analytics
  • GET /v1/admin/plans/usage-data
  • GET /v1/admin/plans/audit
  • GET /v1/admin/plans/audit/{id}
  • GET /v1/admin/plans/export.csv
  • POST /v1/admin/plans/bulk
  • GET /v1/admin/plans/comparison
  • PUT /v1/admin/plans/comparison
  • GET /v1/admin/plans/{slug}
  • POST /v1/admin/plans/{slug}/update/prepare
  • POST /v1/admin/plans/{slug}/update/execute
  • PUT /v1/admin/plans/{slug}/default
  • PUT /v1/admin/plans/{slug}/toggle
  • GET /v1/admin/plans/{slug}/subscribers
  • GET /v1/admin/plans/{slug}/features
  • PUT /v1/admin/plans/{slug}/features
  • GET /v1/admin/plans/{slug}/prices
  • PUT /v1/admin/plans/{slug}/prices/{id}/toggle
  • GET /v1/admin/plans/{slug}/drift
  • POST /v1/admin/plans/{slug}/prices/create/prepare
  • POST /v1/admin/plans/{slug}/prices/create/execute
  • POST /v1/admin/plans/{slug}/prices/{id}/archive/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/archive/execute
  • POST /v1/admin/plans/{slug}/prices/{id}/edit/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/edit/execute
  • GET /v1/admin/plans/{slug}/prices/{id}/archived-sources
  • POST /v1/admin/plans/{slug}/prices/{id}/migrate-subscribers/prepare
  • POST /v1/admin/plans/{slug}/prices/{id}/migrate-subscribers/execute
  • POST /v1/admin/plans/{slug}/sync-stripe/prepare
  • POST /v1/admin/plans/{slug}/sync-stripe/execute
  • POST /v1/admin/plans/{slug}/drift/adopt
  • POST /v1/admin/plans/{slug}/test-checkout
  • POST /v1/admin/plans/{slug}/duplicate/prepare
  • POST /v1/admin/plans/{slug}/duplicate/execute
  • POST /v1/admin/plans/{slug}/delete/prepare
  • POST /v1/admin/plans/{slug}/delete/execute
  • GET /v1/plans/{slug}/prices
  • GET /v1/admin/migrations/stats
  • GET /v1/admin/migrations/sql
  • POST /v1/admin/migrations/up
  • POST /v1/admin/migrations/mark-applied
  • POST /v1/admin/migrations/mark-applied-bulk
  • POST /v1/admin/migrations/rollback
  • POST /v1/admin/migrations/rollback-to
  • GET /v1/admin/seeders/history
  • POST /v1/admin/seeders/run
  • POST /v1/admin/seeders/run-bulk
  • GET /v1/admin/tests/compare
  • GET /v1/admin/tests/cases/history
  • GET /v1/admin/tests/runs
  • GET /v1/admin/tests/runs/history.csv
  • GET /v1/admin/tests/runs/{id}
  • GET /v1/admin/tests/runs/{id}/detail
  • GET /v1/admin/tests/runs/{id}/junit.xml
  • GET /v1/admin/tests/runs/{id}/export.json
  • POST /v1/admin/tests/run
  • POST /v1/admin/tests/rerun-failed
  • POST /v1/admin/tests/runs/{id}/cancel
  • POST /v1/admin/tests/prune
  • GET /v1/admin/ci/overview
  • GET /v1/usage/breakdown
  • GET /v1/finance/statement
  • GET /v1/finance/monthly
  • GET /v1/finance/counterparties
  • GET /v1/finance/by-bank
  • GET /v1/finance/accounting
  • GET /v1/finance/ceps
  • PUT /v1/notifications/preferences
  • PUT /v1/notifications/quiet-hours
  • POST /v1/notifications/push/subscribe
  • POST /v1/notifications/push/test
  • POST /v1/notifications/telegram/link
  • DELETE /v1/notifications/{id}
  • POST /v1/notifications/{id}/read
  • GET /v1/admin/notifications/deliveries/{id}
  • GET /v1/admin/notifications/templates
  • POST /v1/admin/notifications/test-send
  • GET /v1/admin/changelog/releases
  • GET /v1/admin/changelog/releases/{version}/audit
  • GET /v1/admin/changelog/releases/{version}/distribution-status
  • POST /v1/admin/changelog/{version}/publish
  • POST /v1/admin/changelog/{version}/schedule
  • POST /v1/admin/changelog/{version}/cancel-publish
  • POST /v1/admin/changelog/{version}/cancel-adhoc
  • POST /v1/admin/changelog/{version}/broadcast-now
  • POST /v1/admin/announcements/broadcast
  • GET /v1/admin/changelog/subscribers
  • GET /v1/admin/changelog/broadcasts
  • GET /v1/admin/changelog/broadcasts/{id}/detail
  • GET /v1/admin/changelog/stats
  • POST /v1/admin/notifications/telegram/webhook
  • GET /v1/admin/notifications/telegram/status
  • POST /v1/admin/notifications/telegram/rotate
  • POST /v1/admin/notifications/telegram/test
  • GET /v1/billing/subscription
  • POST /v1/billing/subscription/resume
  • POST /v1/billing/subscription/refresh
  • POST /v1/billing/subscription/cancel
  • GET /v1/billing/upcoming-invoice
  • GET /v1/billing/credits
  • GET /v1/billing/refunds
  • POST /v1/billing/checkout-session
  • POST /v1/billing/portal-session
  • POST /v1/admin/billing/refund/prepare
  • POST /v1/admin/billing/refund/execute
  • POST /v1/admin/billing/comp/prepare
  • POST /v1/admin/billing/comp/execute
  • GET /v1/admin/billing/subscriptions
  • GET /v1/admin/billing/subscriptions/{user_id}
  • POST /v1/admin/billing/subscriptions/{user_id}/cancel
  • GET /v1/admin/billing/invoices
  • GET /v1/admin/billing/refunds
  • GET /v1/admin/billing/credits
  • GET /v1/admin/billing/webhook-events
  • GET /v1/admin/billing/webhook-events/{id}
  • POST /v1/admin/billing/webhook-events/{id}/replay
  • GET /v1/admin/billing/meter-outbox
  • GET /v1/admin/billing/audit
  • GET /v1/admin/billing/audit/{id}
  • POST /v1/billing/overage/enable
  • DELETE /v1/billing/overage/disable
  • GET /v1/playground/templates
  • POST /v1/playground/proxy
  • PUT /v1/admin/billing/users/{user_id}/quota
  • PUT /v1/admin/billing/users/{user_id}/overage
  • GET /v1/admin/api/queues/overview
  • GET /v1/admin/api/queues/workers
  • GET /v1/admin/api/queues/workers/{instanceId}
  • GET /v1/admin/api/queues/streams/{stream}/stats
  • GET /v1/admin/api/queues/streams/{stream}/jobs
  • GET /v1/admin/api/queues/streams/{stream}/jobs/{jobUuid}
  • GET /v1/admin/api/queues/streams/{stream}/batches
  • GET /v1/admin/api/queues/streams/{stream}/batches/{batchId}
  • GET /v1/admin/api/queues/streams/{stream}/dlq
  • GET /v1/admin/api/queues/streams/{stream}/dlq/{redisId}
  • GET /v1/admin/api/queues/streams/states
  • POST /v1/admin/api/queues/streams/{stream}/pause
  • POST /v1/admin/api/queues/streams/{stream}/resume
  • POST /v1/admin/api/queues/streams/{stream}/jobs/{jobUuid}/cancel/prepare
  • POST /v1/admin/api/queues/streams/{stream}/jobs/{jobUuid}/cancel/execute
  • POST /v1/admin/api/queues/streams/{stream}/dlq/{redisId}/retry/prepare
  • POST /v1/admin/api/queues/streams/{stream}/dlq/{redisId}/retry/execute
  • POST /v1/admin/api/queues/streams/{stream}/dlq/{redisId}/discard/prepare
  • POST /v1/admin/api/queues/streams/{stream}/dlq/{redisId}/discard/execute
  • POST /v1/admin/api/queues/workers/{instanceId}/restart/prepare
  • POST /v1/admin/api/queues/workers/{instanceId}/restart/execute
  • POST /v1/admin/api/queues/streams/{stream}/start/prepare
  • POST /v1/admin/api/queues/streams/{stream}/start/execute
  • POST /v1/admin/api/queues/workers/{instanceId}/stop/prepare
  • POST /v1/admin/api/queues/workers/{instanceId}/stop/execute
  • GET /v1/admin/api/queues/streams/{stream}/config
  • POST /v1/admin/api/queues/streams/{stream}/config/prepare
  • POST /v1/admin/api/queues/streams/{stream}/config/execute
  • POST /v1/admin/api/queues/streams/{stream}/config/reset/prepare
  • POST /v1/admin/api/queues/streams/{stream}/config/reset/execute
  • POST /v1/admin/api/services/heartbeat
  • GET /v1/admin/api/services/{name}
  • GET /v1/admin/api/services/{name}/logs
  • POST /v1/admin/api/services/{name}/start
  • POST /v1/admin/api/services/{name}/stop
  • POST /v1/admin/api/services/{name}/restart
  • GET /v1/admin/scheduled-tasks
  • POST /v1/admin/scheduled-tasks
  • GET /v1/admin/scheduled-tasks/_drift
  • GET /v1/admin/scheduled-tasks/_executions/recent
  • GET /v1/admin/scheduled-tasks/{name}
  • PATCH /v1/admin/scheduled-tasks/{name}
  • GET /v1/admin/scheduled-tasks/{name}/executions
  • GET /v1/admin/scheduled-tasks/{name}/executions/{id}
  • POST /v1/admin/scheduled-tasks/{name}/delete/prepare
  • POST /v1/admin/scheduled-tasks/{name}/delete/execute
  • POST /v1/admin/scheduled-tasks/{name}/run-now
  • GET /v1/account-directory/lookup