Number Requests (v2)
Create Number Request
Submit a complete request-owned identity and program for number provisioning.
POST
Creates a number request with
status: "pending" and enters the Trackly review queue. Poll Get Number Request to track it.
This is a live-key write. Sandbox keys can read number requests but cannot create them.
Send a unique
Idempotency-Key to retry this create safely. Repeating the same key with the same body replays the first successful response; changing the body returns 409 idempotency_conflict. See Idempotency.The API uses the customer-hosted
optInFormUrl as carrier evidence and does not create a white-label opt-in site. A 10DLC request also requires termsConditionsUrl.Identity
string
required
Brand name.
string
required
Registered legal entity name for this number request.
string
required
Carrier registration identifier selected by
addressCountry. This value is write-only and is not returned by list, get, or create responses.string
Carrier identifier type. Omit it for a country with one option; Trackly stores the only valid type. It is required for AU, CA, FR, and ES and must be one of the country choices below.
string
required
Authorized carrier contact first name.
string
required
Authorized carrier contact last name.
string
Business industry.
Address and contact
string
required
Street address owned by this request.
string
required
City.
string
State or province. Required when
addressCountry is US or CA.string
required
Postal or ZIP code.
string
required
ISO 3166-1 alpha-2 business address country. This field selects the carrier identifier type; it does not select the number country.
string
required
Carrier support email. Its domain must match the
websiteUrl domain.string
Carrier support phone.
string
required
Public business website URL.
Number and program
string
required
Sending list name.
string
default:"toll_free"
toll_free or 10dlc. Short codes are not available through public V2.array
required
Exactly one ISO 3166-1 alpha-2 number country, such as
["US"] or ["CA"]. A US target uses USA sender registration. CA and other non-US targets use requirements-first number acquisition. 10DLC must target US.string
default:"MIXED"
Messaging use case, such as
GENERAL_MARKETING, TWO_FA, or MIXED.string
TCR business vertical. Required for 10DLC.
string
required
Public opt-in page URL. Trackly captures it as carrier opt-in evidence.
string
Public Terms and Conditions URL. Required for 10DLC.
string
Messaging program summary.
string
Example message.
string
Business description.
string
Estimated monthly segment volume.
Identifier types
GB VAT must contain
GB followed by nine digits. For example, GB421084435 is accepted; a bare company registry number is not. The registration_number fallback is bounded local validation and does not guarantee that every country and identifier is accepted by the carrier.
International requirements
Before creating a CA or other non-US request, call Look Up International Requirements. After creation, use Manage International Requirements to save provider form values and request-scoped documents.Example
Error codes
Identifier-type errors include
allowedIdentifierTypes when choices are available.
Next steps
Update Number Request
Correct request-owned identity while it is editable
Look Up Requirements
Discover non-US form and document requirements