Check a toll-free messaging programme

Runs the programme half of toll-free verification over the same profile: use case and its summary, monthly volume against what the opt-in can support, sample messages, and the opt-in evidence URL — which is the single most common cause of a toll-free rejection.

Checks are free and unlimited and never consume allowance. Pass the subject as a stored-resource reference OR as an inline payload — never both for the same subject. With options.wait: true the connection is held until the verdict is ready; otherwise a fast check arrives already passed/changes_required and a slow one arrives processing for polling. options.include_website_review triggers a real crawl and is subject to a per-account daily quota.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The same toll-free profile, judged on its messaging programme rather than its identity — use case, volume, samples, and opt-in evidence.

string
tfn_profile
object

Inline TFN profile payload for checks and registrations. brand_id is omitted when paired with an inline brand; missing or non-compliant fields surface as findings.

options
object

Shared per-check switches.

metadata
object

Free-form string map (≤50 keys, values ≤500 chars). Filterable on list endpoints.

Headers
string
length ≤ 255

Any unique string (e.g. a UUID). Retries with the same key within 24h return the original response with Idempotent-Replayed: true. Same key + different body → 409.

string

Scope this request (and the created resource) to a subaccount.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json