Skip to main content

​
Checking the API is up

The API exposes an unauthenticated health endpoint you can call or monitor at any time:
A healthy response is:
Point your uptime monitor at this endpoint. Because it needs no API key, you can monitor it without embedding a credential. See Health check.
Health confirms the API itself is reachable. It does not test a specific scope’s provider, so a healthy API can still return a failed check if an upstream provider is down. Watch your failed rate as well as the health endpoint.

​
Getting help

When you contact support, include the details that let us find the exact check:
1

The reference

The reference of the affected verification. This is the single most useful thing you can provide; it identifies the check precisely.
2

The environment

Whether it was test or live. The key prefix tells you.
3

What you expected and what you got

The status and any errorMessage you received, and what you expected instead.
4

When it happened

The approximate time, so we can line it up with logs.
Never share your API key, or a webhook signing secret, in a support message. We never need your secret to help you. Share the reference, the status, and the error message instead.

​
Before you reach out

Many issues resolve from the docs faster than a support round trip:
  • A 403 is almost always approval or scope activation. See Scopes and activation.
  • A 402 is wallet balance. See Wallet and billing.
  • A 422 is the request body. See Errors.
  • A check that “fails for everyone” on one scope is usually a configuration issue on that scope, worth checking in the dashboard first.