API Reference

Submit a TFN PreCheck [beta]

post
https://api.texter.id/v1/precheck/tfn

Creates a verification project for the TFN channel and kicks off precheck analysis. The OpenAPI spec lists every field this channel could accept as optional; the server validates the actual required-set at request time against the merged requirement schema resolved from (country, countryOfRegistration, analysisSteps).

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

ISO 3166-1 alpha-2 target country code for the project.

Allowed:
string
enum
required

ISO 3166-1 alpha-2 country code where the brand is registered.

Allowed:
analysisSteps
array of strings
required
length ≥ 1

Analysis steps to run on the project. Required; at least one step must be specified.

Available steps for this channel:

  • brand_background_check (Brand Background Check)
    Verifies the submitted EIN and business information align with public records. POC Name and Address may be included in the check.

  • brand_online_presence_check (Analyze Brand Online Presence)
    Analyze the brand's online presence to better understand business activities and support TM review.

  • poc_email_domain_check (POC Email Domain Verification)
    Verifies the POC email domain is a plausible business domain tied to the brand.
    Depends on step: brand_online_presence_check

  • privacy_policy_check (Privacy Policy Verification)
    Checks URL accessibility and suitability for an RCS message sender.
    Depends on step: brand_online_presence_check

  • terms_of_service_check (Terms of Service Verification)
    Checks URL accessibility and suitability for messaging terms.
    Depends on step: brand_online_presence_check

  • help_message_check (HELP Message Validation)
    Ensures HELP response describes purpose and opt-out clearly.
    Depends on step: brand_online_presence_check

  • opt_out_message_check (Opt-out Message Validation)
    Ensures opt-out message clearly stops messaging and is compliant.

  • opt_in_message_check (Opt-in Message Check)
    Verifies the opt-in confirmation message meets carrier requirements for consent acknowledgment.

  • use_case_consistency_check (Use Case Consistency Check)
    Verifies the declared use case is consistent across the use case summary, sample message, and supporting materials.

  • prohibited_use_case_check (Prohibited Use Case Check)
    Identifies prohibited or restricted use cases that violate carrier or regulatory policies.

  • shaft_content_check (Shaft Content Check)
    Screens for Sex, Hate, Alcohol, Firearms, and Tobacco (SHAFT) content prohibited by carriers.

  • opt_in_method_check (Opt-in Method Validation)
    Ensures consent mechanism is lawful and clearly described.

analysisSteps*
string

External identifier for the project. Note: each API call creates a new project even if the same externalProjectId is provided.

uri

HTTPS URL to receive webhook notifications when analysis is complete.

string
length ≥ 1

Enter the exact registered business name that matches your tax documents

string | null

The trading name or 'doing business as' name, if different from the legal name

string | null

Your 9-digit Federal Tax ID/EIN (e.g. 12-3456789)

uri | null

Your primary business website (must start with https://)

registeredBusinessAddress
object
string | null

First name of the brand point of contact for verification and carrier requests.

string | null

Last name of the brand point of contact for verification and carrier requests.

string | null

Business email address for the brand point of contact.

uri | null

Direct HTTPS URL to the privacy policy page.

uri | null

Direct HTTPS URL to the terms of service page.

useCase
array of strings | null

Toll-free use case categories. TFN supports multiple concurrent use cases.

string | null

Detailed description of the messaging program and recipient audience.

integer | null
1000 to 10000

Estimated monthly message volume for this toll-free number.

string | null

Representative production message content sent to recipients on this toll-free number.

string | null

Response sent when a subscriber asks for help.

string | null

Confirmation sent when a subscriber opts out.

optInMethods
array of strings | null

Methods used to obtain consent before sending SMS messages.

string | null

Plain-language description of how subscribers consent before any messages are sent.

string | null

Confirmation message sent to the subscriber after opting in via SMS keyword.

optInMethodURLs
array of uris | null

HTTPS URLs proving the opt-in flow: web-form pages, QR-code targets, hosted screenshots of offline/non-standard opt-in evidence, or hosted verbal opt-in scripts (PDF / transcript).

Opt-In Method URLs
optInKeywords
array of strings | null
Defaults to START,YES

Keywords subscribers text to opt in. Required when SMS_KEYWORD is declared.

Opt-In Keywords
boolean | null
Defaults to false

Set to true if this toll-free number sends multiple message types that require separate consent.

string | null

First use case description when the toll-free program is mixed.

string | null

Second use case description when the toll-free program is mixed.

string | null

Separate opt-in workflow description for the second use case when the toll-free program is mixed.

boolean | null
Defaults to false

Set to true if program content includes age-restricted products or services.

boolean | null
Defaults to false

Set to true if the sender is a financial institution engaged in direct first-party lending.

boolean | null
Defaults to false

Self-reported flag indicating the campaign promotes third-party products or services via affiliate links.

Responses

Callback

Updated 9 days ago

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

Updated 9 days ago