WhatsApp · WhatsApp Phone Numbers
Uploads a KYC document.
POST
https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/upload-documentDeprecateduploadWhatsAppNumberKycDocument
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
Headers
| Name | Type | Notes |
|---|---|---|
X-Filenamerequired | string |
Request body
application/octet-stream, required
Free-form JSON object.
Example
curl -X POST "https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/upload-document" \
-H "Authorization: Bearer $POZY_API_KEY" \
-H "X-Filename: document.pdf" \
-H "Content-Type: application/pdf" \
--data-binary @./document.pdfimport { readFile } from "node:fs/promises";
const res = await fetch("https://api.pozy.ai/v1/whatsapp/phone-numbers/kyc/upload-document", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.POZY_API_KEY}`,
"X-Filename": "document.pdf",
"Content-Type": "application/pdf",
},
body: await readFile("./document.pdf"),
});
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/upload-document",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}", "X-Filename": "document.pdf"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
documentIdstring
200 response
{
"documentId": "663401f11b591db15bd1bbd9"
}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 KYCPOSTPre-validate KYC addressPOSTCreate a hosted KYC linkPATCHMove a number to another profileGETGet declined requirementsPOSTResubmit a declined numberGETGet phone numberDELRelease phone number