Contents x
Experian Module
  • 11 Dec 2024
  • 7 Minutes to read
  • Print
  • Dark
    Light
Contents

Experian Module

  • Updated on 11 Dec 2024
  • 7 Minutes to read
  • Print
  • Dark
    Light
Article summary

Module Details

Last Modified3/23/2022
Installation LocationGithub(7.10+). The module can also be installed from the System > Features page.
Restart Required?No
Step Location Experian
Settings Location System > Settings > Experian Settings
Prerequisites
  • Knowledge and familiarity with Experian's API

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








Configuration

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

Flow Steps

The steps for the Experian Module can be found under the Experian category in the 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.

Step Settings

In v8.8, the Experian steps include a setting called Override Credentials, which allows the user to change configuration settings for the step.

Experian Consumer Credit Profile

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

Input Parameter TypeDescription
ExperianCreditReportRequestJSON formatted input to send a request to Experian.

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. 

Input Parameter TypeDescription
ExperianCreditReportRequestJSON formatted input to send a request to Experian.

Experian Prequalification Credit Report

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

Input Parameter TypeDescription
ExperianPrequalificationRequestJSON formatted input to send a request to Experian.

Experian Prequalification Credit Score

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

Input Parameter TypeDescription
ExperianPrequalificationRequestJSON formatted input to send a request to Experian.

Experian Verify 

The Experian Verify step outputs an ExperianVerifyResponse type of verification information.

Input Parameter TypeDescription
ExperianVerifyResponseJSON formatted input to send a request to Experian.

Consumer Credit Report Test Cases

Successful Test Cases

Success 1:

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "CANN",
        "firstName": "JOHN",
        "middleName": "N"
      },
      "dob": {
        "dob": "1955"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "510 MONDRE ST",
        "city": "MICHIGAN CITY",
        "state": "IN",
        "zipCode": "46360"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "08"
  },
  "resellerInfo": {
    "endUserName": "CPAPIV2TC21"
  },
  "vendorData": {
    "vendorNumber": "072",
    "vendorVersion": "V1.29"
  },
  "addOns": {
    "directCheck": "",
    "demographics": "Only Phone",
    "clarityEarlyRiskScore": "Y",
    "liftPremium": "Y",
    "clarityData": {
      "clarityAccountId": "0000000",
      "clarityLocationId": "000000",
      "clarityControlFileName": "test_file",
      "clarityControlFileVersion": "0000000"
    },
    "renterRiskScore": "N",
    "rentBureauData": {
      "primaryApplRentBureauFreezePin": "1234",
      "secondaryApplRentBureauFreezePin": "112233"
    },
    "riskModels": {
      "modelIndicator": [
        ""
      ],
      "scorePercentile": ""
    },
    "summaries": {
      "summaryType": [
        ""
      ]
    },
    "fraudShield": "Y",
    "mla": "",
    "ofacmsg": "",
    "consumerIdentCheck": {
      "getUniqueConsumerIdentifier": ""
    },
    "joint": "",
    "paymentHistory84": "",
    "syntheticId": "N",
    "taxRefundLoan": "Y",
    "sureProfile": "Y",
    "incomeAndEmploymentReport": "Y",
    "incomeAndEmploymentReportData": {
      "verifierName": "Experian",
      "reportType": "ExpVerify-Plus"
    }
  },
  "customOptions": {
    "optionId": [
      "COADEX"
    ]
  }
}

Success 2:

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "ARMSTRONG",
        "firstName": "KARL",
        "middleName": "E"
      },
      "dob": {
        "dob": "1959"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "1073 BUCKINGHAM DR",
        "city": "CAROL STREAM",
        "state": "IL",
        "zipCode": "60188"
      }
    },
    "secondaryApplicant": {
      "name": {
        "lastName": "REYNOLDS",
        "firstName": "ROBERTS"
      },
      "dob": {
        "dob": "10041962"
      },
      "ssn": {
        "ssn": "333333333"
      },
      "driverslicense": {
        "number": "A00000000000",
        "state": "CT"
      },
      "employment": {
        "employerName": "HOMELAND SECURITY"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": ""
  },
  "resellerInfo": {
    "endUserName": "CPAPIV2TC24"
  },
  "vendorData": {
    "vendorNumber": "072",
    "vendorVersion": "V1.29"
  },
  "addOns": {
    "directCheck": "",
    "demographics": "Geocode and Phone",
    "clarityEarlyRiskScore": "Y",
    "clarityData": {
      "clarityAccountId": "0000000",
      "clarityLocationId": "000000",
      "clarityControlFileName": "test_file2",
      "clarityControlFileVersion": "0000000"
    },
    "renterRiskScore": "Y",
    "rentBureauData": {
      "primaryApplRentBureauFreezePin": "1234",
      "secondaryApplRentBureauFreezePin": "112233"
    },
    "riskModels": {
      "modelIndicator": [
        ""
      ],
      "scorePercentile": ""
    },
    "summaries": {
      "summaryType": [
        ""
      ]
    },
    "fraudShield": "Y",
    "mla": "",
    "ofacmsg": "",
    "consumerIdentCheck": {
      "getUniqueConsumerIdentifier": ""
    },
    "joint": "",
    "paymentHistory84": "",
    "syntheticId": "Y",
    "taxRefundLoan": "N",
    "sureProfile": "Y",
    "fcraAttributes": "Y",
    "ascendGoData": {
      "solutionId": "TESTSOLID"
    }
  },
  "customOptions": {
    "optionId": [
      "ASCEND_GO"
    ]
  }
}

Success 3:

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "ARMSTRONG",
        "firstName": "KARL",
        "middleName": "E"
      },
      "dob": {
        "dob": "1959"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "1073 BUCKINGHAM DR",
        "city": "CAROL STREAM",
        "state": "IL",
        "zipCode": "60188"
      }
    },
    "secondaryApplicant": {
      "dob": {
        "dob": "10041962"
      },
      "ssn": {
        "ssn": ""
      },
      "driverslicense": {
        "number": "A24606453181",
        "state": "CT"
      },
      "employment": {
        "employerName": "HOMELAND SECURITY"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": ""
  },
  "resellerInfo": {
    "endUserName": "CPAPIV2TC26"
  },
  "addOns": {
    "directCheck": "",
    "demographics": "Geocode and Phone",
    "clarityEarlyRiskScore": "N",
    "clarityData": {
      "clarityAccountId": "0000000",
      "clarityLocationId": "000000",
      "clarityControlFileName": "test_file",
      "clarityControlFileVersion": "0000000"
    },
    "renterRiskScore": "N",
    "rentBureauData": {
      "primaryApplRentBureauFreezePin": "1234",
      "secondaryApplRentBureauFreezePin": "112233"
    },
    "riskModels": {
      "modelIndicator": [
        ""
      ],
      "scorePercentile": ""
    },
    "summaries": {
      "summaryType": [
        ""
      ]
    },
    "fraudShield": "Y",
    "mla": "",
    "ofacmsg": "",
    "consumerIdentCheck": {
      "getUniqueConsumerIdentifier": ""
    },
    "joint": "",
    "paymentHistory84": "",
    "syntheticId": "N"
  },
  "customOptions": {
    "optionId": [
      ""
    ]
  }
}

Success 4:

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "NATIUIDAD",
        "firstName": "KATHLEEN",
        "middleName": "K"
      },
      "dob": {
        "dob": "1959"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "3878 DAKLAWN AVE",
        "city": "DALLAS",
        "state": "TX",
        "zipCode": "75219"
      }
    },
    "secondaryApplicant": {
      "name": {
        "lastName": "JAY",
        "firstName": "JUDY",
        "generationCode": "II"
      },
      "ssn": {
        "ssn": "333333333"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "48"
  },
  "resellerInfo": {
    "endUserName": "CPAPIV2TC28"
  },
  "addOns": {
    "directCheck": "",
    "demographics": "Geocode and Phone",
    "clarityEarlyRiskScore": "N",
    "clarityAttributes": "Y",
    "clarityData": {
      "clarityAccountId": "222",
      "clarityLocationId": "3333",
      "clarityControlFileName": "SB_FILE",
      "clarityControlFileVersion": "1",
      "clarityAttributesControlFileName": "TEST_FILE"
    },
    "renterRiskScore": "Y",
    "rentBureauData": {
      "primaryApplRentBureauFreezePin": "1234",
      "secondaryApplRentBureauFreezePin": "112233"
    },
    "riskModels": {
      "modelIndicator": [],
      "scorePercentile": ""
    },
    "summaries": {
      "summaryType": [
        "Profile Summary"
      ]
    },
    "fraudShield": "",
    "mla": "",
    "ofacmsg": "Y",
    "consumerIdentCheck": {
      "getUniqueConsumerIdentifier": ""
    },
    "joint": "Y",
    "paymentHistory84": ""
  },
  "customOptions": {
    "optionId": [
      ""
    ]
  }
}

Success 5:

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "NATIUIDAD",
        "firstName": "KATHLEEN",
        "middleName": "K"
      },
      "dob": {
        "dob": "1959"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "3878 DAKLAWN AVE",
        "city": "DALLAS",
        "state": "TX",
        "zipCode": "75219"
      }
    },
    "secondaryApplicant": {
      "name": {
        "lastName": "JAY",
        "firstName": "JUDY",
        "generationCode": "II"
      },
      "ssn": {
        "ssn": "333333333"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "48"
  },
  "resellerInfo": {
    "endUserName": "CPAPIV2TC28"
  },
  "addOns": {
    "directCheck": "",
    "demographics": "Geocode and Phone",
    "clarityEarlyRiskScore": "N",
    "clarityAttributes": "N",
    "clarityData": {
      "clarityAccountId": "0000000",
      "clarityLocationId": "000000",
      "clarityControlFileName": "test_file",
      "clarityControlFileVersion": "0000000",
      "clarityAttributesControlFileName": "CA_TEST"
    },
    "renterRiskScore": "Y",
    "rentBureauData": {
      "primaryApplRentBureauFreezePin": "1234",
      "secondaryApplRentBureauFreezePin": "112233"
    },
    "riskModels": {
      "modelIndicator": [],
      "scorePercentile": ""
    },
    "summaries": {
      "summaryType": [
        "Profile Summary"
      ]
    },
    "fraudShield": "",
    "mla": "",
    "ofacmsg": "Y",
    "consumerIdentCheck": {
      "getUniqueConsumerIdentifier": ""
    },
    "joint": "Y",
    "paymentHistory84": ""
  },
  "customOptions": {
    "optionId": [
      ""
    ]
  }
}

Failed Test Cases

Failure 1: Invalid Current Address

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "BOLTON",
        "firstName": "PEGGY"
      },
      "dob": {
        "dob": "1948"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "phone": [
        {
          "type": "T",
          "number": "555-673-1001"
        }
      ],
      "currentAddress": {
        "line1": " ",
        "city": "DECATUR",
        "state": "GA",
        "zipCode": "30033"
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "3F"
  },
  "resellerInfo": {
    "endUserName": "ABC"
  }
}

Failure 2: Internal System Failure for Invalid RM-Keyword

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "COLLINS",
        "firstName": "DANIEL"
      },
      "dob": {
        "dob": "04181961"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "3064 WOLFE DR",
        "line2": "",
        "city": "FAIRBORN",
        "state": "OH",
        "zipCode": "45324-2140"
      },
      "previousAddress": [
        {
          "line1": "836 WASHINGTON AVE",
          "line2": "",
          "city": "FAIRBORN",
          "state": "OH",
          "zipCode": "453243840"
        }
      ]
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "18",
    "terms": "010",
    "abbreviatedAmount": "010"
  },
  "addOns": {
    "riskModels": {
      "modelIndicator": [
        "AS"
      ],
      "scorePercentile": ""
    }
  },
  "resellerInfo": {
    "endUserName": "ABC"
  }
}

Failure 3: Inquiry Not Allowed

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "COLLINS",
        "firstName": "DANIEL"
      },
      "dob": {
        "dob": "04181961"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "3064 WOLFE DR",
        "line2": "",
        "city": "FAIRBORN",
        "state": "OH",
        "zipCode": "45324-2140"
      },
      "previousAddress": [
        {
          "line1": "836 WASHINGTON AVE",
          "line2": "",
          "city": "FAIRBORN",
          "state": "OH",
          "zipCode": "453243840"
        }
      ]
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "18",
    "terms": "10",
    "abbreviatedAmount": "10"
  },
  "addOns": {
    "riskModels": {
      "modelIndicator": [
        "AS"
      ],
      "scorePercentile": ""
    }
  },
  "customOptions": {
    "optionId": [
      "test"
    ]
  },
  "resellerInfo": {
    "endUserName": "ABC"
  }
}

Failure 4: Internal Failure For Invalid INQUIRY TYPE Keyword

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "COLLINS",
        "firstName": "DANIEL"
      },
      "dob": {
        "dob": "04181961"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "currentAddress": {
        "line1": "3064 WOLFE DR",
        "line2": "",
        "city": "FAIRBORN",
        "state": "OH",
        "zipCode": "45324-2140"
      },
      "previousAddress": [
        {
          "line1": "836 WASHINGTON AVE",
          "line2": "",
          "city": "FAIRBORN",
          "state": "OH",
          "zipCode": "453243840"
        }
      ]
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "18",
    "terms": "010",
    "abbreviatedAmount": "010"
  },
  "addOns": {
    "riskModels": {
      "modelIndicator": [
        "A"
      ],
      "scorePercentile": ""
    }
  },
  "customOptions": {
    "optionId": [
      "test12"
    ]
  },
  "resellerInfo": {
    "endUserName": "ABC"
  }
}

Failure 5: Invalid Surname

{
  "consumerPii": {
    "primaryApplicant": {
      "name": {
        "lastName": "-",
        "firstName": "PEGGY"
      },
      "dob": {
        "dob": "1948"
      },
      "ssn": {
        "ssn": "111111111"
      },
      "phone": [
        {
          "type": "T",
          "number": "555-673-1001"
        }
      ],
      "currentAddress": {
        "line1": "2965 ATTERBERRY CT",
        "city": " ",
        "zipCode": " "
      }
    }
  },
  "requestor": {
    "subscriberCode": "2222222"
  },
  "permissiblePurpose": {
    "type": "3F"
  },
  "resellerInfo": {
    "endUserName": "ABC"
  }
}


Was this article helpful?
What's Next
Decisions
Resources
Organization
Connect