Experian Commercial Scores API

Description

The Commercial Scores API allows you to request Experian's Intelliscore Plus, our premier business credit score model, and our Financial Stability Risk score to be delivered directly into your application. Each score is returned with the top four score factors and with score trends to help you assess whether the score was stable, improved, fluctuated, or declined over the previous 12 months.

Definition

POST /services/apexrest/intframework/v2/invokeIntegrationService

Authentication Type

Basic Salesforce Auth 2.0

See this link for SFDC Documentation: https://help.salesforce.com/articleView?id=remoteaccess_oauth_web_server_flow.htm&type=5

Parameters

Header Parameters

The following table provides the details of the header parameters used by this web service:

Key	Value
Content-Type	application/JSON
charset	UTF-8
Accept	application/JSON

Body Parameters

The following table provides the details of the body parameters used by this web service:

Field Name	Type
integrationFamily	String
apiType	String
executionPriority	String
idsForFiltersMap	String
accountId	String
optionalRequestParamsMap	String

Error Messages

When you use this web service you can receive the possible error messages as shown in the following table:

Status Code	Error Message
400	Bad Request
401	Authorization information is missing or invalid
404	Not Found
500	Subscription Error
502	Server Error

Commercial Scores API Code

{ 

"integrationFamily" :"Commercial Credit",

"apiType" :"Commercial Scores",

"executionPriority" :"1",

"idsForFiltersMap": {

        "accountId" :"{{BusinessAccount_Id}}"         },

"optionalRequestParamsMap": {}
 }

Sample Request

The sample request that you receive is as shown in the following block:

Sample Request Example

{
  "bin": "700000001",
  "subcode": "0586548",
  "modelCode": "000254",
  "fsrScore": true,
  "commercialScore": true
}

Sample Response

The sample response that you receive is as shown in the following block:

Sample Response Example

{
  "requestId": "ec55cca0-9342-11e7-bddf-ebd4476c3102",
  "success": true,
  "comments": "abcde12345",
  "results": {
    "businessHeader": {
      "bin": "800914632",
      "businessName": "EXPERIAN CONSUMER DIRECT",
      "address": {
        "street": "535 ANTON BLVD",
        "city": "Costa Mesa",
        "state": "CA",
        "zip": "92626",
        "zipExtension": "1947"      },
      "phone": "+19495673800",
      "taxId": "176970333",
      "websiteUrl": "consumerinfo.com",
      "legalBusinessName": "EXPERIAN CONSUMER DIRECT",
      "dbaNames": [
        "EXPERIAN CONSUMER DIRECT"      ],
      "customerDisputeIndicator": true,
      "foreignCountry": true,
      "corporateLinkageIndicator": true,
      "matchingBranchAddress": {
        "bin": "800914632",
        "street": "475 ANTON BLVD",
        "city": "Costa Mesa",
        "state": "CA",
        "zip": "92626",
        "zipExtension": "1947"      },
      "branchLocation": {
        "bin": "800914632",
        "locationId": "475 ANTON BLVD"      }
    },
    "commercialScore": {
      "modelCode": "000254",
      "modelTitle": "INTELLISCORE PLUS V3 ML",
      "customModelCode": "02",
      "score": 11,
      "percentileRanking": 10,
      "recommendedCreditLimitAmount": 206400,
      "riskClass": {
        "code": 4,
        "definition": "MEDIUM TO HIGH RISK"      }
    },
    "commercialScoreFactors": [
      {
        "code": "033",
        "definition": "NUMBER OF COMMERCIAL ACCOUNTS THAT ARE CURRENT"      }
    ],
    "commercialScoreTrends": [
      {
        "quarter": "DEC-FEB",
        "score": 8
      }
    ],
    "fsrScore": {
      "modelCode": "string",
      "modelTitle": "string",
      "score": 0,
      "percentileRanking": 0,
      "recommendedCreditLimitAmount": 206400,
      "riskClass": {
        "code": 1,
        "definition": "Low Risk"      }
    },
    "fsrScoreFactors": [
      {
        "code": "string",
        "definition": "string"      }
    ],
    "fsrScoreTrends": [
      {
        "quarter": "string",
        "score": 0
      }
    ]
  }
}

Usage/ How to Invoke

Usage/How to Invoke

sforce.apex.execute('intframework.IntegrationWebServiceV2', 'runSynchronousIntegrationService', { requestParameters: JSON.stringify(requestParam) });