Messaging · Verify

Check a verification code

Checks a verification code without changing anything.

POSThttps://api.pozy.ai/v1/verify/verifications/{verificationId}/check
Not available yetcheckVerification

Guide: Send SMS

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

This endpoint is not available yet. Calls return 403 feature_not_available.

Path parameters

NameTypeNotes
verificationIdrequiredstring

Request body

application/json, required

  • codestringrequired

    Matches ^\d{4,8}$.

Example

curl -X POST "https://api.pozy.ai/v1/verify/verifications/6e85def772268339137ee9ed/check" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "string"
}'

Response

200 on success

  • idstring
  • statusstring

    One of pending, approved, expired, max_attempts_reached, canceled, delivery_failed.

  • channelstring

    One of sms, whatsapp.

  • tostring
  • expiresAtstring (date-time)
  • attemptsinteger
  • maxAttemptsinteger
  • sendCountinteger
  • lastSentAtstring (date-time)

    Can be null.

  • deliveryStatusstring

    One of delivered, read, failed. Can be null.

  • deliveryErrorCodeinteger

    Can be null.

  • createdAtstring (date-time)
  • resendboolean
  • validboolean
200 response
{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "status": "pending",
  "channel": "sms",
  "to": "+14155550123",
  "expiresAt": "2026-10-02T09:00:00.000Z",
  "attempts": 1,
  "maxAttempts": 1,
  "sendCount": 42,
  "lastSentAt": "2026-10-02T09:00:00.000Z",
  "deliveryStatus": "delivered",
  "deliveryErrorCode": 1,
  "createdAt": "2026-10-02T09:00:00.000Z",
  "resend": true,
  "valid": true
}

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 Verify