Initialize

Overview

The Initialize API category under Digilocker provides a unified set of endpoints to kickstart the digital identity and document verification process across multiple platforms—Mobile SDK, Web SDK, and direct Link. These APIs are designed to seamlessly onboard users into the Digilocker ecosystem, enabling secure, compliant, and frictionless access to digital document services. By abstracting the complexities of integration, the Initialize APIs empower businesses to rapidly deploy Digilocker-powered workflows, enhancing user experience and accelerating digital transformation.

Category Details

Parent Category: Digilocker
Child Categories: {child_categories}
APIs in this category: Initialize via Link, Initialize via Mobile SDK, Initialize via Web SDK

Key Capabilities

Main Functionality

The Initialize category provides the essential building blocks to start a Digilocker session, authenticate users, and configure the onboarding experience for different platforms. It supports flexible integration options, allowing businesses to choose the best fit for their application—whether mobile, web, or direct link.

Multi-Platform Initialization

Easily initialize Digilocker sessions from Android/iOS apps, web applications, or via a secure link, ensuring broad compatibility and reach.

Customizable User Experience

Configure branding, language, voice assistant, and onboarding flow parameters to deliver a tailored and branded user journey.

Secure Session Provisioning

Generate secure, short-lived tokens and session credentials that protect user data and ensure compliance with regulatory standards.

Common Use Cases

Banking & Finance

Telecom

Healthcare

Digital onboarding for new customers using mobile or web KYC.

Instant loan application verification with Digilocker document fetch.

Integration Considerations

Best Practices

Always use the appropriate initialization API for your platform (Mobile SDK, Web SDK, or Link).

Securely manage and rotate authentication tokens; never expose them in client-side code.

Customize the onboarding flow to match your brand and user expectations for higher conversion.

Important Limitations

Initialization tokens are short-lived and must be used within their validity period.

Each initialization session is single-use; do not reuse tokens across multiple users or sessions.

Ensure compliance with local data privacy and KYC regulations when integrating Digilocker.

How APIs in this Category Work Together

The APIs in the Initialize category are designed to complement each other by providing platform-specific entry points for Digilocker onboarding. Whether your application is mobile, web-based, or requires a direct link, you can use the relevant API to start a secure session and guide users through the verification process.

Key Integration Patterns:

Initialize via Mobile SDK + Initialize via Web SDK: Offer users a choice between mobile and web onboarding, improving accessibility and completion rates.

Initialize via Link + Initialize via Mobile SDK: Send a secure link to users that, when opened on mobile, launches the SDK for a native experience.

Initialize via Web SDK + Initialize via Link: Embed Digilocker onboarding in your web app and provide fallback via link for users on unsupported browsers.

By combining these APIs, you can create an end-to-end workflow where users are seamlessly onboarded through their preferred channel, with consistent branding and security controls. For example, a user may start onboarding on the web, receive a secure link via SMS, and complete verification on their mobile device using the SDK—all orchestrated through the Initialize APIs.

The Initialize category is closely related to other Digilocker API categories that handle document retrieval, verification, and user session management. Together, they form a comprehensive suite for digital identity and document workflows.

Related Categories include:

Document Fetch: Enables retrieval of verified documents after initialization is complete.

Verification: Provides APIs to validate the authenticity of documents and user identity.

Session Management: Handles session status, renewal, and termination for ongoing Digilocker workflows.

These related categories work in tandem with Initialize to deliver a complete digital onboarding and verification solution. For example, after initializing a session, you can fetch documents, verify them, and manage user sessions—all using the interconnected Digilocker API suite. This modular approach allows you to build robust, scalable, and compliant digital identity solutions tailored to your business needs.

Initialize

Initialize#

Overview#

Key Capabilities#

Common Use Cases#

Integration Considerations#

How APIs in this Category Work Together#

Related Categories#

Initialize

Overview

Key Capabilities

Common Use Cases

Integration Considerations

How APIs in this Category Work Together

Related Categories