v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

SSO DigiLocker Initiate Session API

post/v2/kyc/sso/digilocker/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

consentboolean required

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

purposestring required

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

reference_idstring required

Any unique ID assigned by you for this API request.

redirect_urlstring required

pinless_signinboolean

pinless_signupboolean

usernameless_signupboolean

clear_cookiesboolean

This optional field will clear the cookies post the login of the user. Hence, when another session is started on the same device, the user will have to login again if this field is set to true.

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

responseKeystring

Example response

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