Feel free to reach techsupport@surepass.io for any technical support or guidance.

Initialize

Production

https://kyc-api.surepass.app

POST

/api/v1/aadhaar-v4/initialize

Initialize an OVSE verification session.

Creates a signed JWT intent and returns data based on the chosen channel:

qr (cross-device): Returns qr_data for rendering a QR code scannable by Aadhaar/Pehchaan app

app (same-device Android): Returns intent_data JWT for launching Pehchaan via Android intent. Requires app_signature

web (web-to-app link): Returns intent_data JWT and a shareable web_link URL that launches Pehchaan when opened on Android. The link can be sent via WhatsApp, SMS, etc.

After initialization, poll /status to track progress. Once completed, call /result to retrieve verified Aadhaar claims.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Session initialized successfully

Body

🟠422Parameter Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Cross-device QR flowWeb link flow for WhatsApp/SMSSame-device Android intent

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/aadhaar-v4/initialize' \
--header 'Content-Type: application/json' \
--data-raw '{
    "channel": "qr"
}'

Response Example

{
    "data": {
        "client_id": "aadhaar_ovse_abc123",
        "qr_data": "string",
        "intent_data": "string",
        "channel": "qr",
        "status": "pending",
        "web_link": "https://ovse-test.surepass.in/launch?id=aadhaar_ovse_abc123"
    },
    "status_code": 200,
    "message": "OVSE session initialized.",
    "success": true
}

Upload eAadhaar

Status