Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Cuerpo de la solicitud
obligatorioapplication/json
targetVerificationTargetobligatorio
Mostrar propiedades
Exactamente uno de:
object
kindstringobligatorio
Valores permitidos:contacts
contact_idsstring<uuid>[]obligatorio

Contacts of the team, by id

mín. 1 elementos · máx. 50000 elementos
object
kindstringobligatorio
Valores permitidos:segment
segment_idstring<uuid>obligatorio

Every contact in this segment

object
kindstringobligatorio
Valores permitidos:broadcast
broadcast_idstring<uuid>obligatorio

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

Respuestas
200

The runs started

objectstringobligatorio
Valores permitidos:verification_start
runsobject[]obligatorio

The runs started, one per 50,000 contacts

Mostrar propiedades
Array de object
idstring<uuid>obligatorio
totalintegerobligatorio
contactsintegerobligatorio

Contacts that joined a run

already_verifiedintegerobligatorio

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

in_runintegerobligatorio

Contacts skipped because a run already holds them

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
403

The team is on the Free plan (plan_limit_reached)

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
503

Deep verification is not available right now

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Cuerpoapplication/json
Solicitud
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
}'
Respuesta
{
  "object": "verification_start",
  "runs": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "total": 0
    }
  ],
  "contacts": 0,
  "already_verified": 0,
  "in_run": 0
}

¿Te ha resultado útil esta página?