Retrieve a verification
GET
/verifications/{id}Autorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
idstring<uuid>obrigatórioRespostas
200
One verification run: its status, and its results once completed
objectstringobrigatórioValores permitidos:
verificationidstring<uuid>obrigatóriostatusstringobrigatórioqueued, submitted (being verified), completed or failed
Valores permitidos:
queuedsubmittedcompletedfailedfailure_reasonstring | nullobrigatórioWhy a failed run failed; nothing is billed for it
Valores permitidos:
timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednulltotalintegerobrigatórioContacts in the run
countsobject | nullobrigatórioResults by verdict once the run completed
billableinteger | nullobrigatórioAddresses with a definite verdict, which is what is billed (unknown is free)
grant_usedinteger | nullobrigatórioOf billable, covered by the free credit
meteredinteger | nullobrigatórioOf billable, billed on the monthly invoice
created_atstringobrigatóriofinished_atstring | nullobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório