Phone & voice · Phone Numbers

View a KYC document on file

Views a KYC document on file.

GEThttps://api.pozy.ai/v1/phone-numbers/kyc/document/{documentId}
viewPhoneNumberKycDocument

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

Path parameters

NameTypeNotes
documentIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/phone-numbers/kyc/document/663401f11b591db15bd1bbd9" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success · application/pdf

200 response
"string"

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 scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Phone Numbers