Errors worth branching on

These five failures cover the verification issue (POST /api/v1/verify-push), triggered on every factor prompt from auth flows. Each block below is a full { error, meta } envelope as the API returns it, and the matrix at the bottom answers retry vs surface for the same five classes. For the platform-wide decision table these branches plug into, see the error handling guide.

401 — Unauthorized

  {
    "error": {
      "code": "UNAUTHORIZED",
      "message": "The API key is invalid, expired, or lacks the required scope.",
      "status": 401
    },
    "meta": {
      "request_id": "req_verifypua1",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 401 on this page is the bearer key failing before the route ran — it never means the resource is wrong. Rotate the key or re-mint the scoped token; retrying the same request changes nothing.

403 — Forbidden

  {
    "error": {
      "code": "FORBIDDEN",
      "message": "The key is valid but does not have the scope this operation requires.",
      "status": 403
    },
    "meta": {
      "request_id": "req_verifypua1f",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 403 means the key authenticated but the operation is gated by scope — check the key’s scopes on the developer page; a 403 is never a data-not-found shape.

422 — Schema

  {
    "error": {
      "code": "VALIDATION_ERROR",
      "message": "The request failed input validation.",
      "status": 422,
      "details": { "field": "device_token", "value": "tok-0192", "expected": "the full APNs/FCM device token, not its prefix" }
    },
    "meta": {
      "request_id": "req_verifypub2",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

A 422 means the payload did not match the request schema — branch on error.details.field and resend with the full device token instead of blind-retrying the same body.

429 — Rate

  {
    "error": {
      "code": "RATE_LIMITED",
      "message": "Too many requests in the current window.",
      "status": 429,
      "details": { "retry_after": 12 }
    },
    "meta": {
      "request_id": "req_verifypuc3",
      "timestamp": "2026-09-03T12:00:00Z",
      "docs_url": "https://docs.orbit.devotel.io/errors/RATE_LIMITED"
    }
  }

The Retry-After header and error.details.retry_after are both set on every 429 — resend the SAME request after the lower of the two.

402 — Feature gate

  {
    "error": {
      "code": "PUSH_VERIFICATION_RATE_HOISTED",
      "message": "This verification has hit the per-device push limit for the current window.",
      "status": 402,
      "details": { "window_seconds": 300, "device_limit": 5 }
    },
    "meta": {
      "request_id": "req_verifypud4",
      "timestamp": "2026-09-03T12:00:00Z"
    }
  }

Surface the fallback channel — push cannot retry; offer the SMS/voice fallback instead.

60-second retry matrix

Class	Meaning	Branch response
401 `UNAUTHORIZED`	the bearer key itself fails	Surface. Rotate the key or re-mint the scoped token; do not retry the same request.
403 `FORBIDDEN`	the key lacks this operation’s scope	Surface. Fix the key’s scope set; a retry with the same key never heals it.
422 `VALIDATION_ERROR`	the payload does not match the schema	Fix, then resend intentionally. Branch on `error.details.field`; a blind retry repeats the same 422.
429 `RATE_LIMITED`	the window quota is exhausted	Retry after `error.details.retry_after` (or the `Retry-After` header) with the same request body.
`PUSH_VERIFICATION_RATE_HOISTED` (402 feature gate)	Surface the fallback channel	Branch on `error.code`. Push cannot retry; offer the SMS/voice fallback instead.

Worked request and response samples

Copy the request as written, substitute your own ids, and compare the response envelope — a success in the same shape the numbered error sections spell out.

Enroll a push factor

POST /api/v1/verify/push/factors

curl -X POST "https://api.orbit.devotel.io/api/v1/verify/push/factors" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "usr_94c0e2b4d6f8a1c3",
  "device_token": "fcm_tok-0192a3b4c5d6e7f8",
  "label": "Priya's phone"
}'

{
  "data": {
    "factor_id": "fctr_7d9c3f5a2b1e4068",
    "user_id": "usr_94c0e2b4d6f8a1c3",
    "transport": "push"
  },
  "meta": {
    "request_id": "req_verifypush",
    "timestamp": "2026-09-08T12:00:00Z"
  }
}

API Reference

All Endpoints

Errors worth branching on