Skip to main content
POST
/
v1.0
/
numbers
/
provision
json
{
  "NumberType": "iot",
  "MessageType": "p2p",
  "MessageEnabled": true,
  "VoiceEnabled": false,
  "DataEnabled": true,
  "MessageRouteId": "MRID-73af1e73-d7b3-4696-bdd9-5b407c96fc8a",
  "VoiceRouteId": "CRID-4dec6beb-3985-444b-8c06-8baa70dc145",
  "AreaCode": "201",
  "ZipCode": "84043",
  "ICCID": "8901240397190195850"
}
{
  "OrderDate": "2025-10-29T12:36:19.338438+00:00",
  "OrderId": "JNUOID-76ba71a8-d7a6-4489-b695-1ad363b8d596",
  "OrderStatus": "Complete",
  "PhoneNumberAssigned": "+18016025346",
  "PhoneNumberId": "NID-8bdf915a-ef65-46c9-8c66-96c98d42d9ca",
  "QRCode": "https://quickchart.io/qr?text=LPA:1$T-MOBILE.IDEMIA.IO$LX9G1-Q12VI-CIIWA-WAQIN&centerImageUrl=https://joonto.com/wp-content/uploads/2022/07/cropped-Joonto-2022-Square-Icon-Black-Background.png&ecLevel=H&format=png&centerImageSizeRatio=.3",
  "ZipCode": "84603",
  "ErrorMessage": null,
  "SubscriberId": "TSUID-ac59a1f8-36b6-42cc-b124-c2aa29f7e3d2"
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
NumberType
enum<string>
required

Number classification: 'mvno' (supports both a2p and p2p), 'iot' (p2p only - cannot be provisioned as a2p; use mvno NumberType for a2p MessageType), 'voip' (a2p only)

Available options:
mvno,
iot,
voip
Example:

"iot"

​
MessageType
enum<string>
required

Message type: a2p (Application-to-Person) or p2p (Person-to-Person)

Available options:
a2p,
p2p
Example:

"p2p"

​
MessageEnabled
boolean
required

Enable SMS/MMS capabilities

Example:

true

​
VoiceEnabled
boolean
required

Enable voice call capabilities

Example:

false

​
DataEnabled
boolean

Enable data capabilities (for IoT numbers)

Example:

true

​
MessageRouteId
string

MRID for message routing configuration

Example:

"MRID-81dr9t90-....-....-....-.........."

​
VoiceRouteId
string

CRID for voice routing configuration

Example:

"CRID-5nov0yuy-....-....-....-........."

​
AreaCode
string

Preferred 3-digit area code. Lookup searches AreaCode first before ZipCode. If both AreaCode and ZipCode are left blank or null, a randomized set of results will be returned

Example:

"201"

​
ZipCode
string

5-digit zip code. Used as fallback if AreaCode is unavailable. You may provide both AreaCode and ZipCode, or just one; AreaCode takes priority if included. Please note that zip codes must be valid and within the United States.

Example:

"84043"

​
ICCID
string

Integrated Circuit Card Identifier. Optional field, but required when provisioning a physical SIM (pSIM)

Example:

"8901240397190195850"

Response

200 - application/json

Number Provision - A2P

The response is of type object.