Estimate a verification
How many of the target’s contacts were never verified and what verifying them would cost. Changes nothing.
/verifications/estimateAuthorizationBearer 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
The counts and the estimated cost
objectstringrequiredverification_estimatetotalintegerrequiredContacts the target names
unverifiedintegerrequiredOf them, never verified: what a start would verify (verified ones are skipped)
in_runintegerrequiredOf the unverified, already being verified
grant_remainingintegerrequiredFree verification credit left this quota month, which a run uses first
estimated_centsintegerrequiredWhat verifying the unverified would cost past the credit, in cents
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredThe segment or broadcast is not one of the team's
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired