Callback - pawaPass

pawaPass sends a POST request to your pre-configured callback URL when a verification event occurs. See Webhooks for setup details and best practices.

Headers

Content-Type

string

required

application/json

X-Signature

string

required

SHA256 HMAC signature of the raw request body, signed with your secret key. See Signature verification.

Body

notificationId

string

required

Unique identifier for this notification. Use for deduplication.

type

string

required

Event type. One of VERIFICATION.STATUS_CHANGE or VERIFICATION.IDENTITY_DOCUMENT_CHANGE.

object

string

required

Always VERIFICATION.

createdAt

string

required

ISO 8601 timestamp of when the event was created.

data

object

required

The full verification object.

Show data properties

data.id

string

Verification ID.

data.externalId

string

Your external identifier for this verification.

data.status

string

Current status: CREATED, STARTED, EXPIRED, USER_DATA_COLLECTED, REVIEW, APPROVED, or DECLINED.

data.url

string

URL where the user completes the verification.

data.requirements

array

Array of verification requirements (DOCUMENT_SCAN, FACE_SCAN).

data.metadata

object

Optional metadata provided when creating the verification.

data.successUrl

string

Redirect URL after successful verification.

data.errorUrl

string

Redirect URL on error.

data.supportUrl

string

Support URL shown during verification.

data.createdBy

string

Email/identifier of the person who created this verification.

data.expiresAt

string

ISO 8601 expiration date of the verification session.

data.createdAt

string

ISO 8601 creation timestamp.

data.updatedAt

string

ISO 8601 last update timestamp.

data.faceScan

object

Face scan results. Null if not yet available.

Show faceScan properties

data.faceScan.ageEstimation

string

Estimated age bracket: UNDER_8, OVER_8, OVER_13, OVER_16, OVER_18, OVER_21, OVER_25, OVER_30, or UNKNOWN.

data.faceScan.createdAt

string

ISO 8601 timestamp.

data.faceScan.updatedAt

string

ISO 8601 timestamp.

data.identityDocument

object

Extracted identity document data. Null if not yet available.

Show identityDocument properties

data.identityDocument.type

string

Document type (e.g., Government Issued Photo ID, Passport, Driver License).

data.identityDocument.country

string

Country that issued the document.

data.identityDocument.serialNo

string

Serial number of the document.

data.identityDocument.nationalNo

string

National identification number.

data.identityDocument.firstName

string

First name as extracted from the document.

data.identityDocument.lastName

string

Last name as extracted from the document.

data.identityDocument.dateOfBirth

string

Date of birth in YYYY-MM-DD format.

data.identityDocument.placeOfBirth

string

Place of birth.

data.identityDocument.nationality

string

Nationality.

data.identityDocument.expiryAt

string

Document expiration date in YYYY-MM-DD format.

data.identityDocument.issuedAt

string

Document issue date in YYYY-MM-DD format.

data.identityDocument.issuingAuthority

string

Authority that issued the document.

data.identityDocument.placeOfIssue

string

Location where the document was issued.

data.identityDocument.createdAt

string

ISO 8601 timestamp.

data.identityDocument.updatedAt

string

ISO 8601 timestamp.

{
  "notificationId": "a1b2c3d4-5678-9012-abcd-ef1234567890",
  "type": "VERIFICATION.STATUS_CHANGE",
  "object": "VERIFICATION",
  "createdAt": "2025-08-20T10:15:00.000Z",
  "data": {
    "id": "aB1cD2eF",
    "url": "https://app.pawapass.com/your-company/aB1cD2eF",
    "status": "APPROVED",
    "errorUrl": "https://your-website.com/error",
    "faceScan": {
      "ageEstimation": "OVER_25",
      "createdAt": "2025-08-20T09:30:00.000Z",
      "updatedAt": "2025-08-20T09:31:15.000Z"
    },
    "metadata": {
      "phoneNumber": "+260971234567",
      "jurisdiction": "ZM",
      "reason": "kyc-onboarding"
    },
    "createdAt": "2025-08-20T09:00:00.000Z",
    "createdBy": "[email protected]",
    "expiresAt": "2025-08-27T09:00:00.000Z",
    "updatedAt": "2025-08-20T10:15:00.000Z",
    "externalId": "user-zm-98765",
    "successUrl": "https://your-website.com/success",
    "supportUrl": "https://your-website.com/support",
    "requirements": [
      { "type": "DOCUMENT_SCAN" },
      { "type": "FACE_SCAN" }
    ],
    "identityDocument": {
      "type": "Government Issued Photo ID",
      "country": "Zambia",
      "serialNo": "1234567/89/0",
      "nationalNo": "Z98765432",
      "firstName": "Tisa",
      "lastName": "Banda",
      "dateOfBirth": "1997-05-10",
      "placeOfBirth": "Lusaka",
      "nationality": "ZM",
      "expiryAt": "2032-05-09",
      "issuedAt": "2022-05-10",
      "issuingAuthority": "Republic of Zambia",
      "placeOfIssue": "Lusaka",
      "createdAt": "2025-08-20T09:31:00.000Z",
      "updatedAt": "2025-08-20T10:15:00.000Z"
    }
  }
}

Verifications

​Headers

​Body

Headers

Body