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 Report JSON Data
GET
https://api.payscore.com/api/v1/screening_groups/{id}/report/data
Path Parameters
{
"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"
}
Response Schema
IndividualReport Schema
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 IncomeData
metrics. 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.
IncomeData Schema
Identity Schema
BankConnection Schema
IncomeSummary Schema
IncomeStream Schema
Transaction Schema
Account Schema
Sample IndividualReport response
{
"screening_id": "9314c3u2-8904-4eea-b947-17df724f9382",
"identity": {
"full_name": "John Smith",
"email": "john@gmail.com"
},
"reason_completed": "finished",
"income_multiplier_threshold": 2.5,
"income_multiplier": 2.6,
"income_multiplier_result": "above",
"income_criteria_results": null,
"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,
"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": {
"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": []
},
"start_date": "04/16/2019",
"end_date": "04/11/2020",
"transaction_timespan_length": 361
},
"institution_name": "Wells Fargo"
}
],
"income_explanation": 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 screening_id
, identity
, reason_completed
and created_at
.
CombinedReport Schema
{
"reports": [
{
"screening_id": "2714c767-8904-4eea-b947-17df724f93ed",
"identity": {
"full_name": "Bob Smith",
"email": "bob@gmail.com"
},
"reason_completed": "share_bank",
"created_at": "04/11/2020"
},
{
"screening_id": "9314c3u2-8904-4eea-b947-17df724f9382",
"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,
"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": {
"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": []
},
"start_date": "04/16/2019",
"end_date": "04/11/2020",
"transaction_timespan_length": 361
},
"institution_name": "Wells Fargo"
}
],
"income_explanation": null
}
],
"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,
"income_multiplier_threshold": 2.5,
"income_multiplier": 2.6,
"income_multiplier_result": "above",
"income_criteria_results": null,
"created_at": "04/11/2020"
}
Income Criteria
The schema for reports using income criteria (either individual or combined), differs slightly by having the income_criteria_results
field comprise of the calculated criteria results instead of the top-level income_multiplier_result
and income_multiplier_threshold
, which are null when income criteria is used.
IncomeCriteriaResult Schema
IncomeCriteria categories
Sample Income Criteria results section
"income_criteria_results": [
{
"result": "met",
"multiplier_result": 3.3,
"multiplier_threshold": 2.5,
"criteria": "three_month_avg_monthly_net_income_cents"
},
{
"result": "met",
"multiplier_result": 3.8,
"multiplier_threshold": 2.5,
"criteria": "combined_three_month_avg_monthly_net_income_cents"
},
{
"result": "not_met",
"multiplier_result": 8.4,
"multiplier_threshold": 10,
"criteria": "available_balance_sum_cents"
},
{
"result": "met",
"multiplier_result": null,
"multiplier_threshold": null,
"criteria": "account_name_mismatch_detection"
}
]
}
Last updated