Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

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
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Query-Parameter
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.

Antworten
200

The team's verification runs, newest first

objectstringerforderlich
Erlaubt:list
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
objectstringerforderlich
Erlaubt:verification
idstring<uuid>erforderlich
statusstringerforderlich

queued, submitted (being verified), completed or failed

Erlaubt:queuedsubmittedcompletedfailed
failure_reasonstring | nullerforderlich

Why a failed run failed; nothing is billed for it

Erlaubt:timeoutprovider_failedprovider_rejectedresults_unreadablesubmit_failednull
totalintegererforderlich

Contacts in the run

countsobject | nullerforderlich

Results by verdict once the run completed

billableinteger | nullerforderlich

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

grant_usedinteger | nullerforderlich

Of billable, covered by the free credit

meteredinteger | nullerforderlich

Of billable, billed on the monthly invoice

created_atstringerforderlich
finished_atstring | nullerforderlich
has_morebooleanerforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/verifications' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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
}

War diese Seite hilfreich?