Sign in

v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
EmailVerification

Create email verification

If an email takes longer than 10 seconds to verify, the endpoint will return the status as pending. In that case, you may use the /email-verification/:email endpoint to check the status of the verification job.

Alternatively, you can send a webhook_url to receive the results instead of polling the status endpoint.

Requires one of the following scopes: email_verifications:create

Requires one of the following scopes: email_verifications:create, email_verifications:all, all:create, all:all

post/api/v2/email-verification

Request body

emailstring required

The email address to verify

webhook_urlstring

A webhook URL to receive the verification results. If the email verification takes more than 10 seconds we will send the results to this URL.

Example request

{
  "email": "example@example.com",
  "webhook_url": "https://example.com/webhook"
}

Response

The Email Verification

status'success' | 'error' nullable

The request status. Do not use this field to determine the verification status. Please use verification_status instead to check the verification status

emailstring required

The email address to verify

verification_status'pending' | 'verified' | 'invalid' required

The verification status.

creditsnumber nullable

The number of verification credits available after the verification

credits_usednumber nullable

The number of verification credits used

Example response

{
  "status": "success",
  "email": "example@example.com",
  "verification_status": "pending",
  "credits": 100,
  "credits_used": 1
}