Sign in

v3

latestOpenAPI 3.1.02026-08-087684214.2 KB
registration

Register A2P

Submit A2P 10DLC registration.

Deducts the registration fee ($25 for sole_proprietor / standard_brand, $70 for high_volume) from the parent account's credit balance, creates an optional sub-account, and sends a notification email.

post/v1/register

Request body

registration_type'sole_proprietor' | 'standard_brand' | 'high_volume' required

'sole_proprietor' ($25, no EIN, 1 number), 'standard_brand' ($25, EIN, low volume), or 'high_volume' ($70, EIN + external brand vetting for the highest carrier limits)

first_namestring required
last_namestring required
emailstring required
phone_numberstring required

E.164 format, e.g. +15551234567

business_namestring nullable

Legal/registered business name. Required for standard_brand and high_volume.

brand_namestring nullable

Public-facing brand name if different from business_name.

organization_type'sole_proprietor' | 'private_corporation' | 'public_corporation' | 'llc' | 'partnership' | 'non_profit' | 'co_op' | 'government'
contact_title'ceo' | 'cfo' | 'cto' | 'coo' | 'vp' | 'gm' | 'director' | 'other'
contact_title_otherstring nullable

Custom title when contact_title is 'other'.

einstring nullable

EIN / Tax ID. Required for standard_brand and high_volume.

website_urlstring nullable
industrystring nullable

e.g. technology, real_estate, retail, healthcare

business_regionsstring[]
street_addressstring required
street_address_2string nullable
citystring required
statestring required
zip_codestring required
countrystring
planned_numbersinteger

Number of phone numbers you plan to use

descriptionstring required

What your business does, who you message, and what types of messages you send. Min 40 chars.

use_casesUseCase[] required

1-5 specific use cases for your SMS campaign.

volume'low' | 'high'
message_samplesstring[] required

2-5 example messages. Each must be 20-1024 chars and include your brand name.

consent_flowstring required

How users opt in to receive messages. Min 40 chars.

privacy_policy_urlstring nullable

Required for standard_brand and high_volume.

terms_of_service_urlstring nullable

Required for standard_brand and high_volume.

opt_in_image_urlstring required

Publicly accessible URL to a screenshot of your opt-in flow (PNG, JPG, WEBP, or GIF, max 2MB)

includesCampaignInclude[]

Content types included in messages.

link_samplestring nullable

Example URL if messages contain links.

create_sub_accountboolean

Create a dedicated sub-account for this campaign. Set false to register on your main account.

Response

Successful Response

okboolean required
messagestring required
campaign_statusstring required
sub_account_idstring nullable
fee_centsinteger required