Add checks to your product

Check addresses in real time at signup, run list jobs, and get results by webhook. Use the REST API with Go and TypeScript SDKs.

Get started free Signup forms

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
Keys: Scoped, per workspace
Plans: Professional and Enterprise

§ 1

Why it matters

Bad addresses enter through your own forms

Typos and throwaway addresses at signup become bounces, fake accounts, and support tickets later.

Everything in the app is also available through the API.

Fig. 2Without and with Verifier

WithoutWith Verifier

Without: Signup forms accept any text with an @ sign.With Verifier: Check the address in the request that creates the account.
Without: Checks run by hand in a separate tool.With Verifier: Upload lists and read results from your own code.
Without: Each team writes its own HTTP client.With Verifier: Typed SDKs for Go and TypeScript.

§ 2

How it works

One call per address, one job per list

Call the check endpoint from your signup flow, or send a list as a job and get the results by webhook.

2.1Create an API key with the scopes you need.
2.2Call the API from your backend.
2.3Act on the category, the score, and the reason codes.

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.1Scoped API keysGive each key only the access it needs, and revoke it at any time.
3.2Safe retriesIdempotency keys stop a retried request from creating a second job.

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
Signup protection
Ask the user to fix a likely typo before the account is created.

Works with the tools you send from.

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"] }}

Bad addresses enter through your own forms

Typos and throwaway addresses at signup become bounces, fake accounts, and support tickets later.

Everything in the app is also available through the API.

Fig. 2Without and with Verifier

WithoutWith Verifier

Without: Signup forms accept any text with an @ sign.With Verifier: Check the address in the request that creates the account.
Without: Checks run by hand in a separate tool.With Verifier: Upload lists and read results from your own code.
Without: Each team writes its own HTTP client.With Verifier: Typed SDKs for Go and TypeScript.

One call per address, one job per list

Call the check endpoint from your signup flow, or send a list as a job and get the results by webhook.

2.1Create an API key with the scopes you need.
2.2Call the API from your backend.
2.3Act on the category, the score, and the reason codes.

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.1Scoped API keysGive each key only the access it needs, and revoke it at any time.

3.2Safe retriesIdempotency keys stop a retried request from creating a second job.

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.

Add checks to your product

Bad addresses enter through your own forms

One call per address, one job per list

What you get.

Typical uses.

Works with the tools you send from.

Before you start.

From a raw listto a safe send.

Add checks to your product

Bad addresses enter through your own forms

One call per address, one job per list

What you get.

Typical uses.

Works with the tools you send from.

Before you start.