Skip to main content
The EntityLocker SDK provides a pre-built interface for retrieving business documents from the government’s EntityLocker system. Use the SDK when you want a faster integration with minimal code, while we handle the authentication flow and UI.

View Demo

See a live demo of the EntityLocker integration in action

​
How it works

The SDK integration follows a four-step process:
  1. Create a session on your backend using the Create Session endpoint
  2. Initialize the SDK on your client app with the session ID
  3. Handle the response when users complete or exit the document retrieval flow
  4. Fetch documents from your backend using the Fetch Document endpoint
The SDK manages the complete EntityLocker authentication flow, including OTP verification and document selection, while providing callbacks for you to handle the results.
Important: The EntityLocker SDK requires specific SDK endpoints. Use these endpoints when integrating with the SDK:

​
Choose your platform

Select your platform to view the integration guide:

Web

JavaScript SDK for web applications

Android

Native SDK for Android applications

iOS

Native SDK for iOS applications

Flutter

Plugin for Flutter applications (iOS & Android)

​
When to use the SDK

Use the EntityLocker SDK when you need:
  • Pre-built UI for the EntityLocker flow
  • Faster implementation without building custom interfaces
  • Consistent user experience across platforms
  • Automatic handling of OTP verification and consent flow
For backend-only integration with full control over the UI, use the EntityLocker API instead.