WhatsApp · WhatsApp Phone Numbers
Creates a hosted KYC link.
POST
https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/shareDeprecatedNot available yetcreateWhatsAppNumberKycLink
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
This endpoint is not available yet. Calls return 403 feature_not_available.
Request body
application/json, required
profileIdstringrequiredcountrystringrequired2 to 2 characters.
areaCodestringMatches
^\d{1,4}$.languagestringOne of
en,es,pt-BR.brandingobjectcompanyNamestringUp to 60 characters.
logoUrlstring (URL)brandColorstringMatches
^#[0-9a-fA-F]{6}$.
redirect_urlstring (URL)
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/share" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"profileId": "6a0b6573846efc28aaa9a3ff",
"country": "US"
}'const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/share", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
profileId: "6a0b6573846efc28aaa9a3ff",
country: "US"
}),
});
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/share",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
json={
"profileId": "6a0b6573846efc28aaa9a3ff",
"country": "US",
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
urlstringtokenstringexpiresAtstring (date-time)
200 response
{
"url": "https://pozy.ai/media/example-1.jpg",
"token": "string",
"expiresAt": "2026-10-02T09:00:00.000Z"
}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 documentPOSTPre-validate KYC addressPATCHMove a number to another profileGETGet declined requirementsPOSTResubmit a declined numberGETGet phone numberDELRelease phone number