Retrieve a verification
GET
/verifications/{id}Autorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Pfadparameter
idstring<uuid>erforderlichAntworten
200
One verification run: its status, and its results once completed
objectstringerforderlichErlaubt:
verificationidstring<uuid>erforderlichstatusstringerforderlichqueued, submitted (being verified), completed or failed
Erlaubt:
queuedsubmittedcompletedfailedfailure_reasonstring | nullerforderlichWhy a failed run failed; nothing is billed for it
Erlaubt:
timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednulltotalintegererforderlichContacts in the run
countsobject | nullerforderlichResults by verdict once the run completed
billableinteger | nullerforderlichAddresses with a definite verdict, which is what is billed (unknown is free)
grant_usedinteger | nullerforderlichOf billable, covered by the free credit
meteredinteger | nullerforderlichOf billable, billed on the monthly invoice
created_atstringerforderlichfinished_atstring | nullerforderlich401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich404
Not found
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich422
Validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich