Credit Report Cibil

Endpoint Overview

POST /api/v1/credit-report-cibil/fetch-report

Description

This API retrieves a comprehensive CIBIL credit report (Hard Pull) for a specified individual. It returns detailed credit information in JSON format, including the client's personal details, credit score, and a complete credit report with account history, enquiries, and other credit-related information. This is a hard pull credit report that will be visible on the individual's credit history.

Key Benefits

Access to official CIBIL credit reports with comprehensive credit history

Detailed credit information including accounts, payment history, and enquiries

Real-time credit score assessment for informed lending decisions

Standardized JSON format for easy integration into existing systems

Use Cases

Financial Services

Lending

Fintech

Credit risk assessment for loan applications

Pre-qualification screening for credit products

Customer onboarding for banking and financial services

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token authentication using JWT
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
mobile	String	Yes	Mobile number of the client
pan	String	Yes	PAN number of the client
name	String	Yes	Full name of the client
gender	String (Enum)	Yes	Gender of the client. Valid values: `male`, `female`
consent	String (Enum)	Yes	User consent for credit report pull. Valid value: `Y`

Example Request

{
    "mobile": "9912345675",
    "pan": "EKRPR1234F",
    "name": "Vishal Ahluwalia",
    "gender": "male",
    "consent": "Y"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the response data
data.client_id	String	Unique identifier for the client
data.mobile	String	Mobile number of the client
data.pan	String	PAN number of the client
data.name	String	Full name of the client
data.gender	String	Gender of the client
data.credit_score	String	CIBIL credit score of the client
data.credit_report	Object	Detailed credit report as received from CIBIL
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Response message
message_code	String	Response message code

Credit Report Structure

The credit_report object contains detailed information including:

Personal information (names, IDs, contact details)

Address history

Employment information

Credit score details with reason codes

Account information (loans, credit cards, etc.)

Enquiry history

Example Successful Response

{
    "data": {
        "client_id": "credit_report_cibil_MgpnbhgjVsVrqpTebjYC",
        "mobile": "9988776655",
        "pan": "EKRPR1234F",
        "name": "Vishal Rathore",
        "gender": "male",
        "credit_score": "744",
        "credit_report": [
            {
                "names": [
                    {
                        "index": "N01",
                        "name": "VISHAL SINGH RATHORE",
                        "birthDate": "1999-07-25",
                        "gender": "2"
                    }
                ],
                "ids": [
                    {
                        "index": "I01",
                        "idType": "01",
                        "idNumber": "EKRPR1234F"
                    },
                    {
                        "index": "I02",
                        "idType": "09",
                        "idNumber": "50056881070480"
                    }
                ],
                "telephones": [
                    {
                        "index": "T01",
                        "telephoneNumber": "9988776655",
                        "telephoneType": "03",
                        "enquiryEnriched": "Y"
                    }
                ],
                "emails": [
                    {
                        "index": "C01",
                        "emailID": "VISHALRATHORE@GMAIL.COM"
                    }
                ],
                "scores": [
                    {
                        "scoreName": "CIBILTUSC3",
                        "scoreCardName": "08",
                        "scoreCardVersion": "10",
                        "scoreDate": "18092024",
                        "score": "00644",
                        "reasonCodes": [
                            {
                                "reasonCodeName": "reasonCode1",
                                "reasonCodeValue": "07"
                            }
                        ]
                    }
                ],
                "accounts": [
                    {
                        "index": "T001",
                        "memberShortName": "NOT DISCLOSED",
                        "accountType": "69",
                        "ownershipIndicator": 1,
                        "dateOpened": "30112021",
                        "lastPaymentDate": "30032023",
                        "dateReported": "31072024",
                        "highCreditAmount": 2000,
                        "currentBalance": 9890,
                        "amountOverdue": 9890,
                        "paymentHistory": "DBT900900876846815755755724694663633602571541510480449421389358358297267236205175144114XXX055024000",
                        "paymentStartDate": "01072024",
                        "paymentEndDate": "01112021"
                    }
                ],
                "enquiries": [
                    {
                        "index": "I001",
                        "enquiryDate": "15042024",
                        "memberShortName": "NOT DISCLOSED",
                        "enquiryPurpose": "05",
                        "enquiryAmount": 1
                    }
                ]
            }
        ]
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Validation Error

Not Found Error

{
    "status_code": 401,
    "success": false,
    "message": "Unauthorized access",
    "message_code": "unauthorized"
}

This error occurs when the JWT token is invalid, expired, or missing.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

Use HTTPS for all API communications to ensure data encryption

Implement IP whitelisting for production environments

Rotate JWT tokens periodically to minimize security risks

User Experience Guidelines

Always obtain explicit user consent before pulling credit reports

Clearly communicate to users that this is a hard pull that will appear on their credit history

Implement proper loading states during API calls as credit report retrieval may take time

Display credit score and key insights prominently in your UI

Provide clear explanations of credit report elements to help users understand their report

Code Samples

cURL

Python

Node.js

Related APIs

Credit Report Experian: Retrieves credit reports from Experian bureau

Credit Report Equifax: Retrieves credit reports from Equifax bureau

Credit Report CRIF Highmark: Retrieves credit reports from CRIF Highmark bureau

Credit Score Check: Performs a soft pull credit score check without affecting credit history

Compliance and Legal Considerations

This API involves accessing sensitive personal and financial information. Ensure compliance with relevant data protection regulations including but not limited to:

Reserve Bank of India (RBI) guidelines on credit information

Information Technology Act, 2000

Credit Information Companies Regulation Act, 2005

Personal Data Protection laws

Always obtain explicit user consent before pulling credit reports, and maintain proper records of consent for audit purposes. This is a hard pull credit report that will be visible on the individual's credit history.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/credit-report-cibil/fetch-report' \ --header 'Content-Type: application/json' \ --data-raw '{ "mobile": "9912345675", "pan": "EKRPR1234F", "name": "Vishal Ahluwalia", "gender": "male", "consent": "Y" }'

{ "data": { "client_id": "credit_report_cibil_MgpnbhgjVsVrqpTebjYC", "mobile": "9988776655", "pan": "EKRPR1234F", "name": "Vishal Rathore", "gender": "male", "credit_score": "744", "credit_report": [ { "names": [ { "index": "N01", "name": "VISHAL SINGH RATHORE", "birthDate": "1999-07-25", "gender": "2" } ], "ids": [ { "index": "I01", "idType": "01", "idNumber": "EKRPR1234F" }, { "index": "I02", "idType": "09", "idNumber": "50056881070480" } ], "telephones": [ { "index": "T01", "telephoneNumber": "9988776655", "telephoneType": "03", "enquiryEnriched": "Y" }, { "index": "T02", "telephoneNumber": "9988776655", "telephoneType": "01", "enquiryEnriched": "Y" }, { "index": "T03", "telephoneNumber": "9988776655", "telephoneType": "00" } ], "emails": [ { "index": "C01", "emailID": "VISHALRATHORE@GMAIL.COM" } ], "employment": [ { "index": "E01", "accountType": "06", "dateReported": "31052024", "occupationCode": "04" } ], "scores": [ { "scoreName": "CIBILTUSC3", "scoreCardName": "08", "scoreCardVersion": "10", "scoreDate": "18092024", "score": "00644", "reasonCodes": [ { "reasonCodeName": "reasonCode1", "reasonCodeValue": "07" }, { "reasonCodeName": "reasonCode2", "reasonCodeValue": "03" }, { "reasonCodeName": "reasonCode3", "reasonCodeValue": "08" }, { "reasonCodeName": "reasonCode4", "reasonCodeValue": "04" }, { "reasonCodeName": "reasonCode5", "reasonCodeValue": "01" } ] } ], "addresses": [ { "index": "A01", "line1": "S/O: XYZ SINGH,,,KHOHARI,,DAUSA,", "line2": "DAUSA, 994 RAJASTHAN", "stateCode": "08", "pinCode": "321608", "addressCategory": "04", "dateReported": "30042024" }, { "index": "A02", "line1": "S/O: XYZ SINGH,,,KHOHARI,,DAUSA,", "line2": "DAUSA, 994 RAJASTHAN", "stateCode": "08", "pinCode": "321608", "addressCategory": "02", "dateReported": "30042024" }, { "index": "A03", "line1": "SO XYZ SINGHKHOHARIDAUSA WARD 4 WAR", "line2": "D 4", "stateCode": "08", "pinCode": "321608", "addressCategory": "01", "dateReported": "30112021" }, { "index": "A04", "line1": "994 RAJASTHAN", "stateCode": "08", "pinCode": "321608", "addressCategory": "04", "dateReported": "30092021" } ], "accounts": [ { "index": "T001", "memberShortName": "NOT DISCLOSED", "accountType": "69", "ownershipIndicator": 1, "dateOpened": "30112021", "lastPaymentDate": "30032023", "dateReported": "31072024", "highCreditAmount": 2000, "currentBalance": 9890, "amountOverdue": 9890, "paymentHistory": "DBT900900876846815755755724694663633602571541510480449421389358358297267236205175144114XXX055024000", "paymentStartDate": "01072024", "paymentEndDate": "01112021" }, { "index": "T002", "memberShortName": "NOT DISCLOSED", "accountType": "06", "ownershipIndicator": 1, "dateOpened": "09092021", "lastPaymentDate": "02042022", "dateReported": "31082024", "highCreditAmount": 2000, "currentBalance": 1248, "paymentHistory": "000000000000000000000000000000756725690659628598567537506478447416386355325294263233202172141113081050020000", "paymentStartDate": "01082024", "paymentEndDate": "01092021", "creditFacilityStatus": "02", "paymentTenure": 24, "woAmountTotal": 1248, "woAmountPrincipal": 1248, "paymentFrequency": "03", "actualPaymentAmount": 82 }, { "index": "T003", "memberShortName": "NOT DISCLOSED", "accountType": "06", "ownershipIndicator": 1, "dateOpened": "27052021", "dateReported": "30092021", "highCreditAmount": 60000, "currentBalance": 0, "paymentHistory": "000000000000", "paymentStartDate": "01092021", "paymentEndDate": "01062021", "paymentFrequency": "03" } ], "enquiries": [ { "index": "I001", "enquiryDate": "15042024", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "05", "enquiryAmount": 1 }, { "index": "I002", "enquiryDate": "15042024", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "05", "enquiryAmount": 1000000 }, { "index": "I003", "enquiryDate": "22122023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I004", "enquiryDate": "07082023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I005", "enquiryDate": "29052023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I006", "enquiryDate": "19042023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "05", "enquiryAmount": 5000 }, { "index": "I007", "enquiryDate": "19042023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "05", "enquiryAmount": 3000 }, { "index": "I008", "enquiryDate": "19042023", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "05", "enquiryAmount": 100000 }, { "index": "I009", "enquiryDate": "29112022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 100 }, { "index": "I010", "enquiryDate": "15082022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 100 }, { "index": "I011", "enquiryDate": "11072022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I012", "enquiryDate": "12052022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I013", "enquiryDate": "11052022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 1000 }, { "index": "I014", "enquiryDate": "01022022", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "10", "enquiryAmount": 100 }, { "index": "I015", "enquiryDate": "09092021", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "06", "enquiryAmount": 10000 }, { "index": "I016", "enquiryDate": "09092021", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "06", "enquiryAmount": 10000 }, { "index": "I017", "enquiryDate": "09092021", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "06", "enquiryAmount": 10000 }, { "index": "I018", "enquiryDate": "08092021", "memberShortName": "NOT DISCLOSED", "enquiryPurpose": "06", "enquiryAmount": 50000 } ] } ] }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Credit Report Cibil

Credit Report Cibil#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Credit Report Structure#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Credit Report Cibil

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Credit Report Structure

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples