Bulk Verification

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

Verify list of emails

POST https://app.truemail.io/api/v1/tasks/bulk?access_token={api_key}

This endpoint enables you to create a new task and begin bulk verify.

Query Parameters

Name	Type	Description
access_token	string	Application api token.

Request Body

Name	Type	Description
filename	string	File name.
file	object	File must contain property 'data' as array of objects which must consist of email and other properties.

200 Verify succe

{
  "status": "Success",
  "task_id": 199
}

Get bulk verify status

GET https://app.truemail.io/api/v1/tasks/{task_id}/status?access_token={api_key}

This endpoint allows you to create new task and start bulk verify.

Path Parameters

Name	Type	Description
task_id	number	Task id received from verify list of emails.

Query Parameters

Name	Type	Description
access_token	string	Application api token.

200 Task successfully verified.

{
  "status": "finished",
  "total": 9,
  "billable": 2,
  "valid": 1,
  "invalid": 1,
  "catchall": 0,
  "disposable": 0,
  "unknown": 0,
  "duplicates": 7
}

Download bulk verify result

GET https://app.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.

Path Parameters

Name	Type	Description
task_id	number	Task id received from verify list of emails.

Query Parameters

Name	Type	Description
access_token	string	Application api token.
unknowns	number	Include results with status 'unknown'.
disposables	number	Include results with status 'disposable'.
catchalls	number	Include results with status 'catchall'.
invalids	number	Include results with status 'invalid'.
valids	number	Include results with status 'valid'.

200 Task verify result.

"[e-mail]","Jonh Doe",valid
"[e-mail]","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.