Credit Report Experian PDF

Endpoint Overview

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

Description

This API endpoint retrieves a person's credit report in PDF format from Experian, one of the major credit bureaus. The endpoint processes the provided personal information, obtains consent, and returns a comprehensive credit report including the individual's credit score and a downloadable PDF link to the full report.

Key Benefits

Instant access to official Experian credit reports with credit scores

Secure PDF delivery with direct download link

Simplified consent management for regulatory compliance

Standardized format for easy integration into financial applications

Use Cases

Financial Services

Lending

FinTech

Credit risk assessment for loan applications

Pre-qualification screening for credit products

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

Request Body

Parameter	Type	Required	Description
name	String	Yes	Full name of the individual as it appears on official documents
consent	String	Yes	User's explicit consent to retrieve credit information (e.g., "Y")
mobile	String	Yes	Valid mobile number of the individual
pan	String	Yes	Permanent Account Number (PAN) of the individual
raw	Boolean	No	When set to true, includes the raw JSON report in the response

Example Request

{
    "name": "Mahendra Singh Rajput",
    "consent": "Y",
    "mobile": "8890812345",
    "pan": "FPVPR1234Q"
}

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.name	String	Name of the individual (as returned by Experian)
data.mobile	String	Mobile number of the individual
data.pan	String	PAN number of the individual
data.credit_score	String	Numeric credit score from Experian
data.credit_report	Object	Raw credit report data (may be empty as PDF is provided)
data.credit_report_link	String	Secure URL to download the credit report PDF
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_experian_pdf_yzWulawpzCczmLyKazqJ",
        "name": "MAHENDRA SINGH RAJPUT",
        "mobile": "8890812345",
        "pan": "FPVPR1234Q",
        "credit_score": "761",
        "credit_report": {},
        "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore.surepass/credit_report_experian/credit_report_experian_pdf_yzWulawpzCczmLyKazqJ/credit_report_1730202365240415.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5FYWPQJEB%2F20241029%2Fap-south-1%2Fs3%2Faws"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Invalid Input

Service Unavailable

{
    "status_code": 401,
    "success": false,
    "message": "Invalid or expired token",
    "message_code": "unauthorized"
}

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

Integration Best Practices

Security Recommendations

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

Implement proper error handling for failed API requests

Set appropriate timeouts for API calls to handle potential delays

Implement retry logic with exponential backoff for transient errors

Validate all user inputs before sending to the API

User Experience Guidelines

Clearly explain to users why their credit information is being accessed

Obtain and document explicit consent before making API calls

Provide a loading indicator during API processing

Implement a user-friendly way to view the credit report PDF

Consider caching credit scores (but not the full report) to reduce redundant calls

Code Samples

cURL

Python

Node.js

Related APIs

Credit Report Experian JSON - Retrieves credit report in JSON format

Credit Report CIBIL - Retrieves credit report from CIBIL bureau

Credit Report Equifax - Retrieves credit report from Equifax bureau

Credit Score Check - Retrieves only the credit score without the full report

Compliance and Legal Considerations

This API handles sensitive financial information and is subject to regulatory requirements. Ensure you have proper consent mechanisms in place before retrieving credit reports. The data should be handled in accordance with data protection regulations and financial information privacy laws. Credit reports should only be accessed with explicit user consent and for legitimate business purposes.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/credit-report-experian/fetch-report-pdf' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Mahendra Singh Rajput", "consent": "Y", "mobile": "8890812345", "pan": "FPVPR1234Q" }'

{ "data": { "client_id": "credit_report_experian_pdf_yzWulawpzCczmLyKazqJ", "name": "MAHENDRA SINGH RAJPUT", "mobile": "8890812345", "pan": "FPVPR1234Q", "credit_score": "761", "credit_report": {}, "credit_report_link": "https://aadhaar-kyc-docs.s3.amazonaws.com/vishal.rathore.surepass/credit_report_experian/credit_report_experian_pdf_yzWulawpzCczmLyKazqJ/credit_report_1730202365240415.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAY5K3QRM5FYWPQJEB%2F20241029%2Fap-south-1%2Fs3%2Faws" }, "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 Experian PDF

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