Verify a bulk validation list

The verification of the bulk validation list can be initiated using this endpoint. You can initiate verification once the progress of the list is ‘ready’ for verification, also the auto_verify was not enabled. After initiating verification you can examine the progress of the email list, once the verification of the list turns to ‘completed’ you can download your results.

Response

JSON

HTTP/1.1 200 OK
{
    "job_id": "pb49raml26hlkyuaykopl6wtg58k6vssq5t0w",
    "success": true,
    "message": "Job verification will be attempted shortly. Call /status endpoint to know the status of the Job"
}

Response parameters

Parameter	Type	Definition
"job_id"	[string]	The job_id corresponding to the list you need to start verification
"success"	[true, false]	Whether the API request call was successful or not.
"message"	[string]	Describes the start result

🚧

Verification cannot stop

The bulk validation email list can initiate verification only once. Once verification started, not able to stop, pause, or cancel the on-going verification. Also the verification cannot restart again for the same list.

Other Responses

The response you get when the API key is invalid:

JSON

HTTP/1.1 401 Unauthorized
{   
   "result":"Invalid API Key",
   "success": false
}

The response you get when you provide invalid job_id:

JSON

HTTP/1.1 400 BadRequest
{
    "result": "Job not found. Invalid jobId",
    "success": false
}

The response you get when you account is under review or restricted:

JSON

HTTP/1.1 400 BadRequest
{
    "result": "Verify restricted",
    "success": false
}

The response you get when the verification already started:

JSON

HTTP/1.1 400 BadRequest
{
    "result": "Verification has already started.",
    "success": false
}

The response you get when you have insufficient credit to begin verification:

JSON

HTTP/1.1 HTTP/1.1 402 Payment Required
{
    "result": "Insufficient verification credits. Please order a plan.",
    "success": false
}

The response you get when the job not found:

JSON

HTTP/1.1 400 BadRequest
{
    "result": "Job not found.",
    "success": false
}

The response you get when then job is preparing for verification:

JSON

HTTP/1.1 400 BadRequest
{
    "result": "Job is not ready for verification, please call the /status endpoint and start verification once the status of the job turns to ready.",
    "success": false
}