For the complete documentation index, see llms.txt. This page is also available as Markdown.

Digilocker Integration

Covers pulling Sunbird RC-issued credentials into the DigiLocker wallet.

Prerequisites

Onboarding Sunbird RC in DigiLocker

1

Add a Pull URI Request

Log in to the partner account → Pull URI Request section → + Add.

2

Fill in the callback details

The VC pull URL, e.g. https://<host>/digilocker/v1/digilocker/pullUriRequest, and the HMAC key used to verify DigiLocker's request signatures. Then Next.

3

Define the user parameters

Which parameters get sent to your backend to fetch the VC — existing profile fields like Aadhaar, or custom parameters like a Certificate ID. Then Next.

4

Add the document type

Add the document type being fetched → Update.

5

Test and publish

Test via Test Service — a correct config returns the VC certificate. Then publish; only published configs are visible to users in the DigiLocker portal.

Configure Sunbird RC to serve VCs to DigiLocker

Requires a JSON mapping file per document type:

{
  "docType": {
    "schema": "Schema",
    "template": "html",
    "searchFilter": { "filters": { "osid": { "eq": "{{.certificate_id}}" } } }
  }
}
Key
Meaning

docType

The document type configured in DigiLocker

schema

The schema the VC is fetched from

template

The rendering template key

searchFilter

Search parameters (matching DigiLocker's Add New API step) used to locate the credential

Sunbird RC fetches the credential as a PDF and returns an XML response to DigiLocker.

Last updated