Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

locationId
string
required

The business (sub-account) to register.

Minimum string length: 1

Body

application/json
submissionId
string
required

A lowercase UUID you make once per registration and reuse on every retry.

Pattern: ^[a-f0-9-]{36}$
authorized
boolean
required

Must be true: the person in confirmedBy is authorised to register this business.

termsVersion
string
required

The summary's termsVersion.

confirmedBy
object
required

The person at your agency who confirmed these details. Kept with the submission, never sent to Twilio.

details
object
required

The business and its authorised representative, keyed by the summary's fields. businessIdentity defaults to direct_customer.

numbers
string[]

E.164 numbers to register. Leave out for every ready number.

Pattern: ^\+[1-9]\d{7,14}$
futureNumbers
boolean
default:true

Also register this business's new numbers automatically.

When another of your businesses with the same EIN is already registered in the same Twilio account, add this business's numbers to that registration. They use its details and caller name.

Response

Queued for Twilio, or the registration a repeated submissionId already created.

success
boolean
required
registration
object
required

One business registration as it stands.

linked
boolean

true when this business joined the registration of another business with the same EIN.

excluded
object[]

Numbers left out, with why: reasonCode and the sentence in reason.

{key}
any