Webhook Event Types

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

• ACCEPTED_DOCUMENT: This event is fired when Snappt has finished running basic checks of a document that has been uploaded to an applicant session. If the document's status is SUCCESS, you can submit the applicant session and have the documents reviewed. If the document's status indicates it was not accepted, you can remove the document using the API and submit another one. This webhook DOES NOT imply a submitted document, just that a document has passed the initial checks.
  • NOTE: This webhook event is only needed if you are not using the synchronous submit endpoint. If you are using the synchronous submit endpoint then this event is not needed.
• 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

ACCEPTED_DOCUMENT SUCCESS

JSON

{
    "eventType": "ACCEPTED_DOCUMENT",
    "unauthenticatedSessionId": "8bc34316-7e0c-4b62-bd1a-1a3e62b1628e",
    "data": {
        "id": "204c2d4a-dfad-49d9-bcbd-533fb7155b6d",
        "hasExceededPageLimit": null,
        "hasPasswordProtection": null,
        "hasText": true,
        "jobsError": null,
        "processStatus": "SUCCESS"
    },
    "apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
    "webhookId": "e15f0de4-1b37-4066-8cf3-eb7fd5418281",
    "applicantId": null,
    "applicantDetailId": "ce05bc52-4dc5-4279-ab47-12db37ecfa53"
}

ACCEPTED_DOCUMENT FAILED

JSON

{
    "data": {
        "has_exceeded_page_limit": false,
        "has_password_protection": false,
        "has_text": false,
        "id": "7f01e495-137b-4621-b03a-753dc1bf0cc0",
        "jobs_error": [
            {
                "code": "TEXT_NOT_FOUND",
                "message": "The document you uploaded was created using a scanner",
                "name": "ScannedDocuments"
            }
        ],
        "process_status": "FAILED",
        "unauthenticated_session_id": "ededc404-0746-4dde-a149-08cff6673a8e"
    },
    "event_type": "ACCEPTED_DOCUMENT",  
    "apiKeyId": "3dd44705-1365-4f1e-b167-04830df3627d",
    "webhookId": "e15f0de4-1b37-4066-8cf3-eb7fd5418281",
    "applicantId": null,
    "applicantDetailId": "ce05bc52-4dc5-4279-ab47-12db37ecfa53"

}

REPORT_READY CLEAN

JSON

{
    "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

JSON

{
    "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

JSON

{
    "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"
}