Skip to main content
POST
Create a compliance profile

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
name
string
required

Human-readable label for the profile.

Required string length: 1 - 200
use_case
enum<string>
required

The regulatory use case this profile is built for.

Available options:
phone_number_purchase,
sms_sender_id_alphanumeric,
sms_10dlc_brand_us,
sms_10dlc_campaign_us,
sms_tfv_us,
whatsapp_business_verification,
rcs_brand_verification,
email_domain_verification,
voice_carrier_kyc,
other
use_case_subtype
string | null

Optional sub-classification within the use case.

Maximum string length: 50
country_code
string

Single ISO-3166 alpha-2 country. Required for country-specific use cases unless countries is given.

Required string length: 2
countries
string[]

Multiple ISO-3166 alpha-2 countries; submission fans out one carrier bundle per country.

Maximum array length: 50
Required string length: 2
end_user_type
enum<string>
default:business

Whether the registrant is a business or an individual.

Available options:
business,
individual

Response

201 - application/json

The newly created draft profile.

data
object

A tenant KYC / regulatory compliance profile — the business/identity data and documents submitted to carriers for one use case + country.

meta
object