Phone & voice · Branded Calling

Confirm the authorizer's code

Confirms the authorizer's code.

POSThttps://api.pozy.ai/v1/branded-calling/identities/{id}/verify-email/confirm
confirmBrandedCallingAuthorizerEmail

Guide: Branded calling

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

NameTypeNotes
idrequiredstring

Request body

application/json, required

  • codestringrequired

    Matches ^[0-9]{6}$.

Example

curl -X POST "https://api.pozy.ai/v1/branded-calling/identities/6bfebd43ddc270f6d2c56fc5/verify-email/confirm" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string"
}'

Response

200 on success

  • idstring
  • enterpriseIdstring
  • displayNamestring

    Up to 35 characters.

  • callReasonsarray of string

    Each item: up to 64 characters.

  • callReasonsPreApprovedboolean
  • logoUrlstring

    Can be null.

  • authorizerobject
    • namestring
    • emailstring (email)
  • referencesobject
    • businessarray of objectrequired

      At least 2 items. Up to 2 items.

      7 child fields
      • fullNamestringrequired

        Up to 255 characters.

      • jobTitlestring

        Up to 255 characters.

      • organizationstring

        Up to 255 characters.

      • relationshipToRegistrantstring

        Up to 255 characters.

      • phoneNumberstringrequired
      • emailstring (email)required
      • timezonestringrequired
    • financialobjectrequired
      7 child fields
      • fullNamestringrequired

        Up to 255 characters.

      • jobTitlestring

        Up to 255 characters.

      • organizationstring

        Up to 255 characters.

      • relationshipToRegistrantstring

        Up to 255 characters.

      • phoneNumberstringrequired
      • emailstring (email)required
      • timezonestringrequired
  • statusstring

    One of requested, changes_requested, rejected, pending_email_verification, in_review, verified, suspended, expired, permanently_rejected.

  • rejectionReasonsarray of object
    • codestring
    • titlestring
    • detailstring
    • messagestring

      Can be null.

  • reviewNotestring

    Can be null.

  • reviewRequestobject

    Can be null.

    • idstring
    • introstring
    • pointsarray of object
      4 child fields
      • idstring
      • titlestring
      • detailstring
      • answerstring

        One of text, link, file, link_or_file.

  • emailVerifiedAtstring (date-time)

    Can be null.

  • submittedAtstring (date-time)

    Can be null.

  • verifiedAtstring (date-time)

    Can be null.

  • expiringAtstring (date-time)

    Can be null.

  • numbersarray of object
    • phoneNumberIdstring
    • phoneNumberstring
    • statusstring

      One of submitted, in_review, verified, unsuccessful, suspended, expired, permanently_rejected.

    • rejectionReasonobject

      Can be null.

      4 child fields
      • codestring
      • titlestring
      • detailstring
      • messagestring

        Can be null.

    • verifiedAtstring (date-time)

      Can be null.

    • addedAtstring (date-time)

      Can be null.

  • createdAtstring (date-time)

    Can be null.

  • updatedAtstring (date-time)

    Can be null.

200 response
{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "enterpriseId": "66496a86752378ad82057ff6",
  "displayName": "Acme",
  "callReasons": [
    "string"
  ],
  "callReasonsPreApproved": true,
  "logoUrl": "https://pozy.ai/media/example-1.jpg",
  "authorizer": {
    "name": "Acme",
    "email": "alex@example.com"
  },
  "references": {
    "business": [
      {
        "fullName": "Acme",
        "jobTitle": "string",
        "organization": "string",
        "relationshipToRegistrant": "string",
        "phoneNumber": "+14155550123",
        "email": "alex@example.com",
        "timezone": "America/New_York"
      }
    ],
    "financial": {
      "fullName": "Acme",
      "jobTitle": "string",
      "organization": "string",
      "relationshipToRegistrant": "string",
      "phoneNumber": "+14155550123",
      "email": "alex@example.com",
      "timezone": "America/New_York"
    }
  },
  "status": "requested",
  "rejectionReasons": [
    {
      "code": "string",
      "title": "Launch day",
      "detail": "string",
      "message": "Hello from Pozy"
    }
  ],
  "reviewNote": "string",
  "reviewRequest": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "intro": "string",
    "points": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "title": "Launch day",
        "detail": "string",
        "answer": "text"
      }
    ]
  },
  "emailVerifiedAt": "2026-10-02T09:00:00.000Z",
  "submittedAt": "2026-10-02T09:00:00.000Z",
  "verifiedAt": "2026-10-02T09:00:00.000Z",
  "expiringAt": "2026-10-02T09:00:00.000Z",
  "numbers": [
    {
      "phoneNumberId": "698fba0989716df44adb771f",
      "phoneNumber": "+14155550123",
      "status": "submitted",
      "rejectionReason": {
        "code": "string",
        "title": "Launch day",
        "detail": "string",
        "message": "Hello from Pozy"
      },
      "verifiedAt": "2026-10-02T09:00:00.000Z",
      "addedAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "createdAt": "2026-10-02T09:00:00.000Z",
  "updatedAt": "2026-10-02T09:00:00.000Z"
}

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.
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 Branded Calling