Phone & voice · Phone Numbers

Get KYC form spec

Fetches a KYC form spec.

GEThttps://api.pozy.ai/v1/phone-numbers/kyc

getPhoneNumberKycForm

Guides: KYC for regulated countries, Phone numbers

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

Query parameters

Name	Type	Notes
`country`required	string
`numberType`	string	One of `local`, `mobile`, `national`, `toll_free`

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/kyc?country=US" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/kyc?country=US", {
  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/kyc",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "country": "US",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

countrystring
numberTypestring
fieldsarray of object
- requirementIdstring
- labelstring
- kindstring
  One of text, date, address, file, action.
- descriptionstring
  Can be null.
- examplestring
  Can be null.
- localTostring
  Can be null.
reusableobject
Can be null.
- availableboolean
- fromPhoneNumberstring
- detailsarray of object
  2 child fields
  - labelstring
  - valuestring
- optionsarray of object
  4 child fields
  - idstring
  - fromPhoneNumberstring
  - instantboolean
  - detailsarray of object
    3 child fields
    labelstring
    valuestring
    documentIdstring
pendingReviewboolean

200 response

{
  "country": "US",
  "numberType": "string",
  "fields": [
    {
      "requirementId": "6296509a322aab288a61cc5d",
      "label": "string",
      "kind": "text",
      "description": "A short description",
      "example": "string",
      "localTo": "string"
    }
  ],
  "reusable": {
    "available": true,
    "fromPhoneNumber": "+14155550123",
    "details": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "options": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "fromPhoneNumber": "+14155550123",
        "instant": true,
        "details": [
          {
            "label": "string",
            "value": "string",
            "documentId": "663401f11b591db15bd1bbd9"
          }
        ]
      }
    ]
  },
  "pendingReview": true
}

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.
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 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