eKYC India Integration
eKYC India app provides India-focused identity verification and electronic signing integration for Frappe applications. It enables businesses to connect Frappe documents with Digio for Aadhaar-based eKYC and electronic signature workflows.
The integration supports two-way communication between Frappe and Digio:
| Integration Flow | Description |
|---|---|
| Frappe to Digio | Sends eKYC and eSign requests from Frappe documents to Digio. |
| Digio to Frappe | Receives webhook events from Digio and automatically updates request status in Frappe. |
This integration works with any Frappe DocType and is not limited only to loan-related documents.
Did You Know?
eKYC India can be used with Loan Applications to automate borrower verification and digital signing before loan approval.
GitHub Repository
https://github.com/frappe/ekyc_indiaDigio Integration
Digio is an Indian regulatory-compliant platform that provides Aadhaar-based identity verification and electronic signature services.
Through this integration, Frappe applications can send verification and signing requests to Digio and receive status updates automatically.
Digio Documentation
| Topic | Reference |
|---|---|
| Environments (Sandbox / Production) | https://documentation.digio.in/digienvironments/ |
| eSign Webhook Events | https://documentation.digio.in/digisign/api_integration/webhooks/#webhook-events-for-digi-sign |
| eKYC Webhooks | https://documentation.digio.in/digistudio/integration/webhooks/ |
| Webhook Reference | https://documentation.digio.in/webhooks/ |
Setup
The integration can be configured from:
Frappe Desk > Digio SettingsGeneral Settings
| Setting | Description |
|---|---|
| Request Expiry In Days | Defines the number of days before an unanswered request expires on Digio. |
| Generate Access Token | Generates a one-time token required for Digio Web SDK flows. |
| Send Sign Link | Allows Digio to send a direct signing link to the customer. |
| Notify Customers | Enables email and SMS notifications to customers during status changes. |
Environment Configuration
Digio provides two environments for integration:
| Environment | Usage |
|---|---|
| Sandbox | Used for testing and development purposes. |
| Production | Used for live customer transactions. |
Only one environment can be active at a time. Each environment requires:
- API URL.
- API Client ID.
- API Secret obtained from Digio dashboard.
Note
Sandbox credentials must be requested directly from the Digio team.
Enable eSign for Document
eSign can be enabled for any Frappe DocType by configuring document-level settings.
| Field | Description |
|---|---|
| Document Type | Selects the Frappe DocType where eSign should be enabled, such as Loan Application. |
| Send Request | Defines how the request is delivered to the customer through Email or Mobile. |
| Request Recipient By Document Field | Selects the document field containing customer email or mobile information. |
eKYC and eSign Workflow Setup
eKYC and eSign actions can be triggered using Frappe Workflow transitions.
Creating Workflow Actions
- Create a Workflow for the required DocType.
- Add a Workflow Transition.
- Select the required action:
- Send eKYC Request — Used for identity verification.
- Make eSignature Request — Used for electronic signing.
These actions are available automatically after installing the eKYC India app.
eKYC Flow
| Step | Description |
|---|---|
| 1 | Workflow action triggers an eKYC request. |
| 2 | Frappe sends the request to Digio using Aadhaar, PAN, or DigiLocker templates. |
| 3 | Customer receives verification link through email or SMS. |
| 4 | Customer completes verification on the Digio-hosted page. |
eSign Flow
| Step | Description |
|---|---|
| 1 | Workflow action triggers an eSign request. |
| 2 | Frappe generates a PDF of the document and sends it to Digio with signer details. |
| 3 | Customer receives a signing link. |
| 4 | Customer completes Aadhaar-based electronic signing. |
Webhook Configuration
Digio sends status updates back to Frappe through webhook events after customer actions.
Register the following webhook URL in the Digio dashboard:
https://<your-frappe-site>/api/method/ekyc_india.ekyc_india.doctype.digio_settings.digio_settings.handle_webhookWebhook documentation should be followed for complete setup:
https://documentation.digio.in/webhooksDigio Request Log
Every request sent to Digio and every webhook received from Digio is recorded in Digio Request Log.
Each log entry contains:
- Digio request ID.
- Request type (eSign or eKYC).
- Current request status.
- Linked Frappe document.
- Digio response details.
- Latest webhook payload.
Use Cases
The eKYC India integration can be used for:
- Borrower identity verification during loan onboarding.
- Digital signing of loan agreements.
- Automating approval workflows.
- Reducing manual document verification.
- Integrating compliance workflows with Frappe applications.
Best Practices
- Test workflows using Sandbox before enabling Production.
- Verify customer contact fields before sending requests.
- Monitor Digio Request Logs for failed or pending requests.
- Use workflow transitions to control when eKYC and eSign requests are triggered.
- Keep API credentials secure and restrict access.
