Phone & voice · Phone Numbers

Pre-review a KYC packet

Pre-reviews a KYC packet.

POSThttps://api.pozy.ai/v1/phone-numbers/kyc/review-packet
reviewPhoneNumberKycPacket

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

Request body

application/json, required

  • countrystringrequired

    2 to 2 characters.

  • numberTypestringrequired
  • valuesmap of string
  • addressmap of string
  • docsarray of objectrequired

    At least 1 item. Up to 4 items.

    • requirementIdstringrequired
    • documentIdstringrequired
    • issuedAtstring (date)

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/kyc/review-packet" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "country": "US",
  "numberType": "string",
  "docs": [
    {
      "requirementId": "6296509a322aab288a61cc5d",
      "documentId": "663401f11b591db15bd1bbd9"
    }
  ]
}'

Response

200 on success

  • advisoriesarray of object
    • requirementIdstring
    • concernstring
200 response
{
  "advisories": [
    {
      "requirementId": "6296509a322aab288a61cc5d",
      "concern": "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 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