Experian

REST API for Experian data

Cross Core 2 Initial with options

SecurityAuthorization Token
Request
path Parameters
option
required
string
Request Body schema:
firstName
string
lastName
string
middleName
string
nameSuffix
string
dob
string <date>
ssn
string [ 4 .. 11 ] characters
pobox
string
street1
string
street2
string
city
string
state
string = 2 characters
zip
string = 5 characters
phone
string = 10 characters
email
string
Responses
200

Successful Cross Core 2 One-Time Passcode (no options) Response

post/experian/cc2/{option}
Request samples
{
  • "firstName": "string",
  • "lastName": "string",
  • "middleName": "string",
  • "nameSuffix": "string",
  • "dob": "2019-08-24",
  • "ssn": "string",
  • "pobox": "string",
  • "street1": "string",
  • "street2": "string",
  • "city": "string",
  • "state": "st",
  • "zip": "strin",
  • "phone": "stringstri",
  • "email": "string"
}
Response samples
application/json
{
  • "initialDecision": "string",
  • "finalDecision": "string",
  • "preciseIDScore": 0,
  • "preciseMatchScore": 0,
  • "validationScore": 0,
  • "verificationScore": 0,
  • "fpdScore": 0,
  • "kbaScore": 0,
  • "sessionId": "string",
  • "oneTimePasscode": "string",
  • "oneTimePasscodeSent": true,
  • "oneTimePasscodeMatch": true,
  • "reasons": [
    ],
  • "ofacValue": "string",
  • "ofacCount": 0,
  • "questions": [
    ]
}

Credit Report

Retrieves a credit profile with scores and addons requested. This is CR API Version 2.

SecurityAuthorization Token
Request
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 20 ] characters
middleName
string (Middle Name) [ 0 .. 20 ] characters
lastName
required
string (Last Name) [ 0 .. 32 ] characters
nameSuffix
string (Generation Suffix) [ 0 .. 3 ] characters
Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"
dob
string <date> (Date of Birth)
ssn
string (Social Security Number) [ 4 .. 11 ] characters
phone
string (Mobile Phone Number) = 10 characters
street1
required
string (Street Address) [ 0 .. 48 ] characters
city
required
string (City) [ 0 .. 28 ] characters
state
required
string (State) = 2 characters
zip
required
string (Zip Code) [ 5 .. 10 ] characters
Responses
200

Successful Credit Report Response

post/experian/credit-profile/credit-report/basic
Request samples
application/json

Request Schema

{
  • "firstName": {
    },
  • "lastName": {
    },
  • "street1": {
    },
  • "street2": {
    },
  • "city": {
    },
  • "state": {
    },
  • "zip": {
    },
  • "ssn": {
    }
}
Response samples
application/json
{
  • "headerRecord": [
    ],
  • "addressInformation": [
    ],
  • "consumerAssistanceReferralAddress": {
    },
  • "consumerIdentity": {
    },
  • "directCheck": [
    ],
  • "employmentInformation": [
    ],
  • "fraudShield": [
    ],
  • "informationalMessage": [
    ],
  • "inquiry": [
    ],
  • "mla": {
    },
  • "ofac": {
    },
  • "summaries": [
    ],
  • "publicRecord": [
    ],
  • "riskModel": [
    ],
  • "ssn": [
    ],
  • "statement": [
    ],
  • "tradeline": [
    ],
  • "uniqueConsumerIdentifier": {
    },
  • "covidSpotlightAttributes": [
    ],
  • "fcraAttributes": [
    ],
  • "staggAttributes": {
    },
  • "endTotals": [
    ],
  • "clarityAttributes": { },
  • "incomeAndEmploymentReport": { },
  • "machineLearningAttributes": [
    ]
}

Credit Report

Retrieves a credit profile with scores and addons requested. This is CR API Version 2.

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
firstName
required
string (First Name) [ 0 .. 20 ] characters
middleName
string (Middle Name) [ 0 .. 20 ] characters
lastName
required
string (Last Name) [ 0 .. 32 ] characters
nameSuffix
string (Generation Suffix) [ 0 .. 3 ] characters
Enum: "Sr" "Jr" "III" "IV" "V" "VI" "VII" "VIII" "IX" "X"
dob
string <date> (Date of Birth)
ssn
string (Social Security Number) [ 4 .. 11 ] characters
phone
string (Mobile Phone Number) = 10 characters
street1
required
string (Street Address) [ 0 .. 48 ] characters
city
required
string (City) [ 0 .. 28 ] characters
state
required
string (State) = 2 characters
zip
required
string (Zip Code) [ 5 .. 10 ] characters
Responses
200

Successful Credit Report Response

post/experian/credit-profile/credit-report/basic/{config}
Request samples
application/json

Request Schema

{
  • "firstName": {
    },
  • "lastName": {
    },
  • "street1": {
    },
  • "street2": {
    },
  • "city": {
    },
  • "state": {
    },
  • "zip": {
    },
  • "ssn": {
    }
}
Response samples
application/json
{
  • "headerRecord": [
    ],
  • "addressInformation": [
    ],
  • "consumerAssistanceReferralAddress": {
    },
  • "consumerIdentity": {
    },
  • "directCheck": [
    ],
  • "employmentInformation": [
    ],
  • "fraudShield": [
    ],
  • "informationalMessage": [
    ],
  • "inquiry": [
    ],
  • "mla": {
    },
  • "ofac": {
    },
  • "summaries": [
    ],
  • "publicRecord": [
    ],
  • "riskModel": [
    ],
  • "ssn": [
    ],
  • "statement": [
    ],
  • "tradeline": [
    ],
  • "uniqueConsumerIdentifier": {
    },
  • "covidSpotlightAttributes": [
    ],
  • "fcraAttributes": [
    ],
  • "staggAttributes": {
    },
  • "endTotals": [
    ],
  • "clarityAttributes": { },
  • "incomeAndEmploymentReport": { },
  • "machineLearningAttributes": [
    ]
}

Cross Core 2 Knowledge IQ (with options)

SecurityAuthorization Token
Request
path Parameters
option
required
string
Request Body schema:
riskStrategyNumber
string
languageCode
string
championChallengerRandomNumber
integer <int64>
outWalletQuestionsRequest
string
sessionId
string
object (KBAAnswers)
object (KBAUserDefinedNumerics)
object (KBAUserDefinedTexts)
object (KBAUserDefinedDates)
Responses
200

Successful Cross Core 2 Knowledge IQ (with options) Response

post/experian/cc2/{option}/kiq
Request samples
{
  • "riskStrategyNumber": "string",
  • "languageCode": "string",
  • "championChallengerRandomNumber": 0,
  • "outWalletQuestionsRequest": "string",
  • "sessionId": "string",
  • "answers": {
    },
  • "userDefinedNumerics": {
    },
  • "userDefinedTexts": {
    },
  • "userDefinedDates": {
    }
}
Response samples
application/json
{
  • "initialDecision": "string",
  • "finalDecision": "string",
  • "preciseIDScore": 0,
  • "preciseMatchScore": 0,
  • "validationScore": 0,
  • "verificationScore": 0,
  • "fpdScore": 0,
  • "kbaScore": 0,
  • "sessionId": "string",
  • "oneTimePasscode": "string",
  • "oneTimePasscodeSent": true,
  • "oneTimePasscodeMatch": true,
  • "reasons": [
    ],
  • "ofacValue": "string",
  • "ofacCount": 0,
  • "questions": [
    ]
}

Cross Core 2 One-Time Passcode with options

SecurityAuthorization Token
Request
path Parameters
option
required
string
Request Body schema:
AuthURL
string
Timestamp
string <date-time>
DeliveryType
string
Enum: "0" "1"
Language
string
Value: "0"
Passcode
integer <int32>
Status
string
Enum: "0" "1" "2" "3" "4" "5" "6" "7"
Responses
200

Successful Cross Core 2 One-Time Passcode with options Response

post/experian/cc2/{option}/otp
Request samples
{
  • "AuthURL": "string",
  • "Timestamp": "2019-08-24T14:15:22Z",
  • "DeliveryType": "0",
  • "Language": "0",
  • "Passcode": 0,
  • "Status": "0"
}
Response samples
application/json
{
  • "initialDecision": "string",
  • "finalDecision": "string",
  • "preciseIDScore": 0,
  • "preciseMatchScore": 0,
  • "validationScore": 0,
  • "verificationScore": 0,
  • "fpdScore": 0,
  • "kbaScore": 0,
  • "sessionId": "string",
  • "oneTimePasscode": "string",
  • "oneTimePasscodeSent": true,
  • "oneTimePasscodeMatch": true,
  • "reasons": [
    ],
  • "ofacValue": "string",
  • "ofacCount": 0,
  • "questions": [
    ]
}

Experian Business Premier Profile Report

Order an Experian Business Premier Profile Report.

SecurityAuthorization Token
Request
Request Body schema: application/json
bin
string
Responses
200

Successful Experian Business Premier Profile Report Response

post/ccc/exp/report
Request samples
application/json

Sample 1

{
  • "bin": "963129279"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "PPR": "string",
  • "data": {
    }
}

Experian Business Premier Profile Report

Order an Experian Business Premier Profile Report.

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
bin
string
Responses
200

Successful Experian Business Premier Profile Report Response

post/ccc/exp/report/{config}
Request samples
application/json

Sample 1

{
  • "bin": "963129279"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "PPR": "string",
  • "data": {
    }
}

Experian Business Search

Perform an Experian US business search to get a list of matching businesses.

SecurityAuthorization Token
Request
Request Body schema: application/json
name
string
city
string
state
string
street
string
zip
string
phone
string
taxId
string
Responses
200

Successful Experian Business Search Response

post/ccc/exp/search
Request samples
application/json

Sample 1

{
  • "name": "GODWIN PUMPS OF AMERICA, INC",
  • "city": "BRIDGEPORT",
  • "state": "NJ"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "Business Search": "string",
  • "data": [
    ]
}

Experian Business Search

Perform an Experian US business search to get a list of matching businesses.

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
name
string
city
string
state
string
street
string
zip
string
phone
string
taxId
string
Responses
200

Successful Experian Business Search Response

post/ccc/exp/search/{config}
Request samples
application/json

Sample 1

{
  • "name": "GODWIN PUMPS OF AMERICA, INC",
  • "city": "BRIDGEPORT",
  • "state": "NJ"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "Business Search": "string",
  • "data": [
    ]
}

Experian Intelliscore+ Business Report

Order an Experian Intelliscore+ business report.

SecurityAuthorization Token
Request
Request Body schema: application/json
bin
string
Responses
200

Successful Experian Intelliscore+ Business Report Response

post/ccc/exp/score
Request samples
application/json

Sample 1

{
  • "bin": "963129279"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "intelliscore": "string",
  • "data": {
    }
}

Experian Intelliscore+ Business Report

Order an Experian Intelliscore+ business report.

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
bin
string
Responses
200

Successful Experian Intelliscore+ Business Report Response

post/ccc/exp/score/{config}
Request samples
application/json

Sample 1

{
  • "bin": "963129279"
}
Response samples
application/json
{
  • "auth": true,
  • "detail": { },
  • "result": "string",
  • "intelliscore": "string",
  • "data": {
    }
}

Experian Reverse Phone Append

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
number
string
Responses
200

Successful Experian Reverse Phone Append Response

post/experian/rpa/{config}
Request samples
application/json

Successs

{
  • "number": "9167654295"
}
Response samples
application/json
{
  • "error": {
    },
  • "result": {
    },
  • "metadata": {
    }
}

Experian Reverse Phone Append

SecurityAuthorization Token
Request
path Parameters
config
required
string
Request Body schema: application/json
number
string
Responses
200

Successful Experian Reverse Phone Append Response

post/experian/rpa
Request samples
application/json

Successs

{
  • "number": "9167654295"
}
Response samples
application/json
{
  • "error": {
    },
  • "result": {
    },
  • "metadata": {
    }
}