Submit a PreCheck

post deprecated

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

Creates a verification project and kicks off precheck analysis. Deprecated: new integrations should use POST /v1/precheck/{channel} (e.g. POST /v1/precheck/rcs), which validates submissions against a schema-driven payload and supports per-step narrowing.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

channel

const

enum

required

Messaging channel type.

Currently only RCS (Rich Communication Services) is supported.

Allowed:

country

const

enum

required

Country code for the project.

Format: ISO 3166-1 alpha-2 (two-letter country code). Currently only US is supported.

Allowed:

brandPocName

string

Name of the authorized brand representative.

brandPocEmail

string

^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Email address of the brand point of contact.

brandPocPhoneNumber

string

Phone number of the brand representative.

brandPocTitle

string

Job title of the brand representative.

businessWebsiteUrl

uri

Official website URL of the brand (must use HTTPS).

countryOfRegistration

string

Country where the business is registered.

businessIdentifier

object

Business identifier for the organization.

organizationName

string

Legal name of the organization or brand.

registeredBusinessAddressLine1

string

Street address line 1 of the registered business address.

registeredBusinessAddressLine2

string

Street address line 2 of the registered business address (e.g., suite, apartment).

registeredBusinessAddressCity

string

City of the registered business address.

registeredBusinessAddressState

string

State or province of the registered business address.

registeredBusinessAddressZip

string

ZIP or postal code of the registered business address.

displayName

string

length ≤ 40

Public-facing name of the RCS agent (up to 40 characters).

descriptionForUsers

string

length ≤ 100

Description of the RCS agent shown to end users (up to 100 characters).

useCase

string

enum

Messaging use case for the RCS agent.

One of: otp, transactional, promotional, multi-use.

Allowed:

logoUrl

uri

URL of the agent's logo image (must use HTTPS).

Should be 224 x 224 pixels and in PNG or JPG/JPEG format. Max file size: 50KB

bannerUrl

uri

URL of the agent's banner image (must use HTTPS).

Should be 1440 x 448 pixels and in PNG or JPG/JPEG format. Max file size: 200KB

privacyPolicyUrl

uri

URL of the brand's privacy policy (must use HTTPS).

termsOfServiceUrl

uri

URL of the brand's terms of service (must use HTTPS).

optInDescription

string

Method by which users consent to receive messages.

optOutDescription

string

Message shown when users opt out of communications.

helpMessage

string

Help message displayed when users request assistance.

triggerDescription

string

Events or keywords that initiate messaging interactions.

interactionsDescription

string

Expected user interactions and conversation flows.

analysisSteps

array of strings

length ≥ 1

Analysis steps to run on the project. If provided, at least one step must be specified.

Available steps:

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.
Requires: organizationName, businessIdentifier
Optional: brandPocName, registeredBusinessAddressLine1, registeredBusinessAddressLine2, registeredBusinessAddressCity, registeredBusinessAddressState, registeredBusinessAddressZip
poc_email_domain_check (POC Email Domain Verification)
Verifies the POC email domain is a plausible business domain tied to the brand.
Requires: brandPocEmail, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
brand_online_presence_check (Analyze Brand Online Presence)
Analyze the brand's online presence to better understand business activities and support TM review.
Requires: businessWebsiteUrl, organizationName
rcs_asset_safety_check (RCS Asset Safety Review)
Ensures assets do not depict sex, violence, drugs, or other harmful content.
Requires: logoUrl, bannerUrl
rcs_asset_relevance_check (RCS Asset Relevance Check)
Ensures logo and banner align with website and brand identity.
Requires: logoUrl, bannerUrl, organizationName, businessWebsiteUrl
rcs_asset_trademark_check (RCS Asset Trademark Check)
Verifies assets do not infringe existing marks (e.g., via USPTO database).
Requires: logoUrl, bannerUrl, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
rcs_asset_impersonation_check (RCS Asset Reverse Image Impersonation Check)
Detects potential brand impersonation via reverse image search.
Requires: logoUrl, bannerUrl, organizationName
rcs_display_name_safety_check (RCS Display Name Safety Check)
Ensures display name does not contain inappropriate content.
Requires: displayName
rcs_display_name_relevance_check (RCS Display Name Relevance Check)
Ensures display name is relevant to the brand.
Requires: displayName, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
rcs_display_name_trademark_check (RCS Display Name Trademark and Impersonation Check)
Detects potential TM/impersonation issues.
Requires: displayName, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
rcs_description_safety_check (RCS Agent Description Safety Check)
Ensures the agent description does not contain inappropriate content.
Requires: descriptionForUsers
rcs_description_relevance_check (RCS Agent Description Relevance Check)
Ensures the agent description is relevant to the brand's identity and activities.
Requires: descriptionForUsers, organizationName, businessWebsiteUrl
rcs_description_trademark_check (RCS Agent Description Trademark and Impersonation Check)
Detects potential trademark or impersonation issues in the agent description.
Requires: descriptionForUsers, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
rcs_description_use_case_check (RCS Agent Description Use Case Check)
Ensures the agent description is aligned with the declared messaging use case.
Requires: descriptionForUsers, useCase
privacy_policy_check (Privacy Policy Verification)
Checks URL accessibility and suitability for an RCS message sender.
Requires: privacyPolicyUrl, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
terms_of_service_check (Terms of Service Verification)
Checks URL accessibility and suitability for messaging terms.
Requires: termsOfServiceUrl, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
help_message_check (HELP Message Validation)
Ensures HELP response describes purpose and opt-out clearly.
Requires: helpMessage, organizationName, businessWebsiteUrl
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.
Requires: optOutDescription, organizationName
opt_in_method_check (Opt-in Method Validation)
Ensures consent mechanism is lawful and clearly described.
Requires: optInDescription
interactions_check (Interactions Description Validation)
Ensures message types align with business activities.
Requires: interactionsDescription, organizationName, businessWebsiteUrl
Depends on step: brand_online_presence_check
triggers_check (Triggers Description Validation)
Ensures triggers are clear and informative for carrier review.
Requires: triggerDescription

analysisSteps

externalProjectId

string

External identifier for the project.

Note: Each API call creates a new project, even if the same externalProjectId is provided. This field is for reference only and does not deduplicate projects.

callbackUrl

uri

HTTPS URL to receive webhook notifications when analysis is complete.

Responses

Callback

200Successful response

400Bad Request

401Unauthorized

403Monthly limit exceeded

429Rate Limit Exceeded

500Internal server error