Bulk Verification

With the TrueMail API, you can verify contact lists you already have without needing to upload them to the dashboard.

post
Verify list of emails
https://truemail.io/api/v1/tasks/bulk?access_token={api_key}
This endpoint enables you to create a new task and begin bulk verify.
Request
Response
Request
Query Parameters
access_token
required
string
Application api token.
Form Data Parameters
filename
optional
string
File name.
file
required
object
File must contain property 'data' as array of objects which must consist of email and other properties.
Response
200: OK
Verify succe
{
  "status": "Success",
  "task_id": 199
}
​
get
Get bulk verify status
https://truemail.io/api/v1/tasks/{task_id}/status?access_token={api_key}
This endpoint allows you to create new task and start bulk verify.
Request
Response
Request
Path Parameters
task_id
required
number
Task id received from verify list of emails.
Query Parameters
access_token
required
string
Application api token.
Response
200: OK
Task successfully verified.
{
  "status": "finished",
  "total": 9,
  "billable": 2,
  "valid": 1,
  "invalid": 1,
  "catchall": 0,
  "disposable": 0,
  "unknown": 0,
  "duplicates": 7
}
get
Download bulk verify result
https://truemail.io/api/v1/tasks/{task_id}/download?access_token={api_key}
This is how you can download your file. You'll receive the data back in a CSV format with the last column including the result codes.
Request
Response
Request
Path Parameters
task_id
required
number
Task id received from verify list of emails.
Query Parameters
access_token
required
string
Application api token.
unknowns
optional
number
Include results with status 'unknown'.
disposables
optional
number
Include results with status 'disposable'.
catchalls
optional
number
Include results with status 'catchall'.
invalids
optional
number
Include results with status 'invalid'.
valids
optional
number
Include results with status 'valid'.
Response
200: OK
Task verify result.
"[email protected]","Jonh Doe",valid
"[email protected]","Jonh Doe",invalid
Read more about the result statuses here.
Job Status
Job status indicates what step the job is currently in. This will be the primary property you'll want to check to determine what can be done with the job.
Status
Description
Not processed
The job has not yet run and is waiting to be started.
Processing
The job is currently either running a sample or full verification.
Finished
The job has completed verification and the results are ready for download.
Failed
The job failed, typically this is due to poorly formatted data.
Totals
There are several items in the total object that give you an overview of verification results. These numbers are updated periodically during the verification process. Most of these properties correspond directly with the verification result codes; the other properties are explained below.
Property
Description
records
The number of rows we found in your file. This may include whitespace, empty rows, and other rows that don't contain syntactically correct emails.
billable
The number of rows we found syntactically correct emails in. This is number of credits processing this job will consume.
processed
The total number of emails that have been processed so far.
duplicates
The number of rows that contain duplicated emails. This is not the number of unique duplicates but the total of every instance.
bad_syntax
The number of records that do not contain data that looks like an email. This may include whitespace and empty rows as well as bad data.

Single Verification

JavaScript Widget

Last updated 4 months ago

Status	Description
Not processed	The job has not yet run and is waiting to be started.
Processing	The job is currently either running a sample or full verification.
Finished	The job has completed verification and the results are ready for download.
Failed	The job failed, typically this is due to poorly formatted data.

Property	Description
records	The number of rows we found in your file. This may include whitespace, empty rows, and other rows that don't contain syntactically correct emails.
billable	The number of rows we found syntactically correct emails in. This is number of credits processing this job will consume.
processed	The total number of emails that have been processed so far.
duplicates	The number of rows that contain duplicated emails. This is not the number of unique duplicates but the total of every instance.
bad_syntax	The number of records that do not contain data that looks like an email. This may include whitespace and empty rows as well as bad data.

Bulk Verification

postVerify list of emails

getGet bulk verify status

getDownload bulk verify result

Job Status

Totals

post
Verify list of emails

get
Get bulk verify status

get
Download bulk verify result