Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
Introduction
This API allows applications to retrieve credit scores from the Equifax Credit Bureau using a customer's mobile number and name.
📘
Important Note: Customer Full Name
Please ensure that the customer's full name, as per their official documents or credit bureau records, is provided in the request. Passing only the first name or an incomplete name may result in a "Consumer Not Found" response or unsuccessful data retrieval.
Request Specification
Request Body Parameters
Parameter
Data Type
Required
Description
mobile
String
Yes
Customer's 10-digit mobile number. Must start with 6, 7, 8, or 9.
name
String
Yes
Customer's full name as registered with credit bureau.
Example Request
{
"mobile": "9999999999",
"name": "John Doe"
}
Response Specification
Success Response Structure
Key
Data Type
Description
decentroTxnId
String
Unique transaction identifier for the API call. Used for debugging and tracking.
status
String
Overall status of the API call. Possible values: "SUCCESS", "FAILURE".
responseCode
String
Specific code indicating the result of the operation. Format: "S" prefix for success, "E" prefix for errors.
message
String
Human-readable description of the API call result.
data
Object
Contains the credit score information when available. Only present in successful score retrievals.
data.scoreDetails
Array
List of credit score objects. May contain multiple score types.
scoreDetails[].type
String
Code identifying the scoring model used (e.g., "ERS").
scoreDetails[].version
String
Version of the scoring model (e.g., "4.0").
scoreDetails[].name
String
Display name of the scoring model (e.g., "ERS4.0").
scoreDetails[].value
String
The actual credit score value.
scoringElements
Array
Factors that influenced the credit score.
scoringElements[].type
String
Type of scoring element (e.g., "RES" for reason).
scoringElements[].seq
String
Sequence number indicating importance of the factor.
scoringElements[].code
String
Code identifying the specific factor.
scoringElements[].description
String
Human-readable description of the factor.
responseKey
String
Standardized key for the response type. Useful for programmatic handling.
Response Scenarios
1. Successful Credit Score Retrieval
HTTP Status
200 OK
status
"SUCCESS"
responseCode
"S00000"
message
"Credit score fetched successfully."
responseKey
"success_credit_score"
Description
The API successfully retrieved the customer's credit score from Equifax.
The API call was successful, but no credit records were found for the provided customer details. This indicates the customer may not have a credit history with Equifax.
"Mobile is not valid. Please provide a valid mobile containing 10 digits starting with 6, 7, 8 or 9."
responseKey
"error_invalid_mobile"
Description
The provided mobile number does not meet validation requirements. The request was rejected before attempting to retrieve credit information.
{
"decentroTxnId": "87EA90D3D33F4F27B1368EA604855638",
"status": "FAILURE",
"responseCode": "E00009",
"message": "Mobile is not valid. Please provide a valid mobile containing 10 digits starting with 6, 7, 8 or 9.",
"responseKey": "error_invalid_mobile"
}
Response Code Reference
Response Key
HTTP Status
Message
success_credit_score
200
Credit score fetched successfully.
error_credits_score_not_found
200
Credit score not found.
error_invalid_mobile
400
Mobile is not valid. Please provide a valid mobile containing 10 digits starting with 6, 7, 8 or 9.
Implementation Guidelines
Error Handling
Always check the status and responseCode fields to determine the result of the API call
Note that an HTTP 200 response may still contain error information (e.g., customer not found)
Implement appropriate retry logic for temporary failures
Data Processing
Credit score values should be treated as strings in processing logic
The scoringElements array is ordered by importance (seq field)
The top three scoring elements represent the most significant factors affecting the credit score
Security Considerations
Implement proper authentication before making API calls
Always transmit customer information over secure channels
Obtain appropriate consent before retrieving credit information
Responses
Updated 3 days ago
Did this page help you?
Language
Loading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
