Webhook Event Types

Identity Verification

The Snappt Enterprise API allows you to create and manage webhooks that notify you when events happen on your identity verification sessions and documents:

  • IDV_REPORT_READY: This event is fired when Snappt has finished reviewing an applicant's identity verifications documents for authenticity and rendered a verdict (PASS or FAIL). To receive this event, you need to generate an identity verification session and complete the prompts.

Examples

IDV_REPORT_READY PASS

{
    "eventType": "IDV_REPORT_READY",
    "data": {
        "idVerificationId": "b2432c5f-fd72-452e-bdad-ee63ece08a74",
        "status": "PASS"
    },
    "apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
    "webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753"
}

IDV_REPORT_READY FAIL

{
    "eventType": "IDV_REPORT_READY",
    "data": {
        "idVerificationId": "b2432c5f-fd72-452e-bdad-ee63ece08a74",
        "status": "FAIL"
    },
    "apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
    "webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753"
}

Did this page help you?