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

Retrieve a verification

GET/verifications/{id}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Réponses
200

One verification run: its status, and its results once completed

objectstringrequis
Valeurs autorisées :verification
idstring<uuid>requis
statusstringrequis

queued, submitted (being verified), completed or failed

Valeurs autorisées :queuedsubmittedcompletedfailed
failure_reasonstring | nullrequis

Why a failed run failed; nothing is billed for it

Valeurs autorisées :timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednull
totalintegerrequis

Contacts in the run

countsobject | nullrequis

Results by verdict once the run completed

billableinteger | nullrequis

Addresses with a definite verdict, which is what is billed (unknown is free)

grant_usedinteger | nullrequis

Of billable, covered by the free credit

meteredinteger | nullrequis

Of billable, billed on the monthly invoice

created_atstringrequis
finished_atstring | nullrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X GET 'https://api.billionsend.com/verifications/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "verification",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "queued",
  "failure_reason": "timeout",
  "total": 0,
  "counts": {
    "property1": 0,
    "property2": 0
  },
  "billable": 0,
  "grant_used": 0,
  "metered": 0,
  "created_at": "string",
  "finished_at": "string"
}

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