Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Digilocker UIStreams

post/v2/kyc/workflows/uistream

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 request

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)

callback_urlstring required

The URL where the results of the UIStream will be sent. This URL must accept a POST request.

redirect_urlstring required

The URL where the user is redirected to after completion of the session.

uistreamstring required

The ID of the UIStream.

skip_surveyboolean

Optional key to skip the first screen. This is turned on by default. If you'd like the survey screen, please explicitly send this as false

disable_multiple_tabsboolean

Optional boolean key to disable the UIStreams from opening multiple tabs

languagestring

Optional string field that expects a 2-character language code

force_aadhaarboolean

Optional boolean key to force the user to the Aadhaar login page

force_mobileboolean

Optional boolean key to force the user to the Mobile page

clear_cookiesboolean

Optional boolean key to clear DigiLocker cookies. Important in cases where users try to login multiple times via different login credentials

Response

200

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "decentroTxnId": "XXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "UIStream Session URL generated successfully",
  "data": {
    "url": "XXXXXXX"
  },
  "response_key": "success_uistream_session_generation"
}
All 182 operations