Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List verifications

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.

GET/verifications
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Responses
200

The team's verification runs, newest first

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
objectstringrequired
Allowed:verification
idstring<uuid>required
statusstringrequired

queued, submitted (being verified), completed or failed

Allowed:queuedsubmittedcompletedfailed
failure_reasonstring | nullrequired

Why a failed run failed; nothing is billed for it

Allowed:timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednull
totalintegerrequired

Contacts in the run

countsobject | nullrequired

Results by verdict once the run completed

billableinteger | nullrequired

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

grant_usedinteger | nullrequired

Of billable, covered by the free credit

meteredinteger | nullrequired

Of billable, billed on the monthly invoice

created_atstringrequired
finished_atstring | nullrequired
has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/verifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "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"
    }
  ],
  "has_more": true
}

Was this page helpful?