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.
/verificationsAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
application/jsontargetVerificationTargetobrigatórioMostrar propriedadesOcultar propriedades
kindstringobrigatóriocontactscontact_idsstring<uuid>[]obrigatórioContacts of the team, by id
kindstringobrigatóriosegmentsegment_idstring<uuid>obrigatórioEvery contact in this segment
kindstringobrigatóriobroadcastbroadcast_idstring<uuid>obrigatórioThe 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
objectstringobrigatórioverification_startrunsobject[]obrigatórioThe runs started, one per 50,000 contacts
Mostrar propriedadesOcultar propriedades
objectidstring<uuid>obrigatóriototalintegerobrigatóriocontactsintegerobrigatórioContacts that joined a run
already_verifiedintegerobrigatórioContacts skipped because they were verified before (pass recheck to include them)
in_runintegerobrigatórioContacts skipped because a run already holds them
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioThe team is on the Free plan (plan_limit_reached)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioThe segment or broadcast is not one of the team's
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioNothing left to verify, too many contacts at once, or a validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioDeep verification is not available right now
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório