Getting the Report Data

When the report is ready, you can get the report in json format by hitting the following endpoint.

When the screening group is completed, we will provide the data used to populate our report in JSON format.

If the screening group is still in progress and the report has not been created yet, the response will have a status code of 404 Not Found. If the report has expired, the response will have a status code of 410 Gone.

Note that the schemas for an individual income report and an income report with multiple applicants differ. The main difference is that the combined income report has an array of individual screenings.

get
Get Report JSON Data

https://theclosingdocs.com/api/v1/screening_groups/{id}/report/data
Request
Response
Request
Path Parameters
id
optional
string
The ID of the screening group
Response
200: OK
The response for a successfully completed individual income verification report
{
"total_net_income": 280000,
"two_month_avg_monthly_net_income": 35000,
"three_month_avg_monthly_net_income": 35000,
"six_month_avg_monthly_net_income": 35000,
"nine_month_avg_monthly_net_income": null,
"twelve_month_avg_monthly_net_income": null,
"total_non_recurring_deposits": 60340,
"summary_timespan_length": 239,
"bank_connections": [
{
"accounts": [
{
"name": "Dag Credit Card",
"type": "Credit",
"available_balance": null,
"current_balance": null
},
{
"name": "Saving Plus",
"type": "Savings",
"available_balance": 10500,
"current_balance": 30500
},
{
"name": "Checking Account",
"type": "Checking",
"available_balance": 150000,
"current_balance": 160000
}
],
"income": {
"total_net_income": 420000,
"two_month_avg_monthly_net_income": 35000,
"three_month_avg_monthly_net_income": 35000,
"six_month_avg_monthly_net_income": 35000,
"nine_month_avg_monthly_net_income": 35000,
"twelve_month_avg_monthly_net_income": null,
"total_non_recurring_deposits": 35000,
"income_streams": [
{
"name": "The Closing Docs Payroll",
"transactions": [
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "04/01/2020"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "03/01/2020"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "02/01/2020"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "01/01/2020"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "12/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "11/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "10/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "09/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "08/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "07/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "06/01/2019"
},
{
"amount": 35000,
"name": "The Closing Docs Payroll",
"date": "05/01/2019"
}
],
"monthly_income": 34375,
"start_date": "05/01/2019",
"end_date": "04/01/2020"
}
],
"non_recurring_deposit_streams": [
{
"name": "The Closing Docs Irregular Income",
"transactions": [
{
"amount": 35000,
"name": "The Closing Docs Irregular Income",
"date": "04/01/2020"
}
]
}
],
"start_date": "05/01/2019",
"end_date": "04/01/2020",
"transaction_timespan_length": 336
},
"institution_name": "Chase"
},
{
"accounts": [
{
"name": "Checking",
"type": "Checking",
"available_balance": 100000,
"current_balance": 100000
},
{
"name": "Credit Card",
"type": "Credit Card",
"available_balance": 100000,
"current_balance": 100000
},
{
"name": "Loan",
"type": "Loan",
"available_balance": 100000,
"current_balance": 100000
},
{
"name": "Savings",
"type": "Savings",
"available_balance": 100000,
"current_balance": 100000
}
],
"income": {
"total_net_income": 0,
"two_month_avg_monthly_net_income": 0,
"three_month_avg_monthly_net_income": 0,
"six_month_avg_monthly_net_income": 0,
"nine_month_avg_monthly_net_income": null,
"twelve_month_avg_monthly_net_income": null,
"total_non_recurring_deposits": 25340,
"income_streams": [],
"non_recurring_deposit_streams": [
{
"name": "Paycheck",
"transactions": [
{
"amount": 5208,
"name": "Paycheck",
"date": "02/09/2020"
},
{
"amount": 6505,
"name": "Paycheck",
"date": "02/01/2020"
},
{
"amount": 6547,
"name": "Paycheck",
"date": "01/05/2020"
},
{
"amount": 7080,
"name": "Paycheck",
"date": "12/31/2019"
}
]
}
],
"start_date": "08/14/2019",
"end_date": "04/09/2020",
"transaction_timespan_length": 239
},
"institution_name": "Wells Fargo"
}
],
"identity": {
"full_name": "Bob Smith",
"email": "bob@gmail.com"
},
"income_explanation": "This is an income explanation",
"reason_completed": "finished",
"created_at": "04/10/2020"
}
404: Not Found
The response if the report has not been created yet
410: Gone
The response if the report has expired

Response Schema

IndividualReport Schema

Field

Type

Description

recurring

CalculatedIncomeMetrics

The calculated income metrics for all the recurring income from the report's bank connections. The timespan of these metrics are summary_timespan_length.

non_recurring

CalculatedIncomeMetrics

The calculated income metrics for all the non-recurring income from the report's bank connections. The timespan of these metrics are summary_timespan_length.

summary_timespan_length

number

The timespan length in days that the recurring and non-recurringCalculatedIncomeMetrics cover, starting from the date the report was created. This is the minimum timespan length between bank_connnections.

identity

Identity

The applicant's identity information

bank_connections

BankConnection[]

The banks that the applicant has added onto the income verification request

income_explanation

string

An explanation given by the applicant that is used to bring context to their income summary.

reason_completed

string

The reason the screening was completed. If this is a report with a single applicant, the value will either be finished or no_bank. If this is part of a report with multiple applicants, the value can be finished, no_bank, share_bank, or no_income.

created_at

string

The date the report was created at. Formatted “08/25/2019”.

The IndividualReport schema comprises of an income summary for all the bank connections that the applicant has attached to their income verification request.

The most important thing to note is that the summary_timespan_length is the minimum timespan of all the bank connections attached to the request. This is also the timespan that is used to calculate the recurring and non-recurring CalculatedIncomeMetrics. The reason we do this is because not all financial institutions provide the same amount data history. Most institutions provide 12 months, but some provide only 6 months or even 3 months of data history. Therefore, in order to provide the most accurate information, we can only confidently compute the total and monthly average income based on the banks' shortest timespans.

CalculatedIncomeMetrics Schema

Field

Type

Description

total

number

The total amount of income in cents received by the applicant(s) over a timespan, starting from the date the report was created.

two_month_avg_monthly

number | null

The average amount of income per month in cents the applicant(s) have received in the past 2 months. This value will be null if the timespan is less than 50 days.

three_month_avg_monthly

number | null

The average amount of income per month in cents the applicant(s) have received in the past 3 months. This value will be null if the timespan is less than 80 days.

six_month_avg_monthly

number | null

The average amount of income per month in cents the applicant(s) have received in the past 6 months.This value will be null if the timespan is less than 170 days.

nine_month_avg_monthly

number | null

The average amount of income per month in cents the applicant(s) have received in the past 9 months.This value will be null if the timespan is less than 260 days.

twelve_month_avg_monthly

number | null

The average amount of income per month in cents the applicant(s) have received in the past 12 months. This value will be null if the timespan is less than 350 days.

Identity Schema

Field

Type

Description

full_name

string

The applicant's full name

email

string

The applicant's email

BankConnection Schema

Field

Type

Description

income

IncomeSummary

The income summary for the connected bank

accounts

Account[]

The accounts for the connected bank

institution_name

string

The name of the institution

IncomeSummary Schema

Field

Type

Description

recurring

CalculatedIncomeMetrics

The calculated income metrics for all the recurring income from the bank connection's income_streams. The timespan of these metrics are transaction_timespan_length.

non_recurring

CalculatedIncomeMetrics

The calculated income metrics for all the recurring income from the bank connection's non_recuring_deposit_streams. The timespan of these metrics are transaction_timespan_length.

income_streams

IncomeStream[]

A list of the applicant's recurring deposit streams

non_recurring_deposit_streams

NonRecurringDepositStream[]

A list of the applicant's non-recurring deposit streams

start_date

string

The beginning date of the time period the income summary covers. Formatted “08/25/2019”.

end_date

string

The end date of the time period the income summary covers. Formatted “08/25/2020”.

transaction_timespan_length

number

The timespan length in days of the transaction history pulled, starting from the date the report was created. This can also be thought of as the number of days between start_date and end_date.

IncomeStream Schema

Field

Type

Description

name

string

The name of the income stream. This is determined by the transaction's description from the bank.

monthly_income

number

The monthly income of the income stream in cents

start_date

string

The start date of the income stream. Formatted “08/25/2019”.

end_date

string

The end date of the income stream. Formatted “08/25/2020”.

transactions

Transaction[]

A list of the transactions that make up the income stream

NonRecurringDepositStream Schema

Field

Type

Description

name

string

The name of the non-recurring deposit stream. This is determined by the transaction's description from the bank.

transactions

Transaction[]

A list of the transactions that make up the deposit stream

Transaction Schema

Field

Type

Description

name

string

The name of the deposit

amount

number

The amount of the deposit in cents

date

string

The date of the deposit. Formatted “08/25/2019”.

Account Schema

Field

Type

Description

name

string

The name of the applicant’s account, assigned by the user or the financial institution

type

string

The type of account. For example, Checking, or Savings

current_balance

number

The current balance of the account in cents

available_balance

number | null

The available balance of the account, in cents. When the institution does not support available_balance, the value will be null. To learn what the difference between current and available balance, click here.

average_balance

number | null

The average balance of the account for the past 6 months, in cents. When the institution does not support average_balance, the value will be null.

Combined Report JSON Data

The JSON schema for combined reports, or reports with multiple applicants, differs slightly by having the reports field comprise of the individual applicant reports.

In a combined report, if the IndividualReport has a reason_completed other than finished, the only fields that will be present in the IndividualReport response will be identity, reason_completed and created_at.

CombinedReport Schema

Field

Type

Description

recurring

CalculatedIncomeMetrics

The calculated income metrics for all the recurring income in cents received by the applicants over summary_timespan_length

non_recurring

CalculatedIncomeMetrics

The calculated income metrics for all the non-recurring income in cents received by the applicants over summary_timespan_length

summary_timespan_length

number

The timespan length in days that the total_net_income and total_non_recurring_deposits metrics cover, starting from the date the report was created. This is the minimum timespan between reports.

reports

IndividualReport[]

The individual applicant reports that comprise of the CombinedReport

created_at

string

The date the report was created at. Formatted “08/25/2019”.

Sample CombinedReport response

{
"reports": [
{
"identity": {
"full_name": "Bob Smith",
"email": "bob@gmail.com"
},
"reason_completed": "share_bank",
"created_at": "04/11/2020"
},
{
"identity": {
"full_name": "John Smith",
"email": "john@gmail.com"
},
"reason_completed": "finished",
"created_at": "04/11/2020",
"recurring": {
"total": 600000,
"two_month_avg_monthly": 50000,
"three_month_avg_monthly": 50000,
"six_month_avg_monthly": 50000,
"nine_month_avg_monthly": 50000,
"twelve_month_avg_monthly": 50000
},
"non_recurring": {
"total": 0,
"two_month_avg_monthly": 0,
"three_month_avg_monthly": 0,
"six_month_avg_monthly": 0,
"nine_month_avg_monthly": 0,
"twelve_month_avg_monthly": 0
},
"summary_timespan_length": 361,
"bank_connections": [
{
"accounts": [
{
"name": "Checking",
"type": "Checking",
"available_balance": 10000,
"current_balance": 11000
},
{
"name": "Saving",
"type": "Savings",
"available_balance": 20000,
"current_balance": 21000
}
],
"income": {
"recurring": {
"total": 600000,
"two_month_avg_monthly": 50000,
"three_month_avg_monthly": 50000,
"six_month_avg_monthly": 50000,
"nine_month_avg_monthly": 50000,
"twelve_month_avg_monthly": 50000
},
"non_recurring": {
"total": 0,
"two_month_avg_monthly": 0,
"three_month_avg_monthly": 0,
"six_month_avg_monthly": 0,
"nine_month_avg_monthly": 0,
"twelve_month_avg_monthly": 0
},
"income_streams": [
{
"name": "United Airlines",
"transactions": [
{
"amount": 50000,
"name": "United Airlines",
"date": "03/14/2020"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "02/13/2020"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "01/14/2020"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "12/15/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "11/15/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "10/16/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "09/16/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "08/17/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "07/18/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "06/18/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "05/19/2019"
},
{
"amount": 50000,
"name": "United Airlines",
"date": "04/19/2019"
}
],
"monthly_income": 50000,
"start_date": "04/19/2019",
"end_date": "03/14/2020"
}
],
"non_recurring_deposit_streams": [],
"start_date": "04/16/2019",
"end_date": "04/11/2020",
"transaction_timespan_length": 361
},
"institution_name": "Wells Fargo"
}
],
"income_explanation": null
}
],
"total_net_income": 600000,
"two_month_avg_monthly_net_income": 50000,
"three_month_avg_monthly_net_income": 50000,
"six_month_avg_monthly_net_income": 50000,
"twelve_month_avg_monthly_net_income": 50000,
"total_non_recurring_deposits": 0,
"summary_timespan_length": 361,
"created_at": "04/11/2020"
}