Credit Report Commercial PDF

Endpoint Overview

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

Description

This endpoint provides access to commercial credit reports in PDF format for businesses. It allows you to retrieve comprehensive credit information about a business entity using their business name, PAN number, and mobile number. The API returns both the credit score and a downloadable PDF report containing detailed credit information that can be used for risk assessment, lending decisions, and business verification.

Key Benefits

Instant access to commercial credit reports without manual bureau processes

Downloadable PDF format for easy sharing and record-keeping

Option to receive raw JSON data for automated processing

Secure and consent-based access to credit information

Use Cases

Financial Services

B2B Companies

Insurance

Evaluate creditworthiness of business loan applicants

Perform pre-approval screening for business credit cards

Assess risk for invoice financing and supply chain financing

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
business_name	String	Yes	The registered name of the business entity
pan	String	Yes	Permanent Account Number (PAN) of the business
mobile	String	Yes	Contact mobile number associated with the business
consent	String	Yes	User consent for accessing credit information (must be "Y")
raw	Boolean	No	When set to true, includes the raw JSON report in the response

Example Request

{
    "business_name": "SHAIK SADIQ ALI",
    "mobile": "8977715735",
    "pan": "IQGPS3724B",
    "consent": "Y"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the response data
data.client_id	String	Unique identifier for the credit report request
data.pan	String	PAN number of the business as provided in the request
data.mobile	String	Mobile number as provided in the request
data.business_name	String	Business name as provided in the request
data.credit_score	String	Credit score of the business (if available)
data.credit_report	Object	Raw credit report data (if requested with raw=true)
data.credit_report_link	String	Temporary URL to download the credit report PDF
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 identifying the result

Example Successful Response

{
    "data": {
        "client_id": "credit_report_commercial_pdf_ddwabvOTsrFGfrfYWrkj",
        "pan": "IQGPS3724B",
        "mobile": "8977715735",
        "business_name": "SHAIK SADIQ ALI",
        "credit_score": "",
        "credit_report": {},
        "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/username_2kecgbknrxrabfmh7yi2obkba3p/credit_report_commercial/credit_report_commercial_pdf_ddwabvOTsrFGfrfYWrkj/commercial_report_1742898017877581.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5FYWPQJEB%2F20250325%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250325T102018Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=ae16178e45ba8725311894efdca31475273a0d367cfcc260c2ee4f99c730ee4a"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid PAN

Missing Consent

Business Not Found

{
    "data": null,
    "status_code": 400,
    "success": false,
    "message": "Invalid PAN format",
    "message_code": "invalid_pan_format"
}

The PAN number provided does not match the required format for a valid PAN.

Integration Best Practices

Security Recommendations

Store API credentials securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

The credit report link is temporary and expires after 10 minutes - download it promptly

Implement proper consent management to ensure compliance with data privacy regulations

User Experience Guidelines

Clearly explain to users why their business credit information is being accessed

Obtain explicit consent before making the API call

Provide a loading indicator during API processing as report generation may take a few seconds

Allow users to download and save the PDF report for their records

Code Samples

cURL

Python

Node.js

Related APIs

Credit Report Commercial JSON: Provides business credit information in JSON format

Business Verification API: Verifies business registration details

PAN Verification API: Validates PAN card details

Compliance and Legal Considerations

Always obtain explicit user consent before accessing credit information

Store and handle credit reports in compliance with data protection regulations

Credit report data should only be used for legitimate business purposes

The PDF report contains sensitive financial information and should be handled securely

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/credit-report-commercial/fetch-report-pdf' \ --header 'Content-Type: application/json' \ --data-raw '{ "business_name": "SHAIK SADIQ ALI", "mobile": "8977715735", "pan": "IQGPS3724B", "consent": "Y" }'

{ "data": { "client_id": "credit_report_commercial_pdf_ddwabvOTsrFGfrfYWrkj", "pan": "IQGPS3724B", "mobile": "8977715735", "business_name": "SHAIK SADIQ ALI", "credit_score": "", "credit_report": {}, "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/username_2kecgbknrxrabfmh7yi2obkba3p/credit_report_commercial/credit_report_commercial_pdf_ddwabvOTsrFGfrfYWrkj/commercial_report_1742898017877581.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5FYWPQJEB%2F20250325%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20250325T102018Z&X-Amz-Expires=600&X-Amz-SignedHeaders=host&X-Amz-Signature=ae16178e45ba8725311894efdca31475273a0d367cfcc260c2ee4f99c730ee4a" }, "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 Commercial PDF

Credit Report Commercial 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 Commercial 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