Phone & voice · Phone Numbers

Port numbers in

Ports numbers in.

POSThttps://api.pozy.ai/v1/phone-numbers/port-in

createPhoneNumberPortIn

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the telephony resource group disabled get 403 resource_group_disabled. Authentication

Request body

application/json, required

phoneNumbersarray of stringrequired
At least 1 item. Up to 50 items.
endUserobjectrequired
13 child fields
- entityNamestringrequired
- authPersonNamestringrequired
- billingPhoneNumberstring
- accountNumberstringrequired
- pinPasscodestring
- taxIdentifierstring
  Up to 50 characters.
- businessIdentifierstring
  Up to 50 characters.
- streetAddressstringrequired
- extendedAddressstring
- localitystringrequired
- administrativeAreastring
- postalCodestringrequired
- countryCodestringrequired
  One of US, CA, GB, ES, DE, FR, NL, AU, BR. 2 to 2 characters.
loaDocumentIdstringrequired
invoiceDocumentIdstringrequired
focDatetimeRequestedstring (date-time)
customerReferencestring
Up to 100 characters.
portTypestring
One of full, partial. Default full.
requirementsarray of object
Up to 30 items.
- requirementTypeIdstringrequired
- fieldValuestringrequired
  Up to 1000 characters.

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/port-in" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "phoneNumbers": [
    "+14155550123"
  ],
  "endUser": {
    "entityName": "Acme",
    "authPersonName": "Acme",
    "accountNumber": "string",
    "streetAddress": "string",
    "locality": "string",
    "postalCode": "string",
    "countryCode": "US"
  },
  "loaDocumentId": "69672f55771520ecb8178d25",
  "invoiceDocumentId": "606bc6ac551d4eb2b1feef58"
}'

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/port-in", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phoneNumbers: [
      "+14155550123"
    ],
    endUser: {
      entityName: "Acme",
      authPersonName: "Acme",
      accountNumber: "string",
      streetAddress: "string",
      locality: "string",
      postalCode: "string",
      countryCode: "US"
    },
    loaDocumentId: "69672f55771520ecb8178d25",
    invoiceDocumentId: "606bc6ac551d4eb2b1feef58"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.post(
    "https://api.pozy.ai/v1/phone-numbers/port-in",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "phoneNumbers": [
            "+14155550123",
        ],
        "endUser": {
            "entityName": "Acme",
            "authPersonName": "Acme",
            "accountNumber": "string",
            "streetAddress": "string",
            "locality": "string",
            "postalCode": "string",
            "countryCode": "US",
        },
        "loaDocumentId": "69672f55771520ecb8178d25",
        "invoiceDocumentId": "606bc6ac551d4eb2b1feef58",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

201 on success

idstring
carrierPortingOrderIdstring
statusstring
One of draft, pending, foc_confirmed, ported, exception, cancelled.
phoneNumbersarray of string
ordersarray of object
- idstring
- carrierPortingOrderIdstring
- statusstring
- phoneNumbersarray of string
- errorstring

201 response

{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "carrierPortingOrderId": "6ff0121227cdb2529beb44df",
  "status": "draft",
  "phoneNumbers": [
    "+14155550123"
  ],
  "orders": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "carrierPortingOrderId": "6ff0121227cdb2529beb44df",
      "status": "active",
      "phoneNumbers": [
        "+14155550123"
      ],
      "error": "string"
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Phone Numbers

GETList phone numbers GETGet phone number DELRelease phone number POSTPurchase phone number GETResolve a number claim GETList offerable number countries GETSearch available numbers GETCheck country availability GETGet KYC form spec POSTSubmit KYC GETView a KYC document on file POSTUpload a KYC document POSTPre-validate KYC address POSTCreate a hosted KYC link GETList port-in orders POSTCheck portability GETResolve a port claim POSTUpload a porting document GETCountry porting requirements GETA port-in order's pending requirements DELCancel a port-in POSTPre-review a KYC packet GETGet declined requirements POSTResubmit a declined number POSTReply to the regulatory reviewer POSTRespond to the regulatory reviewer (message + corrections)GETList stock watches POSTWatch an out-of-stock country DELStop watching a country POSTRequest the WhatsApp verification code for a number