Types of Webhooks

You can receive real-time status updates of your income verification requests by using webhooks.

You can receive notifications from The Closing Docs via webhooks when the following occurs:

  • When an applicant has begun an income verification request

  • When an applicant successfully completes an income verification request

  • When a screening group is completed successfully

  • When an applicant states that their bank is not supported

  • When an applicant states that they share a bank, or do not produce any income

    • This is only for AIVs with multiple applicants

  • When a income verification report is 2 days from expiring

  • When a income verification report has expired

The webhook will be sent as a POST request to the webhook_url attribute of the screening group you created.

BEGIN_SCREENING

The Closing Docs fires the BEGIN_SCREENING webhook when an applicant signs up and begins the AIV screening.

Example:

{
"code": "BEGIN_SCREENING",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4",
"screening_id": "4516efb4-82ed-43cd-a55a-ba93d4914562"
}

SCREENING_COMPLETED

Once the applicant finishes an AIV, the SCREENING_COMPLETED webhook will fire. Note that this event fires when an individual AIV is completed, not the entire screening group.

Example:

{
"code": "SCREENING_COMPLETED",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4",
"screening_id": "4516efb4-82ed-43cd-a55a-ba93d4914562"
}

SCREENING_GROUP_COMPLETED

Once every applicant from the screening group has completed their income verification request, the SCREENING_GROUP_COMPLETED webhook will fire. This means that the income verification report has been generated and is ready to be presented.

Example:

{
"code": "SCREENING_GROUP_COMPLETED",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4"
}

BANK_NOT_SUPPORTED

If the applicant states that their bank is not supported, the BANK_NOT_SUPPORTED webhook will fire. The bank the applicant shares will be in the value property.

Example:

{
"code": "BANK_NOT_SUPPORTED",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4",
"screening_id": "4516efb4-82ed-43cd-a55a-ba93d4914562",
"value": "Small Alaskan Credit Union"
}

SHARE_BANK

If the applicant states that they share a bank with another applicant, the SHARE_BANK webhook will fire. This only occurs with screening groups with more than 1 applicant. Example:

{
"code": "SHARE_BANK",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4",
"screening_id": "4516efb4-82ed-43cd-a55a-ba93d4914562"
}

NO_INCOME

If the applicant states that they produce no income, the NO_INCOME webhook will fire. This only occurs with screening groups with more than 1 applicant.

Example:

{
"code": "NO_INCOME",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4",
"screening_id": "4516efb4-82ed-43cd-a55a-ba93d4914562"
}

REPORT_SOON_TO_EXPIRE

Our reports expire in 14 days in order to remain FCRA compliant. Two days before the report expires, we will send a webhook providing the following notice: REPORT_SOON_TO_EXPIRE.

Example:

{
"code": "REPORT_SOON_TO_EXPIRE",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4"
}

REPORT_EXPIRED

Our reports expire in 14 days in order to remain FCRA compliant. Once the report expires, we will send a webhook providing the following notice: REPORT_EXPIRED.

Example:

{
"code": "REPORT_EXPIRED",
"screening_group_id": "905963d4-0649-4046-8f39-7997a9e45ed4"
}

‚Äč