Experian Module

Overview

The Experian Module allows users to send a requests to Experian to retrieve information used for credit reports. These steps utilize Experian's API to send and receive credit scores and reports.

Example

This example will demonstrate how to configure the Experian Module and make a request for a Consumer Credit Report.

1. Navigate to System > Settings. Right-click on Experian Settings and select Edit.
2. In the Edit Experian Settings, enter the correct configuration values and click SAVE. Experian requires specific authentication in order to access their API.
   

Flow Steps

The steps for the Experian module can be found under the Experian category in the steps toolbox. Additionally, when the step inputs are set to Constant, the inputs can be loaded from a JSON file. An example can be found under the Request Example section.

Experian Consumer Credit Profile

The Experian Consumer Credit Profile step allows the user to enter a credit report and receive a consumer credit profile.

Experian Score Only Prequalification

The Experian Score Only Prequalification step outputs an ExperianCreditReportResponse that contains only a generic score instead of a full credit report. 

Experian Prequalification Credit Report

The Experian Prequalification Credit Report outputs an ExperianPrequalificationResponse type that contains a credit report and the score.

Experian Prequalification Credit Score

The Experian Prequalification Credit Score step outputs an ExperianPrequalificationResponse type that contains the credit score.

Request Example

Below is an example for an ExperianPrequalificationRequest and ExperianCreditReport Response types.

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "string",
        "firstName": "string",
        "middleName": "string",
        "generationCode": "string"
      },
      "dob": {
        "dob": "string"
      },
      "ssn": {
        "ssn": "string"
      },
      "driverslicense": {
        "number": "string",
        "state": "string"
      },
      "phone": [
        {
          "number": "string",
          "type": "string"
        }
      ],
      "employment": {
        "employerName": "string",
        "employerAddress": {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "zipCode": "string"
        }
      },
      "currentAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string"
      },
      "previousAddress": [
        {
          "line1": "string",
          "line2": "string",
          "city": "string",
          "state": "string",
          "zipCode": "string"
        }
      ]
    }
  },
  "requestor": {
    "subscriberCode": "string"
  },
  "permissiblePurpose": {
    "type": "string",
    "terms": "string",
    "abbreviatedAmount": "string"
  },
  "resellerInfo": {
    "endUserName": "string"
  },
  "freezeOverride": {
    "primaryApplFreezeOverrideCode": "string"
  },
  "vendorData": {
    "vendorNumber": "string",
    "vendorVersion": "string"
  },
  "addOns": {
    "riskModels": {
      "modelIndicator": [
        "string"
      ],
      "scorePercentile": "string"
    }
  },
  "customOptions": {
    "optionId": [
      "string"
    ]
  }
}

Response Example

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "KOTHARI",
        "firstName": "MARIA",
        "middleName": ""
      },
      "dob": {
        "dob": "1959"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "PO BOX 1116",
        "city": "KEALAKEKUA",
        "state": "HI",
        "zipCode": "967501116"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  }
}