/v1/bulk

This endpoint is available starting from Reacher v0.10.

/v1/bulk

Initiate a bulk email verification.

POSThttps://api.reacher.email/v1/bulk

Body

application/json

input*array of string

A list of emails to verify.

webhookTaskWebhook

Optional webhook configuration for sending email verification results during bulk verification.

Response

200

OK

Body

application/json

job_id*integer

The unique ID generated for this bulk verification job. Use this job_id to query the progress or results of the bulk verification.

Request

JavaScriptCurlPython

const response = await fetch('https://api.reacher.email/v1/bulk', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "input": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

{
  "job_id": 0
}

/v1/bulk/{job_id}

Retrieve the progress of a bulk verification job.

GEThttps://api.reacher.email/v1/bulk/{job_id}

Path parameters

job_id*integer

The unique bulk verification job ID

Response

200

OK

Body

application/json

job_id*integer

created_at*string (date-time)

The date and time when the bulk verification job was created.

finished_atstring (date-time)

If the bulk verification job is completed, the date and time when it was finished.

total_records*integer

The number of emails to verify in the bulk verification job.

total_processed*integer

The number of emails that have been verified at the time of the query.

summary*object

A summary of the processed emails.

job_status*enum

The status of the job, either "Running" or "Completed".

RunningCompleted

Request

JavaScriptCurlPython

const response = await fetch('https://api.reacher.email/v1/bulk/{job_id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "job_id": 0,
  "created_at": "2024-12-03T11:34:56.278Z",
  "finished_at": "2024-12-03T11:34:56.278Z",
  "total_records": 0,
  "total_processed": 0,
  "summary": {
    "total_safe": 0,
    "total_invalid": 0,
    "total_risky": 0,
    "total_unknown": 0
  },
  "job_status": "Running"
}

Retrieve bulk verification results

Retrieve the results of a bulk verification job. This endpoint will return an error if the job is still running. Please query GET /v1/bulk/{job_id} first to check the job's progress.

GEThttps://api.reacher.email/v1/bulk/{job_id}/results

Path parameters

job_id*string

The unique bulk verification job ID

Query parameters

Response

200

OK

Body

application/json

results*CheckEmailOutput

The result of the email verification process.

Request

JavaScriptCurlPython

const response = await fetch('https://api.reacher.email/v1/bulk/{job_id}/results', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "results": {
    "input": "[e-mail]",
    "is_reachable": "invalid",
    "misc": {
      "is_disposable": false,
      "is_role_account": false,
      "gravatar_url": "text"
    },
    "mx": {
      "accepts_mail": false,
      "records": [
        "text"
      ]
    },
    "smtp": {
      "can_connect_smtp": false,
      "has_full_inbox": false,
      "is_catch_all": false,
      "is_deliverable": false,
      "is_disabled": false
    },
    "syntax": {
      "domain": "text",
      "is_valid_syntax": false,
      "username": "text"
    },
    "debug": {
      "start_time": "text",
      "end_time": "text",
      "duration": {
        "secs": 0,
        "nanos": 0
      },
      "server_name": "text",
      "smtp": {
        "verif_method": {
          "type": "Smtp"
        }
      }
    }
  }
}