Create Registration

curl --request POST \ --url https://api.example.com/v2/cnam-registration \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "display_name": "<string>", "legal_business_name": "<string>", "street_address": "<string>", "city": "<string>", "state": "<string>", "postal_code": "<string>", "country": "<string>", "business_type": "<string>", "business_industry": "<string>", "registration_id_type": "<string>", "registration_number": "<string>", "regions_of_operation": [ "<string>" ], "contact_first_name": "<string>", "contact_last_name": "<string>", "contact_email": "<string>", "contact_phone": "<string>", "contact_title": "<string>", "website": "<string>" } '

{ "created_at": "2023-11-07T05:31:56Z", "modified_at": "2023-11-07T05:31:56Z", "id": "<string>", "status": "<string>", "status_detail": "<string>", "display_name": "<string>", "legal_business_name": "<string>", "street_address": "<string>", "city": "<string>", "state": "<string>", "postal_code": "<string>", "country": "<string>", "business_type": "<string>", "business_industry": "<string>", "registration_id_type": "<string>", "registration_number": "<string>", "regions_of_operation": [ "<string>" ], "website": "<string>", "contact_first_name": "<string>", "contact_last_name": "<string>", "contact_email": "<string>", "contact_phone": "<string>", "contact_title": "<string>", "phone_number": "<string>", "user_id": "<string>", "submitted_at": "2023-11-07T05:31:56Z", "approved_at": "2023-11-07T05:31:56Z", "error_message": "<string>", "object": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for submitting a CNAM registration.

display_name

string

required

Caller ID display name (max 15 characters)

Maximum string length: 15

legal_business_name

string

required

Legal business name

street_address

string

required

Business street address

city

string

required

Business city

state

string

required

Business state/province

postal_code

string

required

Business postal code

country

string

required

Business country

business_type

string

required

Business type, e.g. LLC, Corporation

business_industry

string

required

Business industry, e.g. Technology

registration_id_type

string

required

Registration ID type, e.g. EIN

registration_number

string

required

Business registration number

regions_of_operation

string[]

required

Regions of operation, e.g. ['United States', 'Canada']

Minimum array length: 1

contact_first_name

string

required

Contact first name

contact_last_name

string

required

Contact last name

contact_email

string

required

Contact email

contact_phone

string

required

Contact phone number

contact_title

string

required

Contact job title

website

string | null

Business website URL

Response

Successful Response

created_at

string<date-time>

required

modified_at

string<date-time> | null

required

string

required

status

string

required

Current registration status

status_detail

string | null

required

Human-readable status message or rejection reason

display_name

string

required

Caller ID display name (max 15 characters)

legal_business_name

string

required

Legal business name

street_address

string

required

Business street address

city

string

required

Business city

state

string

required

Business state/province

postal_code

string

required

Business postal code

country

string

required

Business country

business_type

string

required

Business type, e.g. LLC, Corporation

business_industry

string

required

Business industry, e.g. Technology

registration_id_type

string

required

Registration ID type, e.g. EIN

registration_number

string

required

Business registration number, e.g. EIN number

regions_of_operation

string[]

required

Regions of operation, e.g. United States, Canada

website

string | null

required

Business website URL

contact_first_name

string

required

Contact first name

contact_last_name

string

required

Contact last name

contact_email

string

required

Contact email

contact_phone

string

required

Contact phone number

contact_title

string

required

Contact job title

phone_number

string | null

required

Phone number registered for CNAM (e164 format)

user_id

string | null

required

User who submitted the registration (null for backfilled records)

submitted_at

string<date-time> | null

required

When the registration was submitted for processing

approved_at

string<date-time> | null

required

When Twilio approved the registration

error_message

string | null

required

Error details if registration failed

object

string

required

read-only

String representing the object's type. Objects of the same type share the same value.

API Reference

Documentation Index

Authorizations

Body

Response