Pull KRA

Endpoint Overview

POST /api/v1/pull-kra/pull-kra

Description

This API endpoint allows you to retrieve KYC (Know Your Customer) information from the KRA (KYC Registration Agency) database using a PAN number and date of birth. The service verifies the individual's identity against official KRA records and returns their registration status along with relevant documents.

Key Benefits

Instant verification of KYC status from official KRA records

Access to KRA documents without manual retrieval processes

Simplified compliance with regulatory KYC requirements

Reduction in customer onboarding time for financial services

Use Cases

Financial Services

Wealth Management

Fintech

Streamline customer onboarding for mutual fund investments

Verify KYC compliance status before opening demat accounts

Automate KYC checks for loan and credit card applications

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 authentication using JWT
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
id_number	String	Yes	PAN Number of the individual
dob	String	Yes	Date of Birth in yyyy-mm-dd format
kra_code	String	No	Kra Code

Example Request

{
    "id_number": "ABCPD1234E",
    "dob": "1990-01-15"
}

Process Response

Response Parameters

Parameter	Type	Description
client_id	String	Unique identifier for the request
dob	String	Date of Birth in yyyy-mm-dd format
pan_number	String	PAN Number of the individual
kra_authority	String	KRA Authority Code that processed the request
document_link	String	URL to access documents extracted from KRA
kra_status	Boolean	KRA Registration Status (true if registered, false if not)

Example Successful Response

{
    "client_id": "a1b2c3d4-5e6f-7g8h-9i0j-klmno123456",
    "dob": "1990-01-15",
    "pan_number": "ABCPD1234E",
    "kra_authority": "CAMS",
    "document_link": "https://surepass.io/documents/kra/a1b2c3d4-5e6f-7g8h-9i0j-klmno123456",
    "kra_status": true
}

Possible Error Responses

Invalid PAN

Invalid DOB

Record Not Found

{
    "status": 400,
    "error": "Bad Request",
    "message": "Invalid PAN number format"
}

The provided PAN number does not match the required format or contains invalid characters.

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

Use HTTPS for all API communications to ensure data encryption

Implement IP whitelisting for production environments when possible

User Experience Guidelines

Implement appropriate loading indicators during API calls

Provide clear error messages to end-users when verification fails

Cache successful verification results to minimize repeated API calls

Consider implementing a fallback verification method if KRA verification fails

Code Samples

cURL

Python

Node.js

Related APIs

PAN Verification API: Verifies PAN card details against government records

Aadhaar Verification API: Validates Aadhaar card details for identity verification

Document OCR API: Extracts information from uploaded KYC documents

Compliance and Legal Considerations

This API accesses official KRA records which contain sensitive personal information. Usage must comply with applicable data protection regulations including SEBI guidelines for KYC verification. Ensure you have proper consent from individuals before retrieving their KRA information and maintain appropriate data security measures for any stored verification results.

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/pull-kra/pull-kra' \ --header 'Content-Type: application/json' \ --data-raw '{ "id_number": "{{pan_number}}", "dob": "{{dob}}" }'

{ "client_id": "a1b2c3d4-5e6f-7g8h-9i0j-klmno123456", "dob": "1990-01-15", "pan_number": "ABCPD1234E", "kra_authority": "CAMS", "document_link": "https://surepass.io/documents/kra/a1b2c3d4-5e6f-7g8h-9i0j-klmno123456", "kra_status": true }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Pull KRA

Pull KRA#

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

Pull KRA

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples