跳到内容
Esc
↑↓导航↵打开⌘J预览

Retrieve a verification

GET/verifications/{id}
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
idstring<uuid>必填
响应
200

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

objectstring必填
允许值:verification
idstring<uuid>必填
statusstring必填

queued, submitted (being verified), completed or failed

允许值:queuedsubmittedcompletedfailed
failure_reasonstring | null必填

Why a failed run failed; nothing is billed for it

允许值:timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednull
totalinteger必填

Contacts in the run

countsobject | null必填

Results by verdict once the run completed

billableinteger | null必填

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

grant_usedinteger | null必填

Of billable, covered by the free credit

meteredinteger | null必填

Of billable, billed on the monthly invoice

created_atstring必填
finished_atstring | null必填
401

Missing, malformed, unknown or revoked API key

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
429

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

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/verifications/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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"
}

这个页面有帮助吗?