Purchase number for location

POST 
/phone-system/numbers/location/:locationId/purchase

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Purchase number for location.

Request

locationId stringrequired

Location ID as string

application/json

application/json

Body

Bodyrequired

phoneNumberstringrequired

phoneNumber to purchase

addressSidstringrequired

addressSid twilio address id

bundleSidstringrequired

bundleSid twilio bundle id

countryCodestringrequired

country for which the phone numbers are being requested

numberTypeobjectrequired

type of phone number to be purchased

paymentIntentIdstringrequired

stripe payment intent id

stripeAccountIdstringrequired

stripe account id

paymentMethodIdstringrequired

stripe registered payment method id

localitystringrequired

locality of the user in which number is being purchased

regionstringrequired

region of the user in which number is being purchased

fingerprintIdstringrequired

fingerprintId is request id which is unique for every purchase number request

skipLocationKYCbooleanrequired

Skip location-level KYC verification if agency-level compliance has already been verified

Example (auto)

{
  "phoneNumber": "830236932",
  "addressSid": "ADXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "bundleSid": "BUXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "countryCode": "US",
  "numberType": "local",
  "paymentIntentId": "pi_3Oxxxxxxxxxxxxxxxxxxxx",
  "stripeAccountId": "acct_1Oxxxxxxxxxxxxxxxx",
  "paymentMethodId": "pm_1Oxxxxxxxxxxxxxxxx",
  "locality": "Austin",
  "region": "TX",
  "fingerprintId": "purchase-req-abc-123",
  "skipLocationKYC": false
}