Initiate

POST

/api/v1/digilocker/initiate

Begin the DigiLocker consent flow for a user. This API generates a unique session and a secure redirect link where users can authenticate and authorize sharing official documents with your application.

Request

Header Params

Body Params application/json

Example

{
        "customer_details": {
                "full_name": "John Doe",
                "mobile_number": "9999999999",
                "user_email": "test@gmail.com"
        },
        "expiry_minutes": 10,
        "return_url": "https://google.com",
        "state": "test"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/digilocker/initiate' \
--header 'Accept: application/json' \
--header 'x-client-id: {{client_id}}' \
--header 'x-client-secret: {{client_secret}}' \
--header 'Content-Type: application/json' \
--data-raw '{
        "customer_details": {
                "full_name": "John Doe",
                "mobile_number": "9999999999",
                "user_email": "test@gmail.com"
        },
        "expiry_minutes": 10,
        "return_url": "https://google.com",
        "state": "test"
}'

Responses

🟢200Success

application/json

Body

Example

{
    "response_code": 200,
    "status": "success",
    "message": "Success",
    "data": {
        "request_id": "DGLR2026462830_2560552f",
        "digilocker_url": "https://digilocker-sdk.notbot.in/?type=digilocker&token=.eJyrVkr.......",
        "expired_in_minutes": 10,
        "expired_at": "2022-08-30T20:36:46+05:30"
    },
    "meta": {
        "request_id": "babe5e66-9a96-4724-b76c-5c0041aab906",
        "time": "2022-08-30T20:26:47+05:30"
    }
}

🟠422Parameter Error

🟠400Bad Request

Rate Limits

Check Status

Initiate

📥 Initiate DigiLocker Consent#

Request

Request Code Samples

Responses

📥 Initiate DigiLocker Consent