Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

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
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Corps de la requête
requisapplication/json
targetVerificationTargetrequis
Afficher les propriétés
Exactement un de :
object
kindstringrequis
Valeurs autorisées :contacts
contact_idsstring<uuid>[]requis

Contacts of the team, by id

min 1 éléments · max 50000 éléments
object
kindstringrequis
Valeurs autorisées :segment
segment_idstring<uuid>requis

Every contact in this segment

object
kindstringrequis
Valeurs autorisées :broadcast
broadcast_idstring<uuid>requis

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

Réponses
200

The runs started

objectstringrequis
Valeurs autorisées :verification_start
runsobject[]requis

The runs started, one per 50,000 contacts

Afficher les propriétés
Tableau de object
idstring<uuid>requis
totalintegerrequis
contactsintegerrequis

Contacts that joined a run

already_verifiedintegerrequis

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

in_runintegerrequis

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

The team is on the Free plan (plan_limit_reached)

statusCodenumberrequis
namestringrequis
messagestringrequis
404

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

statusCodenumberrequis
namestringrequis
messagestringrequis
422

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

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
503

Deep verification is not available right now

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Corpsapplication/json
Requête
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
}'
Réponse
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

Cette page vous a-t-elle été utile ?