Authorized Partner API Specification

Name: Authorized Partner API Specification API
Brand: Authorized Partner API Specification
Availability: InStock

★ Only Publicly Available OpenAPI DocumentIdentity AuthIdentity Verificationoauth2, apiKey, bearer22 EndpointsREST

For Agents

Connect the Authorized Partner API Specification to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Authorized Partner API Specification, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Authorized Partner API Specification API.

Initiate OAuth 2.0 authorization codes that route citizens through DigiLocker consent before returning a partner access token

Pull issued documents such as PAN, driving license, and education certificates directly from government issuers via /oauth2/1/pull/doctype

Fetch a list of issued and self-uploaded files for the authorized user with /oauth2/1/files/issued and /oauth2/1/files

Upload partner-generated documents into a user's DigiLocker self-uploaded section with /oauth2/1/file/upload

GET STARTED

Start building with Authorized Partner API Specification API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Authorized Partner API Specification, keeping it validated and agent-ready.

The DigiLocker Authorized Partner API gives accredited applications OAuth-mediated access to documents stored in a citizen's DigiLocker account, India's national digital document wallet. Partners can pull issued documents from government issuers, verify Aadhaar-linked identity attributes, upload self-uploaded files, and manage signups and account metadata. The 22 endpoints cover the full authorization flow, file retrieval, issuer and document type discovery, and OTP-based DigiLocker account creation.

Use Cases

Patterns agents use Authorized Partner API Specification API for, with concrete tasks.

★ Digital KYC Onboarding for Indian Financial Services

Banks, NBFCs, and fintechs in India can replace paper KYC by pulling Aadhaar, PAN, and address proof documents directly from a customer's DigiLocker after OAuth consent. The Authorized Partner API returns government-signed XML or PDF documents that satisfy RBI-recognized digital KYC requirements, removing the need for branch visits or scanned uploads. Most onboarding flows complete in under two minutes once consent is granted.

Initiate DigiLocker OAuth, exchange the auth code for an access token, then call /oauth2/1/pull/doctype to fetch the user's PAN card and return the signed document URI.

Verified Educational Credential Retrieval

Recruiters, edtech platforms, and scholarship verifiers can fetch authenticated education certificates from issuers such as CBSE and state boards through the partner API. The /oauth2/1/pull/issuers and /oauth2/1/pull/doctype endpoints discover available certificates before retrieval, eliminating manual document upload and forgery checks. Verified credentials arrive as government-signed files with a stable URI for re-fetching.

List supported issuers via /oauth2/1/pull/issuers filtered for education boards, then pull the user's Class XII certificate and return its signed file URI.

Signed Document Storage for Loan and Insurance Agreements

Lenders and insurers can deposit executed contracts, policy documents, and disbursement letters into the customer's DigiLocker via /oauth2/1/file/upload. The customer retains permanent access through their DigiLocker account, and the partner can re-fetch the file by URI for compliance archives. This removes email-based document delivery and provides a tamper-evident citizen-owned vault.

Upload a signed loan agreement PDF to the user's DigiLocker self-uploaded section using /oauth2/1/file/upload and store the returned URI for later retrieval.

AI Agent Document Retrieval for Indian Services

AI agents handling Indian financial, legal, or HR workflows can access a citizen's verified documents through Jentic without managing OAuth callback URLs, custom key headers, or token exchange directly. Jentic exposes the DigiLocker pull and file operations as searchable tools, with the OAuth flow brokered through MAXsystem credential isolation. Agents focus on the workflow logic rather than DigiLocker-specific auth plumbing.

Search Jentic for 'fetch document from DigiLocker', load the pull-doctype operation schema, and execute it to retrieve the user's Aadhaar card after OAuth consent.

Key Endpoints

22 endpoints — the digilocker authorized partner api gives accredited applications oauth-mediated access to documents stored in a citizen's digilocker account, india's national digital document wallet.

METHOD

PATH

DESCRIPTION

GET

/oauth2/1/authorize

Start the OAuth 2.0 authorization code flow

POST

/oauth2/1/code

Exchange authorization code for access token

GET

/oauth2/1/files/issued

List documents issued to the authenticated user

GET

/oauth2/1/file/{uri}

Retrieve a specific document by URI

POST

/oauth2/1/pull/doctype

Pull an issued document by document type

POST

/oauth2/1/pull/issuers

List supported issuers for document pulling

POST

/oauth2/1/file/upload

Upload a file to the user's self-uploaded folder

GET

/oauth2/1/authorize

Start the OAuth 2.0 authorization code flow

POST

/oauth2/1/code

Exchange authorization code for access token

GET

/oauth2/1/files/issued

List documents issued to the authenticated user

GET

/oauth2/1/file/{uri}

Retrieve a specific document by URI

POST

/oauth2/1/pull/doctype

Pull an issued document by document type

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

DigiLocker partner client credentials, API keys, and bearer tokens are stored encrypted in the Jentic MAXsystem vault. Agents call operations through scoped session tokens; the raw partner secrets and user OAuth tokens never enter the agent's context window.

Intent-based discovery

Agents search by intent (e.g., 'fetch a PAN card from DigiLocker' or 'list issued documents') and Jentic returns the matching DigiLocker operation with its input schema, so the agent calls the right pull or file endpoint without browsing the partner documentation.

Time to first call

Direct DigiLocker partner integration: 2-4 weeks including Meity onboarding, OAuth callback handling, custom header signing, and pull-parameter discovery. Through Jentic: under 1 hour to call operations once partner credentials are loaded into the vault.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Onfido

Global identity verification with document and biometric checks

Choose Onfido for international KYC outside India where DigiLocker is not available; choose DigiLocker for Indian residents where verified government documents are required.

Alternative

Veriff

Identity verification with liveness and document scanning across 230+ countries

Use Veriff when you need biometric liveness or worldwide document coverage; use DigiLocker for Indian government-issued document retrieval directly from issuers.

Complementary

Persona

Configurable KYC and identity orchestration platform

Use Persona to orchestrate the wider KYC flow (selfie, watchlist, ongoing monitoring) and chain DigiLocker pulls into Persona inquiries for Indian users.

FAQs

Specific to using Authorized Partner API Specification API through Jentic.

What authentication does the DigiLocker Authorized Partner API use?

It uses OAuth 2.0 authorization code flow combined with two custom API key headers (Customkey1 and Customkey2) and a bearer token on subsequent calls. Partners must be onboarded by Meity to receive client credentials. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and the agent receives only scoped access to call DigiLocker operations.

Can I pull a user's Aadhaar or PAN card with the DigiLocker Authorized Partner API?

Yes, after the user grants OAuth consent, partners call /oauth2/1/pull/doctype with the relevant doctype identifier (such as PANCR for PAN or ADHAR for Aadhaar) to fetch the government-signed document. Use /oauth2/1/pull/issuers and /oauth2/1/pull/parameters first to confirm the exact identifiers and required parameters for the issuer.

What are the rate limits for the DigiLocker Authorized Partner API?

Rate limits are not published in the OpenAPI spec; they are negotiated per partner during onboarding with Meity and DigiLocker operations. Production partners typically receive higher quotas than sandbox accounts. Contact the DigiLocker partner team via the developer portal for your specific quota.

How do I retrieve an issued document with the DigiLocker API through Jentic?

Search Jentic for 'pull document from DigiLocker', load the schema for the /oauth2/1/pull/doctype operation, and execute it with the user's access token, doctype, and any required pull parameters. Jentic returns the signed document URI which can then be fetched via /oauth2/1/file/{uri}.

Can I upload partner-generated documents into a user's DigiLocker?

Yes, /oauth2/1/file/upload places a file into the user's self-uploaded folder once the user has authorized the partner via OAuth. The endpoint returns a stable URI you can store for later retrieval through /oauth2/1/file/{uri}. This is commonly used for loan agreements and policy documents.

Is the DigiLocker Authorized Partner API free?

Access is free for accredited partners but requires Meity onboarding and signing of the DigiLocker Partner Agreement. There is no per-call charge published, though partners must comply with usage policies and data protection requirements set out in the agreement.