Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Start a verification

Starts deep verification of the target’s contacts, one run per 50,000 of them. Contacts verified before are skipped unless recheck is true, and a contact already being verified never joins a second run. Paid plans only; billed per verified address on the monthly invoice.

POST/verifications
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Request body
requiredapplication/json
targetVerificationTargetrequired
Show properties
One of:
object
kindstringrequired
Allowed:contacts
contact_idsstring<uuid>[]required

Contacts of the team, by id

min items 1 · max items 50000
object
kindstringrequired
Allowed:segment
segment_idstring<uuid>required

Every contact in this segment

object
kindstringrequired
Allowed:broadcast
broadcast_idstring<uuid>required

The broadcast's audience: the contacts it would mail, leaving out everyone who unsubscribed

recheckboolean

Verify contacts verified before too; by default they are skipped

Responses
200

The runs started

objectstringrequired
Allowed:verification_start
runsobject[]required

The runs started, one per 50,000 contacts

Show properties
Array of object
idstring<uuid>required
totalintegerrequired
contactsintegerrequired

Contacts that joined a run

already_verifiedintegerrequired

Contacts skipped because they were verified before (pass recheck to include them)

in_runintegerrequired

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

The team is on the Free plan (plan_limit_reached)

statusCodenumberrequired
namestringrequired
messagestringrequired
404

The segment or broadcast is not one of the team's

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Nothing left to verify, too many contacts at once, or a validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
503

Deep verification is not available right now

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.billionsend.com/verifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "target": {
    "kind": "contacts",
    "contact_ids": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  },
  "recheck": true
}'
Response
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

Was this page helpful?