Errors
What each error means and what to do about it.
Errors come back with an HTTP status and a body like this:
{ "error": { "type": "insufficient_funds", "message": "Your wallet balance is too low for a live check. Top up in the dashboard." } }Match on type. The message is written for people and may change.
| Status | Type | Meaning |
|---|---|---|
| 400 | invalid_request | Something in the request is wrong. The message says what |
| 401 | authentication_required | No key was sent. Use Authorization: Bearer sk_... |
| 401 | invalid_key | The key doesn't exist or was revoked |
| 401 | wrong_key | That's a publishable key. Use a secret key, from your server |
| 402 | insufficient_funds | The wallet can't cover a live session. Top up |
| 403 | domain_unverified | Live keys only work while your company domain is verified |
| 404 | not_found | No session with that id for this key's environment |
| 404 | no_photo | The session has no photo. Only passed live checks do |
@myidii/node throws these as a MyidiiError, with the same type and status.
If the liveness engine is briefly unavailable while someone is scanning, the scan page asks them to try again in a minute. That happens on the page, not in your API calls, and their session stays open.