Email Verification

API Explorer (2.0.0)

The entire API V2 documentation is interactive and can be tested here. To the right side of every endpoint you will see a box with an example request. You can click on the "Try it" button to send a request to the server right from the docs. You will need to provide an API key by clicking the ApiKeyAuth_token blue text.

Languages
Servers
Instantly API Server

https://api.instantly.ai/

Mock server

https://developer.instantly.ai/_mock/api/v2/

Analytics

Endpoints related to analytics

Operations

Account

An email account that can be used to send campaigns

Operations

Campaign

A campaign that can be sent to a list of recipients

Operations

Email

A campaign email, a reply, a manually sent email, or any other email that's visible in the Unibox

Operations

Email Verification

A single email verification

Operations

Email Verification

A single email verification

emailstringrequired

The email address to verify

Example: "example@example.com"
verification_statusstringread-onlyrequired

The verification status.

Enum ValueDescription
pending

The verification is pending

verified

The verification is verified

invalid

The verification is invalid

Example: "pending"
statusnull or stringread-only

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

Enum ValueDescription
success

The verification was successful

error

The verification was unsuccessful

Example: "success"
catch_allboolean or stringread-only

Whether this is a catch-all email address

Enum ValueDescription
false

The email is not a catch-all

true

The email is a catch-all

pending

The catch-all status is pending

Example: true
creditsnull or numberread-only

The number of verification credits available after the verification

Example: 100
credits_usednull or numberread-only

The number of verification credits used

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

Create email verification

Request

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

Bodyapplication/jsonrequired

The Email Verification to create

emailstringrequired

The email address to verify

Example: "example@example.com"
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: "https://example.com/webhook"
curl -i -X POST \
  https://api.instantly.ai/api/v2/email-verification \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "example@example.com"
  }'

Responses

The Email Verification

Bodyapplication/json
emailstringrequired

The email address to verify

Example: "example@example.com"
verification_statusstringread-onlyrequired

The verification status.

Enum ValueDescription
pending

The verification is pending

verified

The verification is verified

invalid

The verification is invalid

Example: "pending"
statusnull or stringread-only

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

Enum ValueDescription
success

The verification was successful

error

The verification was unsuccessful

Example: "success"
catch_allboolean or stringread-only

Whether this is a catch-all email address

Enum ValueDescription
false

The email is not a catch-all

true

The email is a catch-all

pending

The catch-all status is pending

Example: true
creditsnull or numberread-only

The number of verification credits available after the verification

Example: 100
credits_usednull or numberread-only

The number of verification credits used

Example: 1
Response
application/json
{
  "status": "success",
  "email": "example@example.com",
  "verification_status": "pending",
  "catch_all": true,
  "credits": 100,
  "credits_used": 1
}

Check an email verification status

Request

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

Path
emailstring(email)required

The email address to verify

Example: user@example.com
curl -i -X GET \
  https://api.instantly.ai/api/v2/email-verification/user@example.com \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The requested Email Verification

Bodyapplication/json
emailstringrequired

The email address to verify

Example: "example@example.com"
verification_statusstringread-onlyrequired

The verification status.

Enum ValueDescription
pending

The verification is pending

verified

The verification is verified

invalid

The verification is invalid

Example: "pending"
statusnull or stringread-only

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

Enum ValueDescription
success

The verification was successful

error

The verification was unsuccessful

Example: "success"
catch_allboolean or stringread-only

Whether this is a catch-all email address

Enum ValueDescription
false

The email is not a catch-all

true

The email is a catch-all

pending

The catch-all status is pending

Example: true
creditsnull or numberread-only

The number of verification credits available after the verification

Example: 100
credits_usednull or numberread-only

The number of verification credits used

Example: 1
Response
application/json
{
  "status": "success",
  "email": "example@example.com",
  "verification_status": "pending",
  "catch_all": true,
  "credits": 100,
  "credits_used": 1
}

Lead List

A list used to store leads

Operations

Inbox Placement Test

An inbox placement test

Operations

Inbox Placement Analytics

Analytics data for individual emails in inbox placement tests

Operations

Inbox Placement Blacklist & SpamAssassin Report

Report data for an inbox placement test

Operations

API Key

API Key

Operations

Account Campaign Mapping

Account Campaign Mapping

Operations

Lead

A lead entity representing an individual lead

Operations

Background Job

A background job that can be used to perform long-running tasks

Operations

Custom Tag

A custom tag for organizing and categorizing accounts and campaigns. You can use them as filters in apis that list accounts and campaigns.

Operations

Block List Entry

A blocked email or domain

Operations

Lead Label

A custom label for categorizing and managing leads

Operations

Workspace

A workspace entity representing a workspace

Operations

Workspace Group Member

A member of a workspace group. You can use the endpoints within this entity to manage the members of a workspace group.

Operations

Workspace Member

A member of a workspace with associated user details

Operations

Campaign Subsequence

A subsequence entity representing a follow-up sequence

Operations

Audit Log

Audit log records for tracking system activities

Operations

Schemas