Phone & voice · Phone Numbers

Respond to the regulatory reviewer (message + corrections)

Responds to the regulatory reviewer (message + corrections).

POSThttps://api.pozy.ai/v1/phone-numbers/{id}/remediate/respond

respondToPhoneNumberReviewer

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

Path parameters

Name	Type	Notes
`id`required	string

Request body

application/json, required

messagestring
Up to 2000 characters.
documentsarray of object
- requirementIdstringrequired
- filenamestring
- base64string
- documentIdstring
- issuedAtstring (date)
addressobject
entityTypestring
One of individual, business. Can be null.
attachmentsarray of object
Up to 5 items.
- filenamestringrequired
- base64stringrequired

Example

curl -X POST "https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/remediate/respond" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "message": "Hello from Pozy",
  "documents": [
    {
      "requirementId": "6296509a322aab288a61cc5d"
    }
  ],
  "address": {},
  "entityType": "individual"
}'

const res = await fetch("https://api.pozy.ai/v1/phone-numbers/6bfebd43ddc270f6d2c56fc5/remediate/respond", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    message: "Hello from Pozy",
    documents: [
      {
        requirementId: "6296509a322aab288a61cc5d"
      }
    ],
    address: {},
    entityType: "individual"
  }),
});
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/phone-numbers/6bfebd43ddc270f6d2c56fc5/remediate/respond",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "message": "Hello from Pozy",
        "documents": [
            {
                "requirementId": "6296509a322aab288a61cc5d",
            },
        ],
        "address": {},
        "entityType": "individual",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

statusstring
One of resubmitted, replied.
postedboolean
phoneNumberobject
- idstring
- statusstring
siblingsResubmittedinteger

200 response

{
  "status": "resubmitted",
  "posted": true,
  "phoneNumber": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "status": "active"
  },
  "siblingsResubmitted": 1
}

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.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.