Skip to main content

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 subscription status.

Schema OPTIONAL
active boolean

Whether the subscription is currently active

status string OPTIONAL

Current subscription status (e.g., 'ACTIVE', 'CANCELED', 'PAUSED')

expires date-time OPTIONAL

Subscription expiration date in ISO 8601 format

plan_name string OPTIONAL

Name of the subscription plan (e.g., 'Personal', 'Professional', 'Anti-Spam Only')

allowed_endpoints string[] OPTIONAL

List of API endpoints allowed for this plan (e.g., ['antispam', 'commentscore'])

error string OPTIONAL

Error message if subscription check failed

401

Unauthorized - Missing or incorrect authentication