Error Codes

All errors return JSON with a single error field explaining what went wrong.

{
  "error": "Descriptive error message"
}

Reference

HTTP Status	Error Message	Cause	Resolution
400 Bad Request	Invalid user_id format	The user_id query parameter is missing or is not a valid UUID v4 string	Ensure user_id is present and formatted as a UUID (e.g. a1b2c3d4-0000-0000-0000-000000000000)
401 Unauthorized	Unauthorized	The Authorization header is missing, the API key is invalid, revoked, expired, or belongs to a non-Partner account	Check that you are sending Authorization: Bearer YOUR_API_KEY with a valid Partner API key
429 Too Many Requests	Too many failed lookups. Please try again later.	Your integration has made too many failed requests in a short window, triggering the rate limiter	Wait before retrying; implement exponential back-off in your integration

400 — Bad request

Returned when the request is malformed. The most common cause is a missing or incorrectly formatted user_id.

GET /api/ib/user-status
Authorization: Bearer YOUR_API_KEY

{
  "error": "Invalid user_id format"
}

401 — Unauthorized

Returned when the API key is missing, invalid, or not associated with a Partner account.

{
  "error": "Unauthorized"
}

info

API keys are issued only to Partner accounts. If you believe your key is valid but still receive a 401, contact your account manager.

429 — Too many requests

Returned when your integration triggers the abuse-prevention rate limiter through repeated failed lookups.

{
  "error": "Too many failed lookups. Please try again later."
}

For general rate limit information see the Rate Limits page.