Skip to main content
GET
cURL
Guide: Sending codes for an application

Authorizations

Authorization
string
header
required

Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.

Query Parameters

application
string

Your external_id: only that application. An id that is not yours answers 404 not_found.

status
string

One of pending, verified, failed, expired, canceled; pending and expired are read by the clock, as GET /v1/verify/{id} reads them.

mode
string

The mode of the key that sent the code: partner for your key.

reference
string

Your own reference, exactly.

from
string

Only rows created at or after this ISO 8601 date or datetime.

to
string

Only rows created at or before this ISO 8601 date or datetime.

cursor
string

The next_cursor of the previous page: the rows after it.

limit
integer

Page size, 1 to 100; 50 when omitted.

Response

A page of verifications

data
object[]
next_cursor
string
has_more
boolean