Phone & voice · Phone Numbers

Upload a KYC document

Uploads a KYC document.

POSThttps://api.pozy.ai/v1/phone-numbers/kyc/upload-document
uploadPhoneNumberKycDocument

Guides: KYC for regulated countries, Phone numbers

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

NameTypeNotes
X-Filenamerequiredstring

Request body

application/octet-stream, required

Free-form JSON object.

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/kyc/upload-document" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "X-Filename: document.pdf" \
  -H "Content-Type: application/pdf" \
  --data-binary @./document.pdf

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:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Phone Numbers