Equifax Module
  • 24 Jun 2022
  • 1 Minute to read
  • Dark
    Light
  This documentation version is deprecated, please click here for the latest version.

Equifax Module

  • Dark
    Light

Article summary

Overview

The Equifax Module allows a user to send a request to Equifax for a Consumer Credit Report.

For more information on Equifax’s APIs, go to https://developer.equifax.com/products/apiproducts/credit-reports.
The Equifax Module will need to be installed. To learn how to install a module, see Installing Modules. 


Example

  1. Navigate to System > Settings. Right-click on Equifax Settings and select Edit.
  2. In the Edit Equifax Settings dialog window, enter the correct configuration values and click SAVE.
    For more information on how to configure Equifax authentication, go to https://developer.equifax.com/documentation.


Flow Step

  1. When in a Flow Designer, the step Get Consumer Credit Report is available. It is found by navigating to INTEGRATION > EQUIFAX > CONSUMER CREDIT REPORT in the Steps Toolbox.
  2. On the Properties panel, select Unknown next to the Request field under the INPUTS category and select Build Data. Click Unknown for the Consumers field and select Build Data.


Request Example

{
 "consumers": {
    "name": [
      {
        "identifier": "current",
        "firstName": "SHEMICA",
        "lastName": "XXSHJF",
        "middleName": "FAYE",
        "suffix": "X"
      }
    ],
    "socialNum": [
      {
        "identifier": "current",
        "number": "666795307"
      }
    ],
    "dateOfBirth": "04281987",
    "addresses": [
      {
        "identifier": "current",
        "houseNumber": "7249",
        "streetName": "PAJJ ZAFW",
        "streetType": "LN",
        "apartmentNumber": "12",
        "city": "HUMBLE",
        "state": "TX",
        "zip": "77396"
      }
    ],
    "phoneNumbers": [
      {
        "identifier": "current",
        "number": "4585856325"
      }
    ],
    "employments": {
      "occupation": "VELLA",
      "employerName": "XYZ"
    }
  },
  "customerReferenceIdentifier": "JSON",
  "customerConfiguration": {
    "equifaxUSConsumerCreditReport": {
      "memberNumber": "999XX00000",
      "securityCode": "XXX",
      "codeDescriptionRequired": true,
      "models": [
        {
          "identifier": "02583"
        }
      ],
      "endUserInformation": {
        "endUsersName": "ALABASTER INC",
        "permissiblePurposeCode": "01"
      },
      "customerCode": "BQ81",
      "multipleReportIndicator": "F",
      "ECOAInquiryType": "Individual",
      "optionalFeatureCode": [
        "X"
      ],
      "pdfComboIndicator": "Y",
      "vendorIdentificationCode": "FI"
    }
  }
}



Was this article helpful?