API Reference

Submit a 10DLC PreCheck [beta]

post
https://api.texter.id/v1/precheck/10dlc

Creates a verification project for the 10DLC 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_online_presence_check (Analyze Brand Online Presence)
    Analyze the brand's online presence to better understand business activities and support TM review.

  • 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.

  • 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.

  • campaign_description_check (Campaign Description Check)
    Ensures the campaign description clearly explains the messaging use case and is consistent with campaign materials.

  • sample_messages_check (Sample Messages Check)
    Verifies sample messages comply with carrier requirements and match the declared use case.

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

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

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

  • 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

Industry vertical used to assess use-case plausibility and prohibited content risk.

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.

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.

TCR campaign use case. Restricted use cases such as CARRIER_EXEMPT, PROXY, and SOCIAL are excluded.

subUseCases
array of strings | null

Additional use cases included when the campaign is MIXED.

string | null

Plain-language explanation of who sends messages, who receives them, and why.

sampleMessages
array of objects | null

Examples of messages sent under this campaign.

Sample Messages
string | null

Detailed call-to-action description submitted to TCR.

string | null

Confirmation message sent to the subscriber after opt-in.

optInKeywords
array of strings | null
Defaults to START,YES

Keywords subscribers text to opt in.

Opt-In Keywords
optOutKeywords
array of strings | null
Defaults to STOP,END,QUIT,CANCEL,UNSUBSCRIBE

Keywords subscribers can text to opt out.

Opt-Out Keywords
helpKeywords
array of strings | null
Defaults to HELP,INFO

Keywords subscribers can text for help.

HELP Keywords
boolean | null
Defaults to false

Set to true if any campaign message contains a URL.

boolean | null
Defaults to false

Set to true if campaign messages embed a phone number other than HELP contact details.

boolean | null
Defaults to false

Set to true if campaign 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.

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
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