EmailVerification

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.

post/api/emails/validate

Request

Base URL
https://studio.edgeimpulse.com/v1
Auth
none required
TypeScript
https://skmtc.dev/edgeimpulse/apis/edge-impulse-api/docs/api/emails/validate/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

emailstring required

E-mail address to validate

Example request

{
  "email": "jan@edgeimpulse.com"
}

Response

successboolean required

Whether the operation succeeded

errorstring

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

emailstring required

Email address that was checked.

verdict'Valid' | 'Risky' | 'Invalid' required

Classification of the email's validity status

scorenumber required

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

suggestionstring

A corrected domain, if a possible typo is detected.

localstring

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

hoststring

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

Example response

{
  "score": 0.98015,
  "suggestion": "gmail.com",
  "local": "jan.jongboom",
  "host": "edgeimpulse.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.