v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB

Credit

Credit report (Experian)

Fetches the credit report for a mobile number after explicit user consent (OTP verified on client). Provide device metadata. device_id should be supplied only if device_type is mobile.

post/verify/credit_analysis

Request body

mobile_nostring required

10-digit mobile number whose credit report will be fetched.

consent_messagestring required

User consent text. Must contain authorisation language referencing Experian and credit report.

consent_acceptance'yes' | 'no' required

User acceptance of consent (yes/no).

device_type'web' | 'mobile' required

Device type. Allowed values: web, mobile.

otpstring required

OTP the user used to accept consent. Client must verify OTP and include it in this payload.

timestampstring required

Timestamp in format DDMMYYYY-HH:MM:SS (example: 09122023-05:45:20).

device_ipstring ipv4 required

IP address of the device submitting the request.

device_idstring nullable

Device IMEI (pass only if device_type is mobile).

Response

Credit report returned

statusstring required

success or failure

chargeblestring

Indicates if the call is chargeable (true/false as string).

user_consentstring

Indicates if user consent was present (true/false as string).

Example response

{
  "result": {
    "result_json": {
      "Account_Type": {
        "1": "AUTO LOAN",
        "2": "HOUSING LOAN",
        "3": "PROPERTY LOAN",
        "4": "LOAN AGAINST SHARES/SECURITIES",
        "5": "PERSONAL LOAN",
        "6": "CONSUMER LOAN",
        "7": "GOLD LOAN",
        "8": "EDUCATIONAL LOAN",
        "9": "LOAN TO PROFESSIONAL",
        "10": "CREDIT CARD",
        "11": "LEASING",
        "12": "OVERDRAFT",
        "13": "TWO-WHEELER LOAN",
        "14": "NON-FUNDED CREDIT FACILITY",
        "15": "LOAN AGAINST BANK DEPOSITS",
        "16": "FLEET CARD",
        "17": "Commercial Vehicle Loan",
        "18": "Telco - Wireless",
        "19": "Telco - Broadband",
        "20": "Telco - Landline",
        "23": "GECL Secured",
        "24": "GECL Unsecured",
        "31": "Secured Credit Card",
        "32": "Used Car Loan",
        "33": "Construction Equipment Loan",
        "34": "Tractor Loan",
        "35": "Corporate Credit Card",
        "36": "Kisan Credit Card",
        "37": "Loan on Credit Card",
        "38": "Prime Minister Jaan Dhan Yojana - Overdraft",
        "39": "Mudra Loans - Shishu / Kishor / Tarun",
        "40": "Microfinance - Business Loan",
        "41": "Microfinance - Personal Loan",
        "42": "Microfinance - Housing Loan",
        "43": "Microfinance - Others",
        "44": "Pradhan Mantri Awas Yojana - Credit Link Subsidy Scheme MAY CLSS",
        "45": "P2P Personal Loan",
        "46": "P2P Auto Loan",
        "47": "P2P Education Loan",
        "50": "Business Loan - Secured",
        "51": "BUSINESS LOAN - GENERAL",
        "52": "BUSINESS LOAN -PRIORITY SECTOR - SMALL BUSINESS",
        "53": "BUSINESS LOAN -PRIORITY SECTOR - AGRICULTURE",
        "54": "BUSINESS LOAN -PRIORITY SECTOR - OTHERS",
        "55": "BUSINESS NON-FUNDED CREDIT FACILITY - GENERAL",
        "56": "BUSINESS NON-FUNDED CREDIT FACILITY - PRIORITY SECTOR - SMALL BUSINESS",
        "57": "BUSINESS NON-FUNDED CREDIT FACILITY - PRIORITY SECTOR - AGRICULTURE",
        "58": "BUSINESS NON-FUNDED CREDIT FACILITY - PRIORITY SECTOR - OTHERS",
        "59": "BUSINESS LOANS AGAINST BANK DEPOSITS",
        "60": "Staff Loan",
        "61": "Business Loan - Unsecured",
        "69": "Short Term Personal Loan [Unsecured]",
        "70": "Priority Sector Gold Loan [Secured]",
        "71": "Temporary Overdraft [Unsecured]",
        "blank": "",
        "00": "Others"
      }
    }
  }
}