TrueMail
TrueMail
Home
Api Keys
Help Center
System Status
Email Verification API
TrueMail API
Single Verification
Bulk Verification
JavaScript Widget
Powered by GitBook

Single Verification

Single verification let you verify single emails and catch additional information relate to the email.

Our API can be easily integrated into your signup or onboarding process with just one request.

Billing

Each verification performed over the Single endpoints cost 1 credit. Duplicate verifications requests and bad syntax data are included.

get
​

https://truemail.io/api/v1/verify/single?access_token={api_key}&email={email}
Request
Response
Request
Query Parameters
email
required
string
Email address to validate.
access_token
required
string
Application api token
address_info
optional
number
Include additional email information to response.
timeout
optional
number
Maximum time in seconds after which you get a response.
Response
200: OK
Email successfully verified.
{
  "status": "success",
  "result": "valid",
  "format": "valid",
  "server_status": "success",
  "email_id": 8354,
  "valid_dns_record": 1,
  "valid_mx_record": 1,
  "reachable_smtp_server": 1,
  "fqdn": "google.com",
  "type": "professional"
}
​

get
Get single verify status

https://truemail.io/api/v1/verify/status?access_token={api_key}&email_id={email_id}
This endpoint enables you to get a single verify status.
Request
Response
Request
Query Parameters
access_token
required
string
Application api token
email_id
required
number
Email id.
Response
200: OK
{
  "status": "success",
  "result": "valid",
  "format": "valid",
  "server_status": "success",
  "email_id": 8354,
  "valid_dns_record": 1,
  "valid_mx_record": 1,
  "reachable_smtp_server": 1,
  "fqdn": "google.com",
  "type": "professional"
}

The Timeout Parameter

The timeout parameter informs the API for how much time it needs to verify an email before giving up and coming back with an unknown result code. The total request time can exceed this timeout, as network latency is not taken into consideration. This can be helpful when verifying emails at the point of entry to prevent long wait times for your users.

Usage Guidelines

Please be sure to review our usage guidelines for the API here.

Handling Aliases

When verifying emails that contain aliases that use a + character extra consideration needs to be taken when encoding these for x-www-form-urlencoded content-types. Make sure this character is being encoded as %2B, as the + character is treated as a non-breaking space when the string is decoded.

Result Codes

The result property contains a string that correlates to a result codes listed in the table below. For detailed information about result codes visit our help center.

Result Code

Description

valid

Verified as real address

invalid

Verified as not valid

disposable

A temporary, disposable address

catchall

A domain wide-setting, also known as Accept-all

unknown

The server cannot be reached

​

​

Flags

The flags give you extra data that was found out about the domain during verification. Below is a list of common flags you can face.

Flag

Description

has_dns

The input has one or more DNS records associated with the hostname.

has_dns_mx

The input has mail exchanger DNS records configured.

bad_syntax

The input given doesn't appear to be an email.

disposable_email

The input given is a disposable email.

spelling_mistake

The input was misspelled

role_account

This email is a role-based email address

connect_fails

Unable to connect to remote host.

international_host

INT designated domain names.

accepts_all

Remote host accepts mail at any address.

contains_alias

The email address supplied contains an address part and an alias part.

acedemic_host

The input given is a acedemic email.

Previous
Usage Guidelines
Next
Bulk Verification
Last updated 2 months ago
Contents
Billing
get
Get single verify status
The Timeout Parameter
Result Codes
Flags