WhatsApp · WhatsApp Phone Numbers
Pre-validates a KYC address without changing anything.
POST
https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/validate-addressDeprecatedvalidateWhatsAppNumberKycAddress
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
countrystringrequired2 to 2 characters.
street_addressstringrequiredextended_addressstringlocalitystringrequiredadministrative_areastringpostal_codestringrequired
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/validate-address" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"country": "US",
"street_address": "string",
"locality": "string",
"postal_code": "string"
}'const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/validate-address", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
country: "US",
street_address: "string",
locality: "string",
postal_code: "string"
}),
});
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/whatsapp/phone-numbers/kyc/validate-address",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"country": "US",
"street_address": "string",
"locality": "string",
"postal_code": "string",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
okbooleanskippedboolean
200 response
{
"ok": true,
"skipped": 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 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 WhatsApp Phone Numbers
GETGet number statusGETGet pricing analyticsGETList phone numbersPOSTPurchase phone numberGETList offerable number countriesGETSearch available numbersGETCheck country availabilityGETGet KYC form specPOSTSubmit KYCPOSTUpload a KYC documentPOSTCreate a hosted KYC linkPATCHMove a number to another profileGETGet declined requirementsPOSTResubmit a declined numberGETGet phone numberDELRelease phone number