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 indicating account status, plus any additional information. Schema — OPTIONAL success boolean Indicates whether the user account is okay. Note that if credentials not valid, you will get a 401 Unauthorized. info string Additional information about the user (if authorized), especially if success was false indicating some other error about the user account.
401 Unauthorized - Missing or incorrect authentication