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.
/verificationsAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
application/jsontargetVerificationTargetrequiredShow propertiesHide properties
kindstringrequiredcontactscontact_idsstring<uuid>[]requiredContacts of the team, by id
kindstringrequiredsegmentsegment_idstring<uuid>requiredEvery contact in this segment
kindstringrequiredbroadcastbroadcast_idstring<uuid>requiredThe broadcast's audience: the contacts it would mail, leaving out everyone who unsubscribed
recheckbooleanVerify contacts verified before too; by default they are skipped
The runs started
objectstringrequiredverification_startrunsobject[]requiredThe runs started, one per 50,000 contacts
Show propertiesHide properties
objectidstring<uuid>requiredtotalintegerrequiredcontactsintegerrequiredContacts that joined a run
already_verifiedintegerrequiredContacts skipped because they were verified before (pass recheck to include them)
in_runintegerrequiredContacts skipped because a run already holds them
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredThe team is on the Free plan (plan_limit_reached)
statusCodenumberrequirednamestringrequiredmessagestringrequiredThe segment or broadcast is not one of the team's
statusCodenumberrequirednamestringrequiredmessagestringrequiredNothing left to verify, too many contacts at once, or a validation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequiredDeep verification is not available right now
statusCodenumberrequirednamestringrequiredmessagestringrequired