Build your own integration

Use the REST API with Go and TypeScript SDKs to check addresses, run list jobs, and receive webhooks.

SDKsGoTypeScript

Fig. 1POST /v1/check_email

$ curl -X POST "$API_URL/v1/check_email" \    -H "Authorization: Bearer $API_KEY" \    -d '{ "to_email": "[email protected]" }'{  "is_reachable": "safe",  "score": {    "score": 100,    "category": "valid",    "safe_to_send": true,    "reason_codes": ["deliverable"]  }}

Request and response · values from a sample check

Style: REST, JSON
SDKs: Go and TypeScript
Webhooks: task.completed
Plans: Professional and Enterprise

§ 1

Why it matters

Your data lives in your own systems

Some teams need checks inside their own product, warehouse, or sync job.

Connect checks to any system you own.

Fig. 2Without and with Verifier

WithoutWith Verifier

Without: Checks run by hand in a separate tool.With Verifier: Check addresses and lists from your own code.
Without: Your system polls for finished jobs.With Verifier: A task.completed webhook tells you when a job is done.
Without: Each team writes its own HTTP client.With Verifier: Typed SDKs for Go and TypeScript.

§ 2

How it works

Documented endpoints and generated clients

Call the API with a scoped key. Use the Go or TypeScript SDK, or any HTTP client.

2.1Create an API key.
2.2Install the Go or TypeScript SDK.
2.3Check addresses, run jobs, and handle webhooks.

Fig. 3One check from your code

TypeScript

import { Configuration, V1Api } from "@oppulence/reacher-sdk";const api = new V1Api(  new Configuration({    basePath: process.env.VERIFIER_API_URL,    apiKey: `Bearer ${process.env.VERIFIER_API_KEY}`,  }),);const { data } = await api.v1CheckEmail({  checkEmailRequest: { to_email: "[email protected]" },});if (!data.score.safe_to_send) {  // Ask the person to check the address.}

cfg := reacher.NewConfiguration()cfg.Servers = reacher.ServerConfigurations{{URL: os.Getenv("VERIFIER_API_URL")}}cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("VERIFIER_API_KEY"))client := reacher.NewAPIClient(cfg)out, _, err := client.V1API.V1CheckEmail(ctx).	CheckEmailRequest(*reacher.NewCheckEmailRequest("[email protected]")).	Execute()

Generated SDKs · same call in each language

§ 3

What you get

What you get.

3.1WebhooksGet results when a job finishes.
3.2Delivery events inSend delivery events from any platform through the outcomes API.

Table 3 · Endpoints you will use most

Method	Path	What it does
POST	/v1/check_email	Check one address.
POST	/v1/lists	Upload a list for checking.
GET	/v1/lists/{list_id}/quality	Read the quality of a list.
POST	/v1/lists/{list_id}/remediation-exports	Export the files to keep, fix, review, or drop.
GET	/v1/suppressions/check	Ask if an address is suppressed.
POST	/v1/outcomes	Send delivery events from any platform.
GET	/v1/emails/{email}/history	Read every result for one address.

§ 4

In practice

Typical uses.

Case 4.1
Nightly sync
Check new CRM contacts every night with a scheduled job.

Other integrations.

All integrations

Questions

Before you start.

Which plans include the API?

The Professional and Enterprise plans.

$ curl -X POST "$API_URL/v1/check_email" \ -H "Authorization: Bearer $API_KEY" \ -d '{ "to_email": "[email protected]" }'{ "is_reachable": "safe", "score": { "score": 100, "category": "valid", "safe_to_send": true, "reason_codes": ["deliverable"] }}

Your data lives in your own systems

Some teams need checks inside their own product, warehouse, or sync job.

Connect checks to any system you own.

Fig. 2Without and with Verifier

WithoutWith Verifier

Without: Checks run by hand in a separate tool.With Verifier: Check addresses and lists from your own code.
Without: Your system polls for finished jobs.With Verifier: A task.completed webhook tells you when a job is done.
Without: Each team writes its own HTTP client.With Verifier: Typed SDKs for Go and TypeScript.

Documented endpoints and generated clients

Call the API with a scoped key. Use the Go or TypeScript SDK, or any HTTP client.

2.1Create an API key.
2.2Install the Go or TypeScript SDK.
2.3Check addresses, run jobs, and handle webhooks.

Fig. 3One check from your code

TypeScript

import { Configuration, V1Api } from "@oppulence/reacher-sdk";const api = new V1Api(  new Configuration({    basePath: process.env.VERIFIER_API_URL,    apiKey: `Bearer ${process.env.VERIFIER_API_KEY}`,  }),);const { data } = await api.v1CheckEmail({  checkEmailRequest: { to_email: "[email protected]" },});if (!data.score.safe_to_send) {  // Ask the person to check the address.}

cfg := reacher.NewConfiguration()cfg.Servers = reacher.ServerConfigurations{{URL: os.Getenv("VERIFIER_API_URL")}}cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("VERIFIER_API_KEY"))client := reacher.NewAPIClient(cfg)out, _, err := client.V1API.V1CheckEmail(ctx).	CheckEmailRequest(*reacher.NewCheckEmailRequest("[email protected]")).	Execute()

Generated SDKs · same call in each language

What you get.

3.1WebhooksGet results when a job finishes.

3.2Delivery events inSend delivery events from any platform through the outcomes API.

Table 3 · Endpoints you will use most

Method	Path	What it does
POST	/v1/check_email	Check one address.
POST	/v1/lists	Upload a list for checking.
GET	/v1/lists/{list_id}/quality	Read the quality of a list.
POST	/v1/lists/{list_id}/remediation-exports	Export the files to keep, fix, review, or drop.
GET	/v1/suppressions/check	Ask if an address is suppressed.
POST	/v1/outcomes	Send delivery events from any platform.
GET	/v1/emails/{email}/history	Read every result for one address.

From a raw listto a safe send.

Build your own integration

Your data lives in your own systems

Documented endpoints and generated clients

What you get.

Typical uses.

Other integrations.

Before you start.

From a raw listto a safe send.

Build your own integration

Your data lives in your own systems

Documented endpoints and generated clients

What you get.

Typical uses.

Other integrations.

Before you start.