Experian Credit Bureau (Retail) - Soft Pull
1 endpoint · Core API
This API offers a streamlined solution for accessing detailed credit information for individuals through Experian. By using specific identifiers like phone number, PAN (Permanent Account Number), first name, and last name, users can retrieve comprehensive credit reports that facilitate an accurate assessment of an individual’s creditworthiness. This API is ideal for financial institutions, lenders, and businesses that need reliable credit data to make informed lending decisions, manage risk, and ensure compliance with regulatory standards.
Key Features Credit Information Retrieval: Provides access to detailed credit reports directly from Experian, using parameters such as phone number, PAN, first and last names.
What you can do
Enhanced Creditworthiness Assessment: The API supports the evaluation of an individual's credit health, delivering essential information for evaluating loan eligibility and managing financial risk. Efficiency and Accuracy: This API simplifies credit data retrieval, offering accurate, timely information that enhances decision-making processes and reduces the time spent on manual credit assessments.
Get Credit Bureau details
docs.signcare.io/core/api/credit-analysis/experian-credit-bureau-retail-soft-pull/#post-api-v1-creditbureau
Request body (camelCase): phoneNumber (required, JSON number), pan (required, uppercase AAAAA9999A), firstName (required), lastName (required), dateOfBirth (required, YYYY-MM-DD), pincode (required, JSON number, 6 digits), requestId (optional). This endpoint has no consent fields.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- phoneNumberinteger (int64)requiredRequired. 10-digit Indian mobile number of the individual, starting with 6, 7, 8 or 9. Send it as a JSON number, not a string (for example 9876543210).pattern ^[6-9]\d{9}$default 9876543210
- panstringrequiredRequired. 10-character PAN of the individual in the format AAAAA9999A. Uppercase letters only.length 10pattern ^[A-Z]{5}[0-9]{4}[A-Z]{1}$default ABCDE1234F
- firstNamestringrequiredRequired. First name of the individual.minLength 1default John
- lastNamestringrequiredRequired. Last name of the individual.minLength 1default Doe
- dateOfBirthstringrequiredRequired. Date of birth in YYYY-MM-DD format, e.g. 1990-01-15.minLength 1pattern ^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]…default 1990-01-15
- pincodeinteger (int64)requiredRequired. 6-digit PIN code of the individual's address. Send it as a JSON number, not a string (for example 560026).pattern ^\d{6}$default 560026
- requestIdstringoptionalOptional. Your own identifier for tracking this request (JSON name is `requestId`, not `request_id`). A new one is generated when omitted.nullable
Sample request body
{
"phoneNumber": 9876543210,
"pan": "ABCDE1234F",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1990-01-15",
"pincode": 560026
}
Responses
200OK
- successbooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 200
- messagestringoptionalNo description.nullabledefault XXXXX
- dataobjectoptionalResponse model containing the credit bureau report data.
2 fields
- jsonExperianReportobjectoptionalNo description.
10 fields
- headerobjectoptionalNo description.
4 fields
- systemCodeinteger (int32)optionalNo description.
- messageTextstringoptionalNo description.nullable
- reportDatestringoptionalNo description.nullable
- reportTimestringoptionalNo description.nullable
- userMessageobjectoptionalNo description.
1 field
- userMessageTextstringoptionalNo description.nullable
- creditProfileHeaderobjectoptionalNo description.
4 fields
- reportDatestringoptionalNo description.nullable
- reportTimestringoptionalNo description.nullable
- versionstringoptionalNo description.nullable
- reportNumberstringoptionalNo description.nullable
- current_ApplicationobjectoptionalNo description.
1 field
- current_Application_DetailsobjectoptionalNo description.
10 fields
- enquiry_Reasoninteger (int32)optionalNo description.
- finance_Purposeinteger (int32)optionalNo description.
- amount_Financedinteger (int32)optionalNo description.
- duration_Of_Agreementinteger (int32)optionalNo description.
- current_Applicant_DetailsobjectoptionalNo description.
14 fields
- last_NamestringoptionalNo description.nullable
- first_NamestringoptionalNo description.nullable
- middle_Name1stringoptionalNo description.nullable
- middle_Name2stringoptionalNo description.nullable
- middle_Name3stringoptionalNo description.nullable
- gender_CodestringoptionalNo description.nullable
- incomeTaxPanstringoptionalNo description.nullable
- date_Of_Birth_ApplicantstringoptionalNo description.nullable
- telephone_Number_Applicant_1ststringoptionalNo description.nullable
- telephone_ExtensionstringoptionalNo description.nullable
- telephone_Typeinteger (int32)optionalNo description.
- mobilePhoneNumberstringoptionalNo description.nullable
- eMailIdstringoptionalNo description.nullable
- genderCodeDescriptionstringoptionalNo description.nullable
- current_Other_DetailsobjectoptionalNo description.
5 fields
- incomeinteger (int32)optionalNo description.
- marital_StatusstringoptionalNo description.nullable
- employment_StatusstringoptionalNo description.nullable
- time_with_EmployerstringoptionalNo description.nullable
- number_of_Major_Credit_Card_HeldstringoptionalNo description.nullable
- current_Applicant_Address_DetailsobjectoptionalNo description.
9 fields
- flatNoPlotNoHouseNostringoptionalNo description.nullable
- bldgNoSocietyNamestringoptionalNo description.nullable
- roadNoNameAreaLocalitystringoptionalNo description.nullable
- citystringoptionalNo description.nullable
- landmarkstringoptionalNo description.nullable
- statestringoptionalNo description.nullable
- pinCodeinteger (int32)optionalNo description.
- country_CodestringoptionalNo description.nullable
- stateDescriptionstringoptionalNo description.nullable
- current_Applicant_Additional_AddressDetailsstringoptionalNo description.nullable
- enquiryReasonDescriptionstringoptionalNo description.nullable
- financePurposeDescriptionstringoptionalNo description.nullable
- caiS_AccountobjectoptionalNo description.
2 fields
- caiS_SummaryobjectoptionalNo description.
2 fields
- credit_AccountobjectoptionalNo description.
5 fields
- creditAccountTotalinteger (int32)optionalNo description.
- creditAccountActiveinteger (int32)optionalNo description.
- creditAccountDefaultinteger (int32)optionalNo description.
- creditAccountClosedinteger (int32)optionalNo description.
- cadSuitFiledCurrentBalanceinteger (int32)optionalNo description.
- total_Outstanding_BalanceobjectoptionalNo description.
5 fields
- outstanding_Balance_Securedinteger (int32)optionalNo description.
- outstanding_Balance_Secured_Percentageinteger (int32)optionalNo description.
- outstanding_Balance_UnSecuredinteger (int32)optionalNo description.
- outstanding_Balance_UnSecured_Percentageinteger (int32)optionalNo description.
- outstanding_Balance_Allinteger (int32)optionalNo description.
- caiS_Account_DETAILSarray<object>optionalNo description.nullable
Each item: 60 fields
- identification_NumberstringoptionalNo description.nullable
- subscriber_NamestringoptionalNo description.nullable
- account_NumberstringoptionalNo description.nullable
- portfolio_TypestringoptionalNo description.nullable
- account_TypeanyoptionalNo description.nullable
- open_Dateinteger (int32)optionalNo description.
- credit_Limit_Amountinteger (int32)optionalNo description.
- highest_Credit_or_Original_Loan_AmountanyoptionalNo description.nullable
- terms_DurationanyoptionalNo description.nullable
- terms_FrequencystringoptionalNo description.nullable
- scheduled_Monthly_Payment_AmountstringoptionalNo description.nullable
- settlement_Amountinteger (int32)optionalNo description.
- account_Statusinteger (int32)optionalNo description.
- payment_Ratinginteger (int32)optionalNo description.
- payment_History_ProfilestringoptionalNo description.nullable
- paymentHistoryProfileDescriptionstringoptionalNo description.nullable
- special_CommentstringoptionalNo description.nullable
- current_Balanceinteger (int32)optionalNo description.
- amount_Past_Dueinteger (int32)optionalNo description.
- original_Charge_Off_AmountstringoptionalNo description.nullable
- date_Reportedinteger (int32)optionalNo description.
- date_of_First_DelinquencystringoptionalNo description.nullable
- date_ClosedanyoptionalNo description.nullable
- date_of_Last_PaymentanyoptionalNo description.nullable
- suitFiledWillfulDefaultWrittenOffStatusstringoptionalNo description.nullable
- suitfiledwillfuldefaultwrittenoffstatusDescriptionstringoptionalNo description.nullable
- suitFiled_WillfulDefaultstringoptionalNo description.nullable
- suitfiledWillfuldefaultDescriptionstringoptionalNo description.nullable
- written_off_Settled_StatusanyoptionalNo description.nullable
- writtenOffSettledStatusDescriptionstringoptionalNo description.nullable
- value_of_Credits_Last_MonthstringoptionalNo description.nullable
- occupation_CodestringoptionalNo description.nullable
- value_of_Collateralinteger (int32)optionalNo description.
- type_of_CollateralstringoptionalNo description.nullable
- rate_of_IntereststringoptionalNo description.nullable
- repayment_Tenureinteger (int32)optionalNo description.
- promotional_Rate_FlagstringoptionalNo description.nullable
- incomestringoptionalNo description.nullable
- income_IndicatorstringoptionalNo description.nullable
- income_Frequency_IndicatorstringoptionalNo description.nullable
- defaultStatusDatestringoptionalNo description.nullable
- litigationStatusDatestringoptionalNo description.nullable
- writeOffStatusDatestringoptionalNo description.nullable
- written_Off_Amt_Principalinteger (int32)optionalNo description.
- written_Off_Amt_Totalinteger (int32)optionalNo description.
- dateOfAdditioninteger (int32)optionalNo description.
- currencyCodestringoptionalNo description.nullable
- subscriber_commentsstringoptionalNo description.nullable
- consumer_commentsstringoptionalNo description.nullable
- accountHoldertypeCodeanyoptionalNo description.nullable
- caiS_Account_Historyarray<object>optionalNo description.nullable
Each item: 5 fields
- yearinteger (int32)optionalNo description.
- monthinteger (int32)optionalNo description.
- days_Past_Dueinteger (int32)optionalNo description.
- asset_ClassificationstringoptionalNo description.nullable
- assetClassificationDescriptionstringoptionalNo description.nullable
- caiS_Holder_Detailsarray<object>optionalNo description.nullable
Each item: 10 fields
- surname_Non_NormalizedstringoptionalNo description.nullable
- first_Name_Non_NormalizedstringoptionalNo description.nullable
- middle_Name_1_Non_NormalizedstringoptionalNo description.nullable
- middle_Name_2_Non_NormalizedstringoptionalNo description.nullable
- middle_Name_3_Non_NormalizedstringoptionalNo description.nullable
- aliasstringoptionalNo description.nullable
- gender_Codeinteger (int32)optionalNo description.
- income_TAX_PANstringoptionalNo description.nullable
- date_of_birthinteger (int32)optionalNo description.
- genderCodeDescriptionstringoptionalNo description.nullable
- caiS_Holder_Address_Detailsarray<object>optionalNo description.nullable
Each item: 10 fields
- first_Line_Of_Address_non_normalizedstringoptionalNo description.nullable
- second_Line_Of_Address_non_normalizedstringoptionalNo description.nullable
- third_Line_Of_Address_non_normalizedstringoptionalNo description.nullable
- city_non_normalizedstringoptionalNo description.nullable
- fifth_Line_Of_Address_non_normalizedstringoptionalNo description.nullable
- state_non_normalizedanyoptionalNo description.nullable
- ziP_Postal_Code_non_normalizedinteger (int32)optionalNo description.
- countryCode_non_normalizedstringoptionalNo description.nullable
- address_indicator_non_normalizedinteger (int32)optionalNo description.
- residence_code_non_normalizedstringoptionalNo description.nullable
- caiS_Holder_Phone_Detailsarray<object>optionalNo description.nullable
Each item: 6 fields
- telephone_NumberanyoptionalNo description.nullable
- telephone_Typeinteger (int32)optionalNo description.
- telephone_ExtensionstringoptionalNo description.nullable
- mobile_Telephone_NumberanyoptionalNo description.nullable
- faxNumberstringoptionalNo description.nullable
- eMailIdstringoptionalNo description.nullable
- caiS_Holder_ID_Detailsarray<object>optionalNo description.nullable
Each item: 2 fields
- income_TAX_PANstringoptionalNo description.nullable
- eMailIdstringoptionalNo description.nullable
- portfolioTypeDescriptionstringoptionalNo description.nullable
- accountTypeDescriptionstringoptionalNo description.nullable
- termsFrequencyDescriptionstringoptionalNo description.nullable
- accountStatusDescriptionstringoptionalNo description.nullable
- accountholdertypecodeDescriptionstringoptionalNo description.nullable
- match_resultobjectoptionalNo description.
1 field
- exact_matchstringoptionalNo description.nullable
- totalCAPS_SummaryobjectoptionalNo description.
4 fields
- totalCAPSLast7Daysinteger (int32)optionalNo description.
- totalCAPSLast30Daysinteger (int32)optionalNo description.
- totalCAPSLast90Daysinteger (int32)optionalNo description.
- totalCAPSLast180Daysinteger (int32)optionalNo description.
- capsobjectoptionalNo description.
2 fields
- capS_SummaryobjectoptionalNo description.
4 fields
- capsLast7Daysinteger (int32)optionalNo description.
- capsLast30Daysinteger (int32)optionalNo description.
- capsLast90Daysinteger (int32)optionalNo description.
- capsLast180Daysinteger (int32)optionalNo description.
- capS_Application_Detailsarray<object>optionalNo description.nullable
Each item: 11 fields
- subscriber_codestringoptionalNo description.nullable
- subscriber_NamestringoptionalNo description.nullable
- date_of_Requestinteger (int32)optionalNo description.
- reportTimeinteger (int32)optionalNo description.
- reportNumberinteger (int64)optionalNo description.
- enquiry_Reasoninteger (int32)optionalNo description.
- finance_Purposeinteger (int32)optionalNo description.
- amount_Financedinteger (int32)optionalNo description.
- duration_Of_Agreementinteger (int32)optionalNo description.
- enquiryReasonDescriptionstringoptionalNo description.nullable
- financePurposeDescriptionstringoptionalNo description.nullable
- nonCreditCAPSobjectoptionalNo description.
2 fields
- nonCreditCAPS_SummaryobjectoptionalNo description.
4 fields
- nonCreditCAPSLast7Daysinteger (int32)optionalNo description.
- nonCreditCAPSLast30Daysinteger (int32)optionalNo description.
- nonCreditCAPSLast90Daysinteger (int32)optionalNo description.
- nonCreditCAPSLast180Daysinteger (int32)optionalNo description.
- capS_Application_Detailsarray<object>optionalNo description.nullable
Each item: 11 fields
- subscriber_codestringoptionalNo description.nullable
- subscriber_NamestringoptionalNo description.nullable
- date_of_Requestinteger (int32)optionalNo description.
- reportTimeinteger (int32)optionalNo description.
- reportNumberinteger (int64)optionalNo description.
- enquiry_Reasoninteger (int32)optionalNo description.
- finance_Purposeinteger (int32)optionalNo description.
- amount_Financedinteger (int32)optionalNo description.
- duration_Of_Agreementinteger (int32)optionalNo description.
- enquiryReasonDescriptionstringoptionalNo description.nullable
- financePurposeDescriptionstringoptionalNo description.nullable
- scoreobjectoptionalNo description.
2 fields
- fcirexScoreinteger (int32)optionalNo description.
- fcirexScoreConfidLevelstringoptionalNo description.nullable
- excelExperianReportstringoptionalGets or sets the Experian credit report in Excel format as a Base64-encoded string.nullable
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- isBillablebooleanoptionalWhether this request was charged: true if it was, false if not. Errors always show false. Flows that finish later (ITR Fetch, SHCIL eStamp, DigiLocker, eSign) show false here, because the charge is made when the result is ready. eSign charges each signer when they complete signing. DigiLocker deducts the credit when the link is created and refunds it automatically if the link expires before the user completes it.
Example
{
"success": false,
"statusCode": 200,
"message": "XXXXX",
"data": {
"jsonExperianReport": {
"header": {
"systemCode": 0,
"messageText": "string",
"reportDate": "string",
"reportTime": "string"
},
"userMessage": {
"userMessageText": "string"
},
"creditProfileHeader": {
"reportDate": "string",
"reportTime": "string",
"version": "string",
"reportNumber": "string"
},
"current_Application": {
"current_Application_Details": {
"enquiry_Reason": 0,
"finance_Purpose": 0,
"amount_Financed": 0,
"duration_Of_Agreement": 0,
"current_Applicant_Details": {
"last_Name": "string",
"first_Name": "string",
"middle_Name1": "string",
"middle_Name2": "string",
"middle_Name3": "string",
"gender_Code": "string",
"incomeTaxPan": "string",
"date_Of_Birth_Applicant": "string",
"telephone_Number_Applicant_1st": "string",
"telephone_Extension": "string",
"telephone_Type": 0,
"mobilePhoneNumber": "string",
"eMailId": "string",
"genderCodeDescription": "string"
},
"current_Other_Details": {
"income": 0,
"marital_Status": "string",
"employment_Status": "string",
"time_with_Employer": "string",
"number_of_Major_Credit_Card_Held": "string"
},
"current_Applicant_Address_Details": {
"flatNoPlotNoHouseNo": "string",
"bldgNoSocietyName": "string",
"roadNoNameAreaLocality": "string",
"city": "string",
"landmark": "string",
"state": "string",
"pinCode": 0,
"country_Code": "string",
"stateDescription": "string"
},
"current_Applicant_Additional_AddressDetails": "string",
"enquiryReasonDescription": "string",
"financePurposeDescription": "string"
}
},
"caiS_Account": {
"caiS_Summary": {
"credit_Account": {
"creditAccountTotal": 0,
"creditAccountActive": 0,
"creditAccountDefault": 0,
"creditAccountClosed": 0,
"cadSuitFiledCurrentBalance": 0
},
"total_Outstanding_Balance": {
"outstanding_Balance_Secured": 0,
"outstanding_Balance_Secured_Percentage": 0,
"outstanding_Balance_UnSecured": 0,
"outstanding_Balance_UnSecured_Percentage": 0,
"outstanding_Balance_All": 0
}
},
"caiS_Account_DETAILS": [
{
"identification_Number": "string",
"subscriber_Name": "string",
"account_Number": "string",
"portfolio_Type": "string",
"account_Type": null,
"open_Date": 0,
"credit_Limit_Amount": 0,
"highest_Credit_or_Original_Loan_Amount": null,
"terms_Duration": null,
"terms_Frequency": "string",
"scheduled_Monthly_Payment_Amount": "string",
"settlement_Amount": 0,
"account_Status": 0,
"payment_Rating": 0,
"payment_History_Profile": "string",
"paymentHistoryProfileDescription": "string",
"special_Comment": "string",
"current_Balance": 0,
"amount_Past_Due": 0,
"original_Charge_Off_Amount": "string",
"date_Reported": 0,
"date_of_First_Delinquency": "string",
"date_Closed": null,
"date_of_Last_Payment": null,
"suitFiledWillfulDefaultWrittenOffStatus": "string",
"suitfiledwillfuldefaultwrittenoffstatusDescription": "string",
"suitFiled_WillfulDefault": "string",
"suitfiledWillfuldefaultDescription": "string",
"written_off_Settled_Status": null,
"writtenOffSettledStatusDescription": "string",
"value_of_Credits_Last_Month": "string",
"occupation_Code": "string",
"value_of_Collateral": 0,
"type_of_Collateral": "string",
"rate_of_Interest": "string",
"repayment_Tenure": 0,
"promotional_Rate_Flag": "string",
"income": "string",
"income_Indicator": "string",
"income_Frequency_Indicator": "string",
"defaultStatusDate": "string",
"litigationStatusDate": "string",
"writeOffStatusDate": "string",
"written_Off_Amt_Principal": 0,
"written_Off_Amt_Total": 0,
"dateOfAddition": 0,
"currencyCode": "string",
"subscriber_comments": "string",
"consumer_comments": "string",
"accountHoldertypeCode": null,
"caiS_Account_History": [],
"caiS_Holder_Details": [],
"caiS_Holder_Address_Details": [],
"caiS_Holder_Phone_Details": [],
"caiS_Holder_ID_Details": [],
"portfolioTypeDescription": "string",
"accountTypeDescription": "string",
"termsFrequencyDescription": "string",
"accountStatusDescription": "string",
"accountholdertypecodeDescription": "string"
}
]
},
"match_result": {
"exact_match": "string"
},
"totalCAPS_Summary": {
"totalCAPSLast7Days": 0,
"totalCAPSLast30Days": 0,
"totalCAPSLast90Days": 0,
"totalCAPSLast180Days": 0
},
"caps": {
"capS_Summary": {
"capsLast7Days": 0,
"capsLast30Days": 0,
"capsLast90Days": 0,
"capsLast180Days": 0
},
"capS_Application_Details": [
{
"subscriber_code": "string",
"subscriber_Name": "string",
"date_of_Request": 0,
"reportTime": 0,
"reportNumber": 0,
"enquiry_Reason": 0,
"finance_Purpose": 0,
"amount_Financed": 0,
"duration_Of_Agreement": 0,
"enquiryReasonDescription": "string",
"financePurposeDescription": "string"
}
]
},
"nonCreditCAPS": {
"nonCreditCAPS_Summary": {
"nonCreditCAPSLast7Days": 0,
"nonCreditCAPSLast30Days": 0,
"nonCreditCAPSLast90Days": 0,
"nonCreditCAPSLast180Days": 0
},
"capS_Application_Details": [
{
"subscriber_code": "string",
"subscriber_Name": "string",
"date_of_Request": 0,
"reportTime": 0,
"reportNumber": 0,
"enquiry_Reason": 0,
"finance_Purpose": 0,
"amount_Financed": 0,
"duration_Of_Agreement": 0,
"enquiryReasonDescription": "string",
"financePurposeDescription": "string"
}
]
},
"score": {
"fcirexScore": 0,
"fcirexScoreConfidLevel": "string"
}
},
"excelExperianReport": "string"
},
"messages": [
"string"
],
"request_id": "string",
"isBillable": false
}
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 400
}
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 401
}
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500
Example
{
"data": {},
"messages": [
"string"
],
"request_id": "string",
"success": false,
"message": "XXXXX",
"isBillable": false,
"statusCode": 500
}
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/api/v1/CreditBureau' \
-H 'X-API-KEY: YOUR_API_KEY' \
-H 'X-API-APP-ID: YOUR_APP_ID' \
-H 'Content-Type: application/json' \
-d '{
"phoneNumber": 9876543210,
"pan": "ABCDE1234F",
"firstName": "John",
"lastName": "Doe",
"dateOfBirth": "1990-01-15",
"pincode": 560026
}'