Credit Report Cibil PDF

Endpoint Overview

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

Description

This API retrieves a comprehensive CIBIL credit report (Hard Pull) in PDF format for a specified client. It provides essential credit information including the client's credit score and a downloadable PDF report. The hard pull credit report contains detailed credit history, active loans, credit card information, and other financial obligations that impact the individual's creditworthiness.

Key Benefits

Obtain official CIBIL credit reports with a single API call

Access comprehensive credit information including credit score and full report details

Receive a downloadable PDF link for easy sharing and record-keeping

Streamline credit assessment processes with standardized credit information

Use Cases

Financial Services

Banking

Fintech

Loan application processing to evaluate creditworthiness

Credit card approval workflows for new applicants

Risk assessment for financial product offerings

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 for authentication (JWT format)
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
mobile	String	Yes	Client's mobile number (10 digits)
pan	String	Yes	Client's PAN (Permanent Account Number)
name	String	Yes	Client's full name as per records
gender	String (Enum)	Yes	Client's gender - must be either "male" or "female"
consent	String (Enum)	Yes	User's consent to pull credit report - must be "Y"
raw	Boolean	No	When set to true, includes the raw JSON report in the response

Example Request

{
    "mobile": "9988776655",
    "pan": "EKRPR1234F",
    "name": "Vishal Rathore",
    "gender": "male",
    "consent": "Y"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for all response data
data.client_id	String	Unique identifier for the client's credit report request
data.name	String	Client's full name as provided in the request
data.mobile	String	Client's mobile number as provided in the request
data.pan	String	Client's PAN number as provided in the request
data.gender	String	Client's gender as provided in the request
data.credit_score	String	CIBIL credit score of the client
data.credit_report	Object	Raw credit report data as received from CIBIL (may be empty)
data.credit_report_link	String	URL to download the PDF version of the credit report
status_code	Integer	HTTP status code indicating the result of the request
success	Boolean	Indicates whether the request was successful
message	String	Human-readable message describing the result
message_code	String	Machine-readable code indicating the result type

Example Successful Response

{
    "data": {
        "client_id": "credit_report_cibil_pdf_vIaturrIyayNxedOUOsG",
        "name": "Vishal Rathore",
        "mobile": "9966887744",
        "pan": "EKRPR1234F",
        "gender": "male",
        "credit_score": "744",
        "credit_report": {},
        "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore.surepass/credit_report_cibil/credit_report_cibil_pdf_vIaturrIyayNxedOUOsG/credit_report_1726650832704638.pdf?X-Amz-Algorithm=AWS4-HMAC-S5"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid Parameters

Authentication Error

Report Not Found

{
    "status_code": 400,
    "success": false,
    "message": "Invalid parameters provided",
    "message_code": "invalid_parameters",
    "errors": {
        "mobile": "Mobile number must be 10 digits",
        "pan": "Invalid PAN format"
    }
}

Occurs when the request contains invalid or improperly formatted parameters.

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 in transit

Implement proper consent management to comply with data protection regulations

User Experience Guidelines

Clearly communicate to users that a hard pull credit check will be performed

Obtain explicit consent before initiating the credit report request

Provide clear feedback during the credit report retrieval process

Implement proper error handling to guide users when issues occur

Code Samples

cURL

Python

Node.js

Related APIs

Credit Report CIBIL JSON - Retrieves credit report in JSON format

Credit Report Experian - Retrieves credit report from Experian bureau

Credit Report CRIF - Retrieves credit report from CRIF bureau

Credit Score Check - Performs a soft pull credit score check

Compliance and Legal Considerations

This API performs a hard pull on the client's credit report, which may impact their credit score. Ensure you have explicit consent from the user before making this API call. The consent parameter in the request is mandatory and must be set to "Y" to indicate that the user has provided consent. This API is subject to RBI guidelines on credit information access and usage. Ensure compliance with all applicable data protection and privacy regulations including but not limited to the Personal Data Protection Bill.

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

{ "data": { "client_id": "credit_report_cibil_pdf_vIaturrIyayNxedOUOsG", "name": "Vishal Rathore", "mobile": "9966887744", "pan": "EKRPR1234F", "gender": "male", "credit_score": "744", "credit_report": {}, "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore.surepass/credit_report_cibil/credit_report_cibil_pdf_vIaturrIyayNxedOUOsG/credit_report_1726650832704638.pdf?X-Amz-Algorithm=AWS4-HMAC-S5" }, "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 PDF

Credit Report Cibil PDF#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Credit Report Cibil PDF

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples