Income Verification

Enabling Income Verification

To start using the Income Verification flow with your Snappt properties, the feature needs to be enabled on the property using the POST /properties/{propertyId}/income-verification endpoint.

Create an Income Verification Session

In order to create an Income Verification session, you follow the same steps in the Getting Started for Fraud Detection. Once a property has Income Verification active, then any Document Types that meet the criteria for Income Verification review will be processed after application submission.

Current uploaded documents must be classified as a PAYSTUB using the Document Upload Portal or via the Upload Document endpoint.

📘
Income Verification document criteria can be found here

Checking for the Report Ready Status

The steps for obtaining a REPORT_READY webhook are the same as they are for Fraud Detection. Once your documents have been reviewed for both Fraud and Income, then your report will be ready and the webhook will be delivered.

Obtaining a Report

In order to obtain your PDF report for Income Verification, you will use the same GET /applicants/{applicantId}/report endpoint as you would for a Fraud Detection report.

If Income Verification is active for a property or an income calculation has been made for an applicant in the past, you will be able to view the Applicant's Income Verification report if the documents have met the above criteria.

How To Fetch Available Income Calculations

Once an Income Verification report has been created, an applicant's income can be viewed using the GET /applicants/{applicantId} endpoint. If an Income calculation for an applicant is available, an incomeVerificationDetails object will be added at the root level of the response body.

If the queryParam includeDocuments=true has been included, then the income calculation for each document will have an incomeVerificationDetails object with Income Verification information.

{
    "id": "7d54e8a7-ade7-41bb-afef-0ea0254586b7",
    "fullName": "Test User",
    "firstName": "Test",
    "middleInitial": null,
    "lastName": "User",
    "email": "[email protected]",
    "phone": null,
    "notification": false,
    "entryId": "2a1956f5-b319-4f95-a56f-c7af31f5bb40",
    "insertedAt": "2024-06-13T02:56:50.000Z",
    "updatedAt": "2024-06-13T02:56:50.000Z",
    "status": "READY",
    "result": "CLEAN",
    "applicantDetailId": "ae99c8a2-6ecf-4339-8872-fb9ff68ab9e7",
    "documents": [
        {
            "id": "3d22f8df-676f-4245-bc1c-075acd591f9f",
            "insertedAt": "2024-06-13T02:56:50.000Z",
            "type": "PAYSTUB",
            "result": "CLEAN",
            "incomeVerificationDetails": {
                "calculationStartDate": "2024-06-12T00:00:00.000Z",
                "calculationEndDate": "2024-07-19T00:00:00.000Z",
                "grossIncome": 1000,
                "incomeSource": "Snappt",
                "applicantName": "Test User"
            }
        }
    ],
    "incomeVerificationDetails": {
        "calculationDate": "2024-06-13T03:01:44.972Z",
        "grossDailyIncome": 26.32,
        "grossMonthlyIncome": 789.47,
        "grossYearlyIncome": 9605.26,
        "consecutiveDays": 38,
	      "status": "ok",
        "statusDetails": []
    }
}