API Endpoints
Override Orchestrator Decision
You can use the
force_aadhaar
and theforce_mobile
optional 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
language
key 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
pan_optional
Key in the DIGILOCKER UIStreamsThe
DIGILOCKER
/DIGILOCKER_AADHAAR_PAN
UIStream has an optional boolean key namedpan_optional
. This is enabled by default and allows the user to pass through as long as atleast Aadhaar is present.Hence, by default, whenever users deny PAN consent or do not have a PAN in their DigiLocker account, they are allowed to pass through the flow unless the
pan_optional
key is passed inside theadditional_data
object asfalse
.
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