Check a toll-free profile

Runs the identity half of toll-free verification: who the business is, the contact a verifier can reach, and the website that substantiates it. The messaging programme on the profile — use case, samples, opt-in evidence — is judged by POST /checks/tfn/campaign, because the two halves fail for different reasons and are worth fixing separately.

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 toll-free profile, as a stored reference or an inline payload. Pass the brand as well when the profile is inline and its identity fields live on the brand.

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.

string
brand
object

Inline brand payload for checks and registrations. Partial payloads are welcome — the marketed minimum is ein + website — and anything missing or non-compliant surfaces as findings, not validation errors.

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