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",
  "ProductType": "Sms+Data",
  "AssignedSubscriberId": "TSUID-1234567999"
}

{
  "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",
  "ICCID": "12345678900987654321",
  "ErrorMessage": null,
  "SubscriberId": "TSUID-ac59a1f8-36b6-42cc-b124-c2aa29f7e3d2"
}

Numbers

Number Provision (Purchase/Order)

Prerequisites:

Required: Bearer token — POST /v1.0/oauth2/tokens
Required: Message Route ID (MRID) — POST /v1.0/message/routes
Optional: Voice Route ID (CRID) — POST /v1.0/voice/routes (only needed if VoiceEnabled: true)
Optional: Subscriber ID (TSUID) — POST /v1.0/subscribers/create (to assign the number at provision time)

Purchase and activate a phone number on your account. Before provisioning, ensure you have already created a Message Route (MRID) and Voice Route (CRID) — numbers provisioned without routes will have no call or message handling. Specify the number classification (mvno for full messaging and voice, iot for data and p2p messaging only), and required capabilities. Returns an OrderId for status tracking.

What this does: Purchases and activates the number, returning an OrderId, the assigned phone number in E.164 format, a PhoneNumberId (NID-), and an eSIM QR code (if applicable). The OrderId can be used to track provisioning status.

Next steps:

Check order status — GET /v1.0/numbers/order
Send a test message — POST /v1.0/message/outbound

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",
  "ProductType": "Sms+Data",
  "AssignedSubscriberId": "TSUID-1234567999"
}

{
  "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",
  "ICCID": "12345678900987654321",
  "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)

Available options:

mvno,

iot

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

ProductType

enum<string>

required

Product type for the provisioned number. Options: Sms-Only, Data-Only, Sms+Data, Sms+Data+Voice

Available options:

Sms-Only,

Data-Only,

Sms+Data,

Sms+Data+Voice

Example:

"Sms+Data"

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"

AssignedSubscriberId

string

Optional subscriber-id to be assigned to the new number

Example:

"TSUID-1234567999"

AccountId

string

Account ID (AID) to provision the number under. Required when a distributor account has more than one sub-account.

Example:

"AID-ab12345-2725-45a1-bd5e-526ed19799xx"

Response

200 - application/json

Success — returns the order ID, assigned phone number, and provisioning status

The response is of type object.

Search Available Numbers Numbers - Port In

⌘I

Documentation Index

Authorizations

Body

Response