Errors
Errors & rate limits
Every error includes a machine-readable code, a human-readable message, and a docs URL so you know exactly what to do next.
Stripe-style error responses
| Status | Code | Message |
|---|---|---|
| 401 | invalid_api_key | The API key you provided is invalid. Keys look like vfx_your_api_key, check your dashboard.https://verifex.dev/docs#authentication |
| 402 | quota_exceeded | You've used all your screens this month. Upgrade to get more.https://verifex.dev/pricing |
| 429 | rate_limit_exceeded | You've hit the rate limit. Slow down or upgrade your plan for higher limits.https://verifex.dev/docs |
| 400 | validation_error | name is required: provide the name of the person or entity to screen.https://verifex.dev/docs#screen |
| 403 | account_disabled | Your account has been disabled. Contact support for assistance.https://verifex.dev/contact |
| 500 | internal_error | An unexpected error occurred. Include the request_id when contacting support.https://verifex.dev/contact |
Rate limits
Free accounts are rate-limited to 10 requests/minute and 50 screens/month.
Free accounts are intended for evaluation: 50 screens/month at 10 requests/minute. Usage and quota information is available after sign-in.
When you exceed the limit the API returns rate_limit_exceeded with a 429 status. Slow down or upgrade your plan for higher limits.