Validate email for account sign-up

Validate email for account sign-up

Validate whether an email is valid for sign up. Using an email that fails this check can result in the associated account missing communications and features that are distributed through email.

POSThttps://studio.edgeimpulse.com/v1/api/emails/validate

Body

application/json

email*string

E-mail address to validate

Example: "[e-mail]"

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

email*string

Email address that was checked.

verdict*enum

Classification of the email's validity status

ValidRiskyInvalid

score*number

This number from 0 to 1 represents the likelihood the email address is valid, expressed as a percentage.

Example: 0.98015

suggestionstring

A corrected domain, if a possible typo is detected.

Example: "gmail.com"

localstring

The first part of the email address (before the @ sign)

Example: "jan.jongboom"

hoststring

The second part of the email address (after the @ sign)

Example: "edgeimpulse.com"

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/emails/validate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "email": "text",
  "verdict": "Valid",
  "score": 0.98015,
  "suggestion": "gmail.com",
  "local": "jan.jongboom",
  "host": "edgeimpulse.com"
}