Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Initiate Session

post/v2/kyc/digilocker/initiate_session

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

consentboolean required

true/false based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation. (>20 characters)

redirect_urlstring required

URL where you want to redirect DigiLocker Code

redirect_to_signupboolean
abstract_access_tokenboolean

Please send this key to avoid hitting an additional access token API. This boolean field will automatically hit the access token API.

Response

200

OR

Example response

{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Session created successfully.",
  "data": {
    "authorizationUrl": "<redirectUrl>"
  },
  "responseKey": "success_initiate_session"
}