Phone & voice · Phone Numbers

Resolve a number claim

Resolves a number claim.

GEThttps://api.pozy.ai/v1/phone-numbers/claims/{claimId}

getPhoneNumberClaim

Request

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

Path parameters

Name	Type	Notes
`claimId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/claims/64d7462a13b28690b007b884" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/claims/64d7462a13b28690b007b884", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
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.get(
    "https://api.pozy.ai/v1/phone-numbers/claims/64d7462a13b28690b007b884",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

countryobject
- codestring
- needsKycboolean
- monthlyCentsinteger
- typesarray of object
typeobject
areaobject
Can be null.
- ndcstring
- namestring
- countinteger
phoneNumberstring
Can be null.

200 response

{
  "country": {
    "code": "string",
    "needsKyc": true,
    "monthlyCents": 1,
    "types": [
      {}
    ]
  },
  "type": {},
  "area": {
    "ndc": "string",
    "name": "Acme",
    "count": 42
  },
  "phoneNumber": "+14155550123"
}

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 scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
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 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 POSTPort numbers in 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