Check User Credentials

Verifies user credentials and returns information on the user account status. This endpoint can be used on a settings page or for other purposes where quick verification that the user authorization works correctly is needed. It may also return info about the account status, if there is an issue with the account.

This API can only be called using an account's actual credentials and will only return info about the account which is authorized. It can never give info about incorrect credentials other than returning a 401 Unauthorized.

Header Parameters
X-User-Email email — REQUIRED Account email address, for authentication
X-API-Key string — REQUIRED API key owned by the user (email), for authentication

Responses
200 Successful response - returns JSON containing the account's credit balance status. Schema — OPTIONAL active boolean Whether the account's credit balance is above $0, so calls can be made status string — OPTIONAL Balance status: 'active' (balance above $0) or 'no_credit'. Null if the balance could not be read expires date-time — OPTIONAL Always null: a prepaid balance does not expire. Kept for backward compatibility plan_name string — OPTIONAL The balance as text, e.g. 'Credit Balance: $12.34' allowed_endpoints string[] — OPTIONAL List of API endpoints allowed for this plan (e.g., ['antispam', 'commentscore']) error string — OPTIONAL Error message if the balance could not be read
401 Unauthorized - Missing or incorrect authentication