Webhook Event Types
Fraud Detection
The Snappt Enterprise API allows you to create and manage webhooks that notify you when events happen on your applicant sessions and documents:
- APPLICATION_SUBMITTED: This event is fired when Snappt has received the completed submission of an applicant's documents.
- REPORT_READY: This event is fired when Snappt has finished reviewing an applicant's documents for authenticity and rendered a verdict (CLEAN, INSUFFICIENT, or EDITED). To receive this event, you need to create an applicant session, attach documents and call
POST /submit
on the session to submit it for processing.
Examples
APPLICATION_SUBMITTED
{
"eventType": "APPLICATION_SUBMITTED",
"apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
"webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753",
"applicantId": "522e9dd6-5162-4cd4-8428-d88f244ed661",
"applicantDetailId": "ce05bc52-4dc5-4279-ab47-12db37ecfa53"
}
REPORT_READY CLEAN
{
"eventType": "REPORT_READY",
"data": {
"id": "b2432c5f-fd72-452e-bdad-ee63ece08a74",
"note": null,
"result": "CLEAN",
"status": "READY"
},
"apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
"webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753",
"applicantId": "522e9dd6-5162-4cd4-8428-d88f244ed661",
"applicantDetailId": "ce05bc52-4dc5-4279-ab47-12db37ecfa53"
}
REPORT_READY FAILED
{
"eventType": "REPORT_READY",
"data": {
"id": "d2530fde-4695-45e6-a288-a2f6d2fafce5",
"note": "additional notes here",
"result": "EDITED",
"status": "READY"
},
"apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
"webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753",
"applicantId": "f640b76f-3793-43db-8fa9-5c3c843b042a",
"applicantDetailId": "7b4e5a9f-3937-4d15-ade8-3de9c4bcad3e"
}
REPORT_READY INSUFFICIENT
{
"eventType": "REPORT_READY",
"data": {
"id": "d2530fde-4695-45e6-a288-a2f6d2fafce5",
"note": "The documents you submitted cannot be accepted because they have been downloaded using a process called “Print to PDF”. Please go directly to your financial institution or payroll provider’s website to download the original PDF version of these documents. Do not rename the file.",
"result": "UNDETERMINED",
"status": "READY"
},
"apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
"webhookId": "6ea91907-57b4-446c-b8b3-d4e72c581753",
"applicantId": "f640b76f-3793-43db-8fa9-5c3c843b042a",
"applicantDetailId": "7b4e5a9f-3937-4d15-ade8-3de9c4bcad3e"
}
Updated 4 days ago