Pull KRA Config

Endpoint Overview

POST /api/v1/pull-kra/config

Description

This API endpoint allows you to configure KRA (KYC Registration Agency) authentication credentials for pulling KYC data from various KRA authorities in India. By setting up these credentials, you can enable seamless KYC verification processes through multiple KRA service providers.

Key Benefits

Configure multiple KRA authorities with a single API call

Securely store authentication credentials for automated KYC verification

Receive immediate confirmation of successful configuration for each KRA provider

Streamline the KYC verification process for financial services

Use Cases

Financial Services

Wealth Management

FinTech

Configure KRA credentials for customer onboarding in banking applications

Set up automated KYC verification for mutual fund investments

Enable seamless customer verification for insurance policy issuance

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
kra_user	String	Yes	Username for the KRA Portal
kra_password	String	Yes	Password for the KRA Portal
kra_authority	String	Yes	KRA Authority identifier
kra_additional	String	Yes	Additional username for the KRA Portal

Example Request

{
    "kra_authority": "NDML",
    "kra_user": "example_user",
    "kra_password": "secure_password",
    "kra_additional": "additional_username"
}

Process Response

Response Parameters

Parameter	Type	Description
cvl	Boolean	Indicates if CVL KRA authentication config was saved successfully
ndml	Boolean	Indicates if NDML KRA authentication config was saved successfully
cams	Boolean	Indicates if CAMS KRA authentication config was saved successfully
dotex	Boolean	Indicates if DOTEX KRA authentication config was saved successfully
karvy	Boolean	Indicates if KARVY KRA authentication config was saved successfully

Example Successful Response

{
    "cvl": true,
    "ndml": true,
    "cams": false,
    "dotex": true,
    "karvy": false
}

Possible Error Responses

Authentication Error

Validation Error

{
    "error": "unauthorized",
    "message": "Invalid or expired token"
}

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

Integration Best Practices

Security Recommendations

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

Implement proper encryption for sensitive data in transit and at rest

Rotate KRA credentials periodically according to your security policy

Use environment-specific credentials for sandbox and production environments

User Experience Guidelines

Implement proper error handling to provide clear feedback to users

Consider implementing a configuration status dashboard for monitoring

Cache configuration status to avoid unnecessary API calls

Implement retry logic with exponential backoff for failed configuration attempts

Code Samples

cURL

Python

Node.js

Related APIs

KRA PAN Verification API - Verify PAN details against KRA records

KRA Data Pull API - Retrieve KYC data from configured KRA authorities

KRA Status Check API - Check the status of KRA verification requests

Compliance and Legal Considerations

This API handles sensitive KRA authentication credentials. Ensure you comply with all relevant data protection regulations, including but not limited to SEBI guidelines for KYC verification and KRA data handling. Credentials should be stored securely and accessed only by authorized personnel.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/pull-kra/config' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "kra_authority": "{{kra_authority}}", "kra_user": "{{kra_user}}", "kra_password": "{{kra_password}}", "kra_additional": "{{additional_auth}}" }'

Pull KRA Config

Pull KRA Config#

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 Config

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples