The Closing Docs
The Closing Docs
The Closing Docs
The Closing Docs
Introduction
Authentication
Sending Income Verification Requests
Creating a Screening Group
Receiving Status Updates
Types of Webhooks
Resend Screening Request Notification
Force-Complete a Screening Group Request
Delete a Screening Group
Reports
Getting the Report Url
Getting the Report Data
Using Demo Bank Data
Powered by GitBook

Force-Complete a Screening Group Request

You can force-complete a screening group to produce a grouped report without having all the applicants complete the income screening.

Screening group requests with more than 1 applicant require all applicants to complete the income verification process in order to produce the report. This is because we need all of the applicants' income data to produce the aggregated report.

However, if for whatever reason you require the report to produced immediately, you can "force-complete" a screening group request by hitting the endpoint below. The applicants that have not completed their screening will also receive an email/text notification that their screening has been cancelled.

Be aware that if no applicants have completed the screening yet (or if they have completed the screening but submitted that they share a bank or produce no income), the report will look fairly blank.

This is an asynchronous operation, so once you hit this endpoint, wait for the SCREENING_GROUP_COMPLETEDwebhook to fire before pulling the report.

This endpoint is only available for screening group requests with more than 1 applicant.

post
Force-Complete a Screening Group

https://theclosingdocs.com/api/v1/screening_groups/{id}/complete
Request
Response
Request
Path Parameters
id
required
string
The ID of the screening group
Response
204: No Content
When the screening group has been completed and the report has begun to be produced.
​
400: Bad Request
When the screening group has only 1 screening. This operation is only available for a screening group with multiple screenings.
​
Sending Income Verification Requests - Previous
Resend Screening Request Notification
Next - Sending Income Verification Requests
Delete a Screening Group
Last updated 3 weeks ago