POST request to your pre-configured callback URL when a verification event occurs. See Webhooks for setup details and best practices.
Headers
application/jsonSHA256 HMAC signature of the raw request body, signed with your secret key. See Signature verification.
Body
Unique identifier for this notification. Use for deduplication.
Event type. One of
VERIFICATION.STATUS_CHANGE or VERIFICATION.IDENTITY_DOCUMENT_CHANGE.Always
VERIFICATION.ISO 8601 timestamp of when the event was created.
The full verification object.
Show data properties
Show data properties
Verification ID.
Your external identifier for this verification.
Array of verification requirements (
DOCUMENT_SCAN, FACE_SCAN).URL where the user completes the verification.
Current status:
CREATED, STARTED, EXPIRED, USER_DATA_COLLECTED, REVIEW, APPROVED, or DECLINED.ISO 3166-1 alpha-2 country code associated with this verification (e.g.,
ZM, KE, NG). Null if not set.Phone number associated with this verification (e.g.,
+260971234567). Null if not provided.Review outcome details. Null when verification has not been reviewed or no review reason is available.
Show reviewResult properties
Show reviewResult properties
Mapped review outcome reason. One of
CAPTURE_ISSUE, DOCUMENT_VALIDITY, IMAGE_QUALITY, or GENERIC.Optional metadata provided when creating the verification.
Redirect URL after successful verification.
Redirect URL on error.
Support URL shown during verification.
Extracted identity document data. Null if not yet available.
Show identityDocument properties
Show identityDocument properties
Document type. One of
PASSPORT, NATIONAL_ID, DRIVER_LICENSE, REFUGEE_ID, VOTER_ID, RESIDENCE_PERMIT.ISO 3166-1 alpha-2 country code of the issuing country (e.g.,
ZM, KE, NG).Serial number of the document.
National identification number.
First name as extracted from the document.
Last name as extracted from the document.
Date of birth in
YYYY-MM-DD format.Place of birth.
Nationality.
Document expiration date in
YYYY-MM-DD format.Document issue date in
YYYY-MM-DD format.Authority that issued the document.
Location where the document was issued.
ISO 8601 timestamp.
ISO 8601 timestamp.
Face scan results. Null if not yet available.
Email/identifier of the person who created this verification.
ISO 8601 expiration date of the verification session.
ISO 8601 creation timestamp.
ISO 8601 last update timestamp.
{
"notificationId": "a1b2c3d4-5678-9012-abcd-ef1234567890",
"type": "VERIFICATION.STATUS_CHANGE",
"object": "VERIFICATION",
"createdAt": "2025-08-20T10:15:00.000Z",
"data": {
"id": "aB1cD2eF",
"externalId": "user-zm-98765",
"requirements": [
{ "type": "DOCUMENT_SCAN" },
{ "type": "FACE_SCAN" }
],
"url": "https://app.pawapass.com/your-company/aB1cD2eF",
"status": "APPROVED",
"country": "ZM",
"phoneNo": "+260971234567",
"reviewResult": null,
"metadata": {
"reason": "kyc-onboarding",
"channel": "mobile-app",
"department": "compliance"
},
"successUrl": "https://your-website.com/success",
"errorUrl": "https://your-website.com/error",
"supportUrl": "https://your-website.com/support",
"identityDocument": {
"type": "NATIONAL_ID",
"country": "ZM",
"serialNo": "9876543/21/1",
"nationalNo": "Z12345678",
"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"
},
"faceScan": {
"ageEstimation": "OVER_25",
"createdAt": "2025-08-20T09:30:00.000Z",
"updatedAt": "2025-08-20T09:31:15.000Z"
},
"createdBy": "[email protected]",
"expiresAt": "2025-08-27T09:00:00.000Z",
"createdAt": "2025-08-20T09:00:00.000Z",
"updatedAt": "2025-08-20T10:15:00.000Z"
}
}