Before consuming the webhooks, you need to register your endpoint on the enterprise dashboard of Digio.
See the integration guide for steps on setting up the webhook on Digio Dashboard
Webhook Events for Digi Studio
| Event | Entity | Description |
|---|---|---|
| KYC_REQUEST_CREATED | KYC_REQUEST | Raised when request is created |
| KYC_REQUEST_COMPLETED | KYC_REQUEST | Raised when the user completed all actions and requested approval |
| KYC_REQUEST_REVIEW_READY | KYC_REQUEST | Digio Processing is done and the request is ready to be reviewed with all analysis results. Eg: Facematch, Central DB checks and additional offline validations |
| KYC_REQUEST_APPROVED | KYC_REQUEST | Raised when Kyc-Admin has approved request or it has been auto approved by system based on rules configured by corporate |
| KYC_REQUEST_REJECTED | KYC_REQUEST | Raised when Kyc-Admin has rejected a request. |
| KYC_REQUEST_TERMINATED | KYC_REQUEST | Raised when termination of kyc-request occurs due to failure in meeting certain conditions |
| KYC_REQUEST_EXPIRED | KYC_REQUEST | Raised when Kyc-Request has expired without completion by user in specified expiry days. |
| KYC_ACTION_COMPLETED | KYC_ACTION | Raised on completion of an Action |
| KYC_ACTION_CREATED | KYC_ACTION | Raised when a new action is created in case of re-request of a particular action by Kyc-Admin |
| KYC_ACTION_REJECTED | KYC_ACTION | Raised when a action is re-request by Kyc-Admin |
| DOCUMENTS_PULLED_SUCCESSFULLY | DIGILOCKER_REQUEST | When all Documents fetch is successful |
| DOCUMENTS_PULLED_PARTIALLY | DIGILOCKER_REQUEST | Raised when any document is fetched but the request is yet to complete. Event payload contains a list of fetched documents. |
Sample Webhook Entities with Payload
Based on Webhook event, their status and event name changes
-
KYC_REQUEST{ "entities":["KYC_REQUEST"], "payload":{ "KYC_REQUEST":{ "id":"KID", "status":"Status Value [REQUESTED/COMPLETED/APPROVED/REJECTED/EXPIRED]", "reference_id":"CRN", "transaction_id":"TXN" } }, "id": "WHN1____", "created_at": 1528370034000, "event": "{event_name}" } -
KYC_ACTION{ "entities":["KYC_ACTION","KYC_REQUEST"], "payload":{ "KYC_REQUEST":{ "id":"KID", "status":"Status Value", "reference_id":"CRN", "transaction_id":"TXN" }, "KYC_ACTION":{ "id":"KIA", "status":"Status Value", "type":"type", "acton_ref":"action_ref" } }, "id": "WHN1____", "created_at": 1528370034000, "event": "{event_name}" } -
DIGILOCKER_REQUEST{ "entities": [ "DIGILOCKER_REQUEST" ], "payload": { "DIGILOCKER_REQUEST": { "id": "RID____", "customer_name": "{name}", "customer_identifier": "{email/mobile}", "kyc_request_id": "KID2____", "reference_id": "crn", "transaction_id": "txn", "state": "COMPLETED/PARTIALLY_COMPLETED", "shared_documents": ["AADHAAR"] } }, "id": "WHN1____", "created_at": 1528370034000, "event": "{event_name}" }
Reference
For more detailed steps on setting up the webhook and reference for the same
See Webhook Guide