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 · headererforderlichA BillionSend API key (bs_…).
application/jsontargetVerificationTargeterforderlichEigenschaften anzeigenEigenschaften ausblenden
kindstringerforderlichcontactscontact_idsstring<uuid>[]erforderlichContacts of the team, by id
kindstringerforderlichsegmentsegment_idstring<uuid>erforderlichEvery contact in this segment
kindstringerforderlichbroadcastbroadcast_idstring<uuid>erforderlichThe 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
objectstringerforderlichverification_startrunsobject[]erforderlichThe runs started, one per 50,000 contacts
Eigenschaften anzeigenEigenschaften ausblenden
objectidstring<uuid>erforderlichtotalintegererforderlichcontactsintegererforderlichContacts that joined a run
already_verifiedintegererforderlichContacts skipped because they were verified before (pass recheck to include them)
in_runintegererforderlichContacts skipped because a run already holds them
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichThe team is on the Free plan (plan_limit_reached)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichThe segment or broadcast is not one of the team's
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichNothing left to verify, too many contacts at once, or a validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlichDeep verification is not available right now
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich