Atomic UIStreams

Recipes
🍢
Create a simple Flask (Python) app that generates UIStream session URLs
Open Recipe
πŸš‚
Create a simple Express.js (Node.js) app that generates UIStream session URLs
Open Recipe
β˜•
Create a simple Spring Boot (Java) app that generates UIStream session URLs
Open Recipe
πŸ›€οΈ
Create a simple Ruby on Rails (Ruby) app that generates UIStream session URLs
Open Recipe
🎯
Create a simple ASP.NET Core (C#) app that generates UIStream session URLs
Open Recipe
🎡
Create a simple Symfony (PHP) app that generates UIStream session URLs
Open Recipe
🏎️
Create a simple FastAPI (Python) app that generates UIStream session URLs
Open Recipe
🐍
Create a simple Django (Python) app that generates UIStream session URLs
Open Recipe
🎨
Create a simple Laravel (PHP) app that generates UIStream session URLs
Open Recipe
🍸
Create a simple Gin (Go) app that generates UIStream session URLs
Open Recipe

API Endpoints

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

EnvironmentHost
Stagingin.staging.decentro.tech
Productionin.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

Using 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.

ValueUI Flow
AADHAARThe user is shown two options to retrieve the Aadhaar document: the first is UIDAI and the second is the DigiLocker flow.
DIGILOCKERThe 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_POLICYThe 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_CERTIFICATEThe 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 KeyMessage
success_uistream_documents_fetchAll documents have been fetched successfully.
success_uistream_partial_documents_fetchSome documents have been fetched successfully.
error_uistream_session_terminationThe Digilocker session has been terminated.
error_uistream_initiate_sessionAn error occurred while trying to start the Digilocker session.
error_uistream_digilocker_data_fetchAn error occurred while trying to fetch Digilocker data.
error_uistream_digilocker_timeoutAn error occurred while trying to fetch file parameters
error_uistream_digilocker_file_paramsThe user has been stuck in the DigiLocker page for more than 300 seconds and has been timed out.
Language
Click Try It! to start a request and see the response here!