Feel free to reach techsupport@surepass.io for any technical support or guidance.
Fetch Report
Production
https://kyc-api.surepass.app
Production
https://kyc-api.surepass.app
POST
https://kyc-api.surepass.app
Fetch Credit Report
POST /api/v1/credit-report-v2/fetch-report
Description
This API endpoint allows you to fetch a comprehensive credit report for an individual using their personal identification details. The service retrieves credit information from credit bureaus and returns a standardized report containing the individual's credit score and detailed credit history. This enables businesses to make informed decisions about creditworthiness, loan approvals, and risk assessment.
Key Benefits
- Instant access to comprehensive credit reports with minimal input requirements
- Standardized credit data format for easy integration into existing systems
- Masked sensitive information (like Aadhaar numbers) for enhanced security
- Complete credit history including personal information, identification details, and credit score
Use Cases
- Loan application processing and risk assessment - Credit card application verification - Mortgage pre-approval screening - Account opening KYC verification - Credit limit determination - Overdraft facility approval - Digital lending platforms - Buy-now-pay-later services - Automated credit decisioning systemsTechnical Implementation
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
Authorizationheader asBearer TOKEN.
Different authentication tokens are used for sandbox and production environments:
- Sandbox:
https://sandbox.surepass.io - Production:
https://kyc-api.surepass.io
| 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 for credit check (e.g., "Y") |
| gender | String 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"
}
| Parameter | Type | Description |
|---|---|---|
| data | Object | Container for the response data |
| data.client_id | String | Unique identifier for the credit report request |
| data.mobile | String | Mobile number provided in the request |
| data.id_number | String | Masked identification number for security |
| data.id_type | String | Type of ID used (pan or aadhaar) |
| data.name | String | Name of the individual |
| data.gender | String | Gender of the individual |
| data.credit_score | String | Numerical credit score |
| data.credit_report | Object | Detailed credit report from the bureau |
| data.credit_report_link | String | Link to download the credit report (if available) |
| status_code | Number | HTTP status code of the response |
| success | Boolean | Indicates if 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_umOnUcqlxqevWQtIGHXQ",
"id_number": "********5514",
"id_type": "aadhaar",
"mobile": "8079012345",
"name": "Vishal Rathore",
"credit_score": "799",
"credit_report": {
"InquiryResponseHeader": {
"ClientID": "randomClientID987",
"CustRefField": "654321",
"ReportOrderNO": "98765432",
"ProductCode": [
"CREDRPT"
],
"SuccessCode": "2",
"Date": "2023-11-20",
"Time": "12:45:30"
},
"InquiryRequestInfo": {
"InquiryPurpose": "01",
"FirstName": "JOHN DOE",
"InquiryAddresses": [
{
"seq": "2",
"AddressType": [
"O"
],
"AddressLine1": "123 Main Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "1",
"PhoneType": [
"M"
],
"Number": "9876543210"
}
],
"IDDetails": [
{
"seq": "1",
"IDType": "P",
"IDValue": "ABCDE1234F",
"Source": "Inquiry"
},
{
"seq": "3",
"IDType": "D",
"Source": "Inquiry"
},
{
"seq": "5",
"IDType": "A",
"Source": "Inquiry"
}
],
"DOB": "1990-05-15"
},
"Score": [
{
"Type": "FICO",
"Version": "5.0"
}
],
"CCRResponse": {
"Status": "0",
"CIRReportDataLst": [
{
"InquiryResponseHeader": {
"CustomerCode": "CUSTOMER001",
"CustRefField": "654321",
"ReportOrderNO": "98765432",
"ProductCode": [
"CREDRPT"
],
"SuccessCode": "0",
"Date": "2023-11-20",
"Time": "12:45:30",
"HitCode": "20",
"CustomerName": "ACME Corp"
},
"InquiryRequestInfo": {
"InquiryPurpose": "Credit",
"FirstName": "JOHN DOE",
"InquiryAddresses": [
{
"seq": "2",
"AddressType": [
"O"
],
"AddressLine1": "123 Main Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "1",
"PhoneType": [
"M"
],
"Number": "9876543210"
}
],
"IDDetails": [
{
"seq": "1",
"IDType": "P",
"IDValue": "ABCDE1234F",
"Source": "Inquiry"
}
],
"DOB": "1990-05-15"
},
"Score": [
{
"Type": "FICO",
"Version": "5.0"
}
],
"CIRReportData": {
"IDAndContactInfo": {
"PersonalInfo": {
"Name": {
"FullName": "JOHN DOE",
"FirstName": "JOHN",
"LastName": "DOE"
},
"AliasName": {},
"DateOfBirth": "1990-05-15",
"Gender": "Male",
"Age": {
"Age": "33"
},
"PlaceOfBirthInfo": {}
},
"IdentityInfo": {
"PANId": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"IdNumber": "ABCDE1234F"
}
],
"Passport": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"IdNumber": "P1234567"
}
]
},
"AddressInfo": [
{
"Seq": "2",
"ReportedDate": "2015-07-31",
"Address": "789 Pine Street",
"State": "CA",
"Postal": "90210",
"Type": "Office"
},
{
"Seq": "1",
"ReportedDate": "2015-07-31",
"Address": "123 Main Street",
"State": "CA",
"Postal": "90210",
"Type": "Primary"
}
],
"PhoneInfo": [
{
"seq": "2",
"typeCode": "H",
"ReportedDate": "2015-07-31",
"Number": "9879876543"
}
],
"EmailAddressInfo": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"Email": "john.doe@email.com"
}
]
}
}
},
{
"InquiryResponseHeader": {
"CustomerCode": "CUSTOMER002",
"CustRefField": "789012",
"ReportOrderNO": "34567890",
"ProductCode": [
"IDCR"
],
"SuccessCode": "1",
"Date": "2023-11-19",
"Time": "09:15:45",
"HitCode": "15",
"CustomerName": "ABC Corporation"
},
"InquiryRequestInfo": {
"InquiryPurpose": "Credit",
"FirstName": "ALICE JOHNSON",
"InquiryAddresses": [
{
"seq": "3",
"AddressType": [
"O"
],
"AddressLine1": "789 Pine Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "2",
"PhoneType": [
"H"
],
"Number": "9879876543"
}
],
"IDDetails": [
{
"seq": "2",
"IDType": "A",
"IDValue": "XYZAB1234C",
"Source": "Inquiry"
}
],
"DOB": "1987-12-15"
},
"Score": [
{
"Type": "FICO",
"Version": "8.0"
}
],
"CIRReportData": {
"IDAndContactInfo": {
"PersonalInfo": {
"Name": {
"FullName": "ALICE JOHNSON",
"FirstName": "ALICE",
"LastName": "JOHNSON"
},
"AliasName": {},
"DateOfBirth": "1987-12-15",
"Gender": "Female",
"Age": {
"Age": "35"
},
"PlaceOfBirthInfo": {}
},
"IdentityInfo": {
"PANId": [
{
"seq": "2",
"ReportedDate": "2016-02-28",
"IdNumber": "XYZAB1234C"
}
],
"Passport": [
{
"seq": "2",
"ReportedDate": "2016-02-28",
"IdNumber": "P9876543"
}
]
},
"AddressInfo": [
{
"Seq": "2",
"ReportedDate": "2016-02-28",
"Address": "789 Pine Street",
"State": "CA",
"Postal": "90210",
"Type": "Office"
}
],
"PhoneInfo": [
{
"seq": "2",
"typeCode": "H",
"ReportedDate": "2016-02-28",
"Number": "9879876543"
}
]
}
}
}
],
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
},
"credit_report_link": ""
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kyc-api.surepass.app/api/v1/credit-report-v2/fetch-report' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Vishal Rathore",
"id_number": "EKRPR1234F",
"id_type": "pan",
"mobile": "8079012345",
"consent": "Y",
"gender": "male"
}'Response Response Example
200 - Success
{
"data": {
"client_id": "credit_report_v2_umOnUcqlxqevWQtIGHXQ",
"id_number": "********5514",
"id_type": "aadhaar",
"mobile": "8079012345",
"name": "Vishal Rathore",
"credit_score": "799",
"credit_report": {
"InquiryResponseHeader": {
"ClientID": "randomClientID987",
"CustRefField": "654321",
"ReportOrderNO": "98765432",
"ProductCode": [
"CREDRPT"
],
"SuccessCode": "2",
"Date": "2023-11-20",
"Time": "12:45:30"
},
"InquiryRequestInfo": {
"InquiryPurpose": "01",
"FirstName": "JOHN DOE",
"InquiryAddresses": [
{
"seq": "2",
"AddressType": [
"O"
],
"AddressLine1": "123 Main Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "1",
"PhoneType": [
"M"
],
"Number": "9876543210"
}
],
"IDDetails": [
{
"seq": "1",
"IDType": "P",
"IDValue": "ABCDE1234F",
"Source": "Inquiry"
},
{
"seq": "3",
"IDType": "D",
"Source": "Inquiry"
},
{
"seq": "5",
"IDType": "A",
"Source": "Inquiry"
}
],
"DOB": "1990-05-15"
},
"Score": [
{
"Type": "FICO",
"Version": "5.0"
}
],
"CCRResponse": {
"Status": "0",
"CIRReportDataLst": [
{
"InquiryResponseHeader": {
"CustomerCode": "CUSTOMER001",
"CustRefField": "654321",
"ReportOrderNO": "98765432",
"ProductCode": [
"CREDRPT"
],
"SuccessCode": "0",
"Date": "2023-11-20",
"Time": "12:45:30",
"HitCode": "20",
"CustomerName": "ACME Corp"
},
"InquiryRequestInfo": {
"InquiryPurpose": "Credit",
"FirstName": "JOHN DOE",
"InquiryAddresses": [
{
"seq": "2",
"AddressType": [
"O"
],
"AddressLine1": "123 Main Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "1",
"PhoneType": [
"M"
],
"Number": "9876543210"
}
],
"IDDetails": [
{
"seq": "1",
"IDType": "P",
"IDValue": "ABCDE1234F",
"Source": "Inquiry"
}
],
"DOB": "1990-05-15"
},
"Score": [
{
"Type": "FICO",
"Version": "5.0"
}
],
"CIRReportData": {
"IDAndContactInfo": {
"PersonalInfo": {
"Name": {
"FullName": "JOHN DOE",
"FirstName": "JOHN",
"LastName": "DOE"
},
"AliasName": {},
"DateOfBirth": "1990-05-15",
"Gender": "Male",
"Age": {
"Age": "33"
},
"PlaceOfBirthInfo": {}
},
"IdentityInfo": {
"PANId": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"IdNumber": "ABCDE1234F"
}
],
"Passport": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"IdNumber": "P1234567"
}
]
},
"AddressInfo": [
{
"Seq": "2",
"ReportedDate": "2015-07-31",
"Address": "789 Pine Street",
"State": "CA",
"Postal": "90210",
"Type": "Office"
},
{
"Seq": "1",
"ReportedDate": "2015-07-31",
"Address": "123 Main Street",
"State": "CA",
"Postal": "90210",
"Type": "Primary"
}
],
"PhoneInfo": [
{
"seq": "2",
"typeCode": "H",
"ReportedDate": "2015-07-31",
"Number": "9879876543"
}
],
"EmailAddressInfo": [
{
"seq": "1",
"ReportedDate": "2015-07-31",
"Email": "john.doe@email.com"
}
]
}
}
},
{
"InquiryResponseHeader": {
"CustomerCode": "CUSTOMER002",
"CustRefField": "789012",
"ReportOrderNO": "34567890",
"ProductCode": [
"IDCR"
],
"SuccessCode": "1",
"Date": "2023-11-19",
"Time": "09:15:45",
"HitCode": "15",
"CustomerName": "ABC Corporation"
},
"InquiryRequestInfo": {
"InquiryPurpose": "Credit",
"FirstName": "ALICE JOHNSON",
"InquiryAddresses": [
{
"seq": "3",
"AddressType": [
"O"
],
"AddressLine1": "789 Pine Street",
"State": "CA",
"Postal": "90210"
}
],
"InquiryPhones": [
{
"seq": "2",
"PhoneType": [
"H"
],
"Number": "9879876543"
}
],
"IDDetails": [
{
"seq": "2",
"IDType": "A",
"IDValue": "XYZAB1234C",
"Source": "Inquiry"
}
],
"DOB": "1987-12-15"
},
"Score": [
{
"Type": "FICO",
"Version": "8.0"
}
],
"CIRReportData": {
"IDAndContactInfo": {
"PersonalInfo": {
"Name": {
"FullName": "ALICE JOHNSON",
"FirstName": "ALICE",
"LastName": "JOHNSON"
},
"AliasName": {},
"DateOfBirth": "1987-12-15",
"Gender": "Female",
"Age": {
"Age": "35"
},
"PlaceOfBirthInfo": {}
},
"IdentityInfo": {
"PANId": [
{
"seq": "2",
"ReportedDate": "2016-02-28",
"IdNumber": "XYZAB1234C"
}
],
"Passport": [
{
"seq": "2",
"ReportedDate": "2016-02-28",
"IdNumber": "P9876543"
}
]
},
"AddressInfo": [
{
"Seq": "2",
"ReportedDate": "2016-02-28",
"Address": "789 Pine Street",
"State": "CA",
"Postal": "90210",
"Type": "Office"
}
],
"PhoneInfo": [
{
"seq": "2",
"typeCode": "H",
"ReportedDate": "2016-02-28",
"Number": "9879876543"
}
]
}
}
}
],
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}
},
"credit_report_link": ""
},
"status_code": 200,
"success": true,
"message": "Success",
"message_code": "success"
}Request
Header Params
Body Params application/json