Hybris Sales UX API

creditCheck API is used to fetch the credit score of an customer.

This API is available for all 4 BUs (JM, PA, CR(stub response), PR).

Request URL

http://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/creditCheck

Base URI Parameter

Headers

Security Headers

Query Parameter

searchCriteria request body for PA

searchCriteria request body for JM

searchCriteria request body for PR

searchCriteria request body for PA

{
    "identityNumberType": "nationalId",
    "identityNumber": "8-462-327"
}

searchCriteria request body for JM

{
    "firstName": "TESIA",
    "lastName": "DOUGLAS",
    "role": "A",
    "requestDate": "20-11-2001",
    "contractType": "58",
    "dateOfBirth": "19-07-1986",
    "paymentPeriod": "M",
    "consentFlag": "1",
    "currency": "JMD",
    "identityNumber": "100765653"
}

searchCriteria request body for PR

Below json object need to pass URL Encoded in searchCriteria

{
     "firstName":"MARK",
     "middleName":"M",
     "lastName":"EID",
     "streetName":"NANCY",
     "city":"SIOUX FALLS",
     "state":"SD",
     "postalCode":"57106"
}

Possible response error for PR

When missing x-ssn header in input request

    "errors": [
        {
            "code": 400,
            "message": "INVALID:SSN",
            "description": "'x-ssn' cannot be Empty"
        }
    ]
}

When missing firstName field in input searchCriteria request

{
    "errors": [
        {
            "code": 400,
            "message": "TRANSUNION:VALIDATION_ERROR",
            "description": "FIRST NAME MISSING OR INVALID"
        }
    ]
}

When missing lastName field in input searchCriteria request

{
    "errors": [
        {
            "code": 400,
            "message": "TRANSUNION:VALIDATION_ERROR",
            "description": "SURNAME MISSING OR INVALID"
        }
    ]
}

When missing streetName field in input searchCriteria request

{
    "errors": [
        {
            "code": 400,
            "message": "TRANSUNION:VALIDATION_ERROR",
            "description": "CURRENT ADDRESS STREET NAME MISSING OR INVALID"
        }
    ]
}

When missing postalCode field in input searchCriteria request

{
    "errors": [
        {
            "code": 400,
            "message": "TRANSUNION:VALIDATION_ERROR",
            "description": "CURRENT ADDRESS ZIP CODE MISSING OR INVALID"
        }
    ]
}

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

HTTP Status PA response is 200 with Response body.

PA Response with CreditScore

Response with CreditScore

{
   "creditScore": "260",
   "creditRiskRating": "D",
   "creditProfileDate": "2021-10-20T10:37:10Z"
}

PA Response without CreditScore

Response without CreditScore

{
    "creditProfileDate":"2021-04-15T07:00:03.4Z",
    "scoreError": "NE",
    "scoreDescription": "No existe"
}

HTTP Status JM response is 200 with Response body.

JM Response with CreditScore

Response with CreditScore

{
   "creditScore": "260",
   "creditRiskRating": "J",
   "creditProfileDate": "2021-10-20T10:37:10Z"
}

JM Response without CreditScore

Response without CreditScore

{
    "creditProfileDate":"2021-04-15T07:00:03.4Z",
    "scoreError": "S",
    "scoreDescription": "Subject has only services contracts"
}

Response for PR

{
 "creditScore": "+687",
 "creditProfileDate": "2021-04-15T07:00:03.000-04:00",
 "characteristic":[{
       "name": "highRiskFraudAlert",
       "value": "availableClear"
 }]
}

Definitions

Each of the response parameters is detailed.

characteristic Values

Key Considerations for PR response:

The creditScore and creditClass mappings for Vantage 4.0 are described below:

Panama response datamodel :

Types of Exclusion Score (PA):

Types of Errors (PA)

For JM CG Invoke Field Values

Contract Role Type (JM)

RoleType

Payment Periodicity

PaymentPeriodicity (JM)

CONTRACT TYPE (JM)

Credit Score Tranche (JM)

Exclusion Rule/ Score Error (JM)

There are cases where the score cannot be calculated because the set of available information may not be enough or suitable for statistic computation, in these specific cases a message will be returned, the message provides the most heavily weighted reasons why the CBS is not returned. The rules and criteria, which determine the methodological exclusion code, are listed in the table below.