Skip to main content
POST
Check email status for authentication

Authorizations

Authorization
string
header
required

Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.

Headers

tenant
string
required

Your tenant identifier. Requests without it are rejected.

Body

application/json
email
string<email>
required

Email address to check

Response

200 - application/json
status
enum<string>
required

Email status

Available options:
CONFIRMED,
PASSWORD_SETUP_REQUIRED,
SSO_REQUIRED
providers
enum<string>[]

SSO providers linked to this email when status is SSO_REQUIRED

Available options:
Google,
Apple