Skip to main content

Verify email eligibility

POST 
/v1/auth/email-eligibility-verification

Verify email eligibility

This endpoint, named verify email eligibility, is designed to validate the eligibility of an email address for verification purposes within an authentication system. It accepts an email address through a POST request and generates a one-time password (OTP) based on a SHA3 hash of the email. This OTP is sent to the provided email using a selected template, which can vary based on the specified locale. The endpoint supports English (en) and Portuguese (pt) locales. Upon successful email sending, it returns a JSON object containing the generated salt; otherwise, it handles errors gracefully, returning appropriate HTTP status codes and error messages.

Request​

Query Parameters

    template stringrequired

    Email template

    locale stringrequired

    Email template locale

Body

required
    email stringrequired

Responses​

Email eligibility verified

Schema

    string

Loading...