vInsights

About the vInsights Report

This report allows your operations team to receive and understand vInsights results as a PDF without deep data processing or lengthy integration from your developers. The vInsights Report is included free of charge for any users of vInsights version 2.0 and above.

What is in the report?

The default layout of vInsights includes a summary, six sections, and three transaction aggregate tables.

• Summary — At-a-glance scores and overview of the account, color coded to highlight areas of concern
• Sections
  1. Validation of Applicant Information — How stable is the applicant's personal information?
  2. Affordability of Payments — Can the applicant afford the proposed payment?
  3. Weekly Cash Flow Trend — What is the present running balance? Is it consistent, or trending up or down?
  4. Payment Default Risk — How likely is the applicant to default on first payment? on later payents?
  5. Income Trend — What is the stability of the applicant's income?
  6. Spending Obligation Amounts — What are the applicant's daily/weekly/bi-weekly/monthly obligations? What is the income ratio?
• Transaction Tables
  1. Income Transactions
  2. Obligation Transactions
  3. Repeat Spending Transactions

Refernce Guide

Log in to find descriptions of each field in the vInsights Reference Guide.

How to get the report

API Information

Find an overview of the API endpoint below. To see the full request and response schemas, along with detailed error codes and simulation, reference the API Documentation.

The suggested flow to pull a report:

1. Call vInsights v2.0 through the CONNECT interface or direct API call.
2. Call /v3/AffordAI using the vInsights inquiry ID and authorizing bearer token (from your ValidiFI API credentials).
3. Record the API's response JSON.
   • If the response has statusCode of 1 or 2, convert the returned Base64 string into a .pdf file.
   • If the response has statusCode of 3 or 4, record the status.errors object to identify the point of failure.

Sample Request and Responses

The vInsights response object contains a status module for HTTP 200 and 400 response. There are 4 possible statusCodes:

1. Success
2. Success with non-fatal errors
3. Fatal error from request format
4. Fatal error from dependency

POST Request

{
   "blpInquiryId": "abcdefgh-1234-5678-0000-ijklmnopqrst",
   "referenceId": "your_tracking_id",
   "customization": {
       "showPII": true
   }
}

referenceId is an optional tracking id When using API v3, target POST /v3/AffordAI

The customization and showPII parameters are optional. Set showPII to "false" if you would like consumer PII (name, address, phone, email) to be redacted on the generated PDF. The customization parameter is only available when using ValidiFI API v4 and above.

Success response

statusCode 1 or 2 responses will always contain a fileData object. Once you receive the Base64 string in the fileData.report object, use your method of preference to convert from Base64 into a .pdf file.

{
   "reportId": "ABCDEFGH-0A61-407A-B83F-EE1D5E991B70",
   "referenceId": "your_tracking_id",
   "status": {
      "statusCode": 1,
      "status": "Success",
      "errors": null
   },
   "fileData": {
      "fileExtension": "pdf",
      "reportName": "AffordAI_[referenceId]_[date]_[time]",
      "report": "[base64 file]”
   }
}

Error responses

In the event of an error, you may find a description of the issue[s] in the status module. If the error is non-fatal, you will receive an HTTP 200 response with both error data and the fileData.

{
   "reportId": "ABCDEFGH-0A61-407A-B83F-EE1D5E991B70",
   "referenceId": "your_tracking_id",
   "status": {
      "statusCode": 2,
      "status": "Success with non-fatal errors",
      "errors": [
            {
                "errorCode": 7,
                "description": "Caution: Limited data available"
            }
        ]
   },
   "fileData": {
      "fileExtension": "pdf",
      "reportName": "AffordAI_[referenceId]_[date]_[time]",
      "report": "[base64 file]”
   }
}

If the error is fatal, you will receive an HTTP 400 response and the fileData module will be null.

{
   "reportId": "ABCDEFGH-0A61-407A-B83F-EE1D5E991B70",
   "referenceId": "your_tracking_id",
   "status": {
      "statusCode": 3,
      "status": "Fatal error from request format",
      "errors": [
            {
                "errorCode": 4,
                "description": "Fatal: This blpInquiryId is not supported.
                                AffordAI requires BankLOGIN+ 2.0 or above"
            }
        ]
   },
   "fileData": null
}

Schemata and a complete list of error codes can be found in the API Documentation.

Simulated Responses

Errors and successful responses can be simulated for testing in the sandbox or production environments. Passing the optional parameter "simulate": 4 will always return the AffordAI errorCode 4, even if your submitted blpInquiryId was valid.

{
   "blpInquiryId": "abcdefgh-1234-5678-0000-ijklmnopqrst",
   "referenceId": "your_tracking_id",
    "simulate": 4
}

When using API v3, target POST /v3/AffordAI

Response

{
   "reportId": "ABCDEFGH-0A61-407A-B83F-EE1D5E991B70",
   "referenceId": "your_tracking_id",
   "status": {
      "statusCode": 3,
      "status": "Fatal error from request format",
      "errors": [
            {
    "errorCode": 4,
                "description": "Fatal: This blpInquiryId is not supported.
                                AffordAI requires BankLOGIN+ 2.0 or above"
            }
        ]
   },
   "fileData": null
}

A complete list of error codes can be found in the API Documentation.