Fetch PDF Report

Endpoint Overview

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

Description

The Credit Report PDF API allows you to retrieve a comprehensive credit report in PDF format for an individual. This endpoint processes personal identification details and returns a downloadable credit report containing the individual's credit score and complete credit history. The report provides valuable insights into a person's creditworthiness, payment history, and financial obligations.

Key Benefits

Instant access to comprehensive credit reports in PDF format

Secure handling of personal identification data with consent management

Simplified credit assessment for financial decision-making

Standardized credit information from reliable credit bureaus

Use Cases

Financial Services

Banking

Fintech

Loan application processing and risk assessment

Credit card application verification

Mortgage pre-approval screening

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
name	String	Yes	Full name of the individual
mobile	String	Yes	Mobile number of the individual
id_number	String	Yes	Identification number (PAN or Aadhaar)
id_type	Enum	Yes	Type of ID provided (`pan` or `aadhaar`)
consent	String	Yes	User consent indicator (e.g., "Y")
gender	Enum	Yes	Gender of the individual (`male` or `female`)

Example Request

{
    "name": "Vishal Rathore",
    "id_number": "EKRPR1234F",
    "id_type": "pan",
    "mobile": "8079012345",
    "consent": "Y",
    "gender": "male"
}

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.id_number	String	Masked identification number for privacy
data.id_type	String	Type of identification used (`pan` or `aadhaar`)
data.mobile	String	Mobile number provided in the request
data.name	String	Name of the individual as provided in the request
data.credit_score	String	Numerical credit score of the individual
data.credit_report	Object	Empty object placeholder for credit report data
data.credit_report_link	String	URL to download the PDF credit report
status_code	Number	HTTP status code indicating the result of the request
success	Boolean	Indicates whether the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "client_id": "credit_report_v2_pdf_ywWaXdhazoIEjbpPuvqc",
        "id_number": "********5514",
        "id_type": "aadhaar",
        "mobile": "8079012345",
        "name": "Vishal Rathore",
        "credit_score": "799",
        "credit_report": {},
        "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore/credit_report_v2/credit_reporure=568a2c563ec24f24fe3a6a03ce3180a888b27091d1e55d8a7562fd06247f3693"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Invalid ID Type

Missing Consent

Authentication Error

{
    "status_code": 400,
    "success": false,
    "message": "Invalid ID type provided. Supported types are 'pan' and 'aadhaar'.",
    "message_code": "invalid_id_type"
}

This error occurs when the id_type parameter contains a value other than 'pan' or 'aadhaar'.

Integration Best Practices

Security Recommendations

Store API keys 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 additional security in production environments

Rotate JWT tokens periodically and implement token expiration policies

User Experience Guidelines

Always obtain explicit user consent before fetching credit reports

Clearly communicate to users how their data will be used

Implement proper loading states while waiting for the API response

Provide clear error messages to users when issues occur

Allow users to download and save their credit report PDF

Code Samples

cURL

Python

Node.js

Related APIs

Credit Score API - Provides a numerical credit score without the full PDF report

Credit Report Summary API - Provides a summarized version of the credit report in JSON format

Credit Monitoring API - Allows for ongoing monitoring of credit changes

Compliance and Legal Considerations

When using this API, ensure compliance with data privacy regulations such as GDPR or local data protection laws. Always obtain explicit user consent before accessing their credit information. The credit report data should be handled securely and only used for the specific purpose for which consent was obtained. Retention policies should be implemented to ensure credit data is not stored longer than necessary.

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

{ "data": { "client_id": "credit_report_v2_pdf_ywWaXdhazoIEjbpPuvqc", "id_number": "********5514", "id_type": "aadhaar", "mobile": "8079012345", "name": "Vishal Rathore", "credit_score": "799", "credit_report": {}, "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore/credit_report_v2/credit_reporure=568a2c563ec24f24fe3a6a03ce3180a888b27091d1e55d8a7562fd06247f3693" }, "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 ********************

Fetch PDF Report

Fetch PDF Report#

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

Fetch PDF Report

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples