API Endpoints
Override Orchestrator Decision
You can use the
force_aadhaarand theforce_mobileoptional boolean keys in the request body to force the end-user to a specific flow and ignore the orchestrator's decision.
Multi-lingual Support
UIStreams now supports UIs in 12 Indian Languages. Just pass the
languagekey in the request contract with any one of the following supported language codes:
- Hindi:
hi- Marathi:
mr- Tamil:
ta- Gujarati:
gu- Punjabi:
pa- Malayalam:
ml- Oriya:
or- Kannada:
kn- Bengali:
bn- Telugu:
te- Assamese:
as- Urdu:
ur
The Atomic UIStream API is a single RESTful API based on HTTP requests and JSON responses. All requests work on HTTPS.
The API expects a JSON request body and responds with a JSON response body. All responses maintain a strict and consistent structure.
Endpoint: https://<DECENTRO_HOST>/v2/kyc/workflows/uistream
| Environment | Host |
|---|---|
| Staging | in.staging.decentro.tech |
| Production | in.decentro.tech |
Please note that the API Reference has been set to use only the staging host. Hence, only staging client credentials will work on API Reference pages to test out the APIs
uistream key
uistream keyUsing this key, you can automatically change the UI that is shown to the user. All the flows mentioned below are optimized and orchestrated to minimize user drop-offs.
| Value | UI Flow |
|---|---|
| AADHAAR | The user is shown two options to retrieve the Aadhaar document: the first is UIDAI and the second is the DigiLocker flow. |
| DIGILOCKER | The user is directly shown the DigiLocker flow, after which additional checks are done to make sure that the Aadhaar document is retrieved successfully. |
| CAR_INSURANCE_POLICY | The user is directly shown the DigiLocker flow, after which additional checks are done to make sure that the proper consent for pulling car insurance documents is given. Note: If the insurance policy is not linked to the user's DigiLocker account, additional UI is shown with an on-the-fly form builder which helps the user link the required document. |
| VEHICLE_REGISTRATION_CERTIFICATE | The VEHICLE_REGISTRATION_CERTIFICATE UIStream is tailored for fetching Vehicle Registration Certificate documents. Similar to the CAR_INSURANCE_POLICY task, it allows for real-time retrieval from an issuer on DigiLocker, offering a streamlined process for obtaining vehicle registration information. |
Response Keys
| Response Key | Message |
|---|---|
success_uistream_documents_fetch | All documents have been fetched successfully. |
success_uistream_partial_documents_fetch | Some documents have been fetched successfully. |
error_uistream_session_termination | The Digilocker session has been terminated. |
error_uistream_initiate_session | An error occurred while trying to start the Digilocker session. |
error_uistream_digilocker_data_fetch | An error occurred while trying to fetch Digilocker data. |
error_uistream_digilocker_timeout | An error occurred while trying to fetch file parameters |
error_uistream_digilocker_file_params | The user has been stuck in the DigiLocker page for more than 300 seconds and has been timed out. |