DigiLocker PAN API
New
Read a person's PAN record from their DigiLocker, with their consent, and get the name, date of birth and status from the record the issuer placed there.
Overview
A PAN in a person's DigiLocker is placed there by the tax department that issued it. It carries the holder's name, date of birth and the PAN's status, from the issuer itself. Lenders and fintech platforms usually ask for a photo of a PAN card and check it against a database. A PAN from DigiLocker arrives with the person's consent and from the issuer. Once the person has opened a DigiLocker session and consented, your application sends the session reference with the PAN and the name on it, and gets back the PAN record as structured data, with the number masked.
- Category
- KYC Services
- Coverage
- People whose DigiLocker holds their PAN and who consent
- Input
- A DigiLocker session reference, the PAN and the name on it
- Output
- Masked PAN, holder name, date of birth and PAN status
- Typical users
- Lenders and NBFCs, fintech platforms, brokerages and wealth platforms, payroll teams
- Coverage note
- Only people whose DigiLocker holds their PAN and who open a session and consent
The overview and the sections after the reference are the FinSour API catalog’s own record for this service, rendered unaltered.
Endpoint URL and method
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Authentication
Send your API key in this header on every call, from your own server: a key sent from a browser is refused. A key starting fs_test_ calls the sandbox and one starting fs_live_ calls production, at the same address. Create keys in the FinSour console.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Request parameters
Headers
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
Idempotency-Key | string | Required | A key you generate for each attempt. Sending the same key again returns the first answer instead of running the check twice; the same key with a different body is refused. | 8 to 255 characters. Matches ^[A-Za-z0-9._:-]+$ |
Body
| Name | Type | Required | Description | Constraints |
|---|---|---|---|---|
input | object | Required | The details to check. | — |
input. | string | Required | — | Matches ^dls_[0-9A-HJKMNP-TV-Z]{26}$ |
input. | string | Required | — | Matches ^[A-Z]{5}[0-9]{4}[A-Z]$. Exactly 10 characters |
input. | string | Required | — | Matches ^[A-Za-z ]+$. 1 to 120 characters |
options | object | Required | Settings for this call. This API requires consent. | — |
options. | string | Optional | Your own reference for this call. It comes back unchanged as meta.reference. | 1 to 128 characters |
options. | object | Required | The person's consent to this check. | — |
options. | boolean | Required | Send true once the person has agreed to the check. | Always true |
options. | string (date-time) | Required | When the person gave consent. | — |
options. | string | Required | What the check is for, for example kyc. | 1 to 64 characters |
Request samples
cURL
curl -X POST https://gateway.staging.finsour.io/v1/identity/digilocker-pan \
-H "X-Api-Key: $FINSOUR_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"input": {
"sessionId": "<sessionId>",
"panNumber": "<panNumber>",
"nameOnPan": "<nameOnPan>"
},
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>"
}
}
}'Node.js
const response = await fetch("https://gateway.staging.finsour.io/v1/identity/digilocker-pan", {
method: "POST",
headers: {
"X-Api-Key": process.env.FINSOUR_API_KEY,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"input": {
"sessionId": "<sessionId>",
"panNumber": "<panNumber>",
"nameOnPan": "<nameOnPan>"
},
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>"
}
}
}),
});
console.log(response.status, await response.json());Python
import os
import uuid
import requests
response = requests.post(
"https://gateway.staging.finsour.io/v1/identity/digilocker-pan",
headers={
"X-Api-Key": os.environ["FINSOUR_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
},
json={
"input": {
"sessionId": "<sessionId>",
"panNumber": "<panNumber>",
"nameOnPan": "<nameOnPan>",
},
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>",
},
},
},
timeout=30,
)
print(response.status_code, response.json())Generated from the fields above. Replace each value in angle brackets with your own; the key is read from FINSOUR_API_KEY.
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Response schema
| Name | Type | Present | Description | Constraints |
|---|---|---|---|---|
data | object | Always | The result of the check. | — |
data. | boolean | Always | — | — |
data. | object or any or null | Always | — | — |
data. | object | Always | — | — |
data. | string | Always | When the answer was fetched: RFC 3339 UTC with a Z, never an epoch or an IST offset. | Matches ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,9})?Z$ |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Error codes
| Code | Status | Meaning | Retrying |
|---|---|---|---|
API_VERSION_UNSUPPORTED | 400 | That API version is no longer supported. | Do not retry automatically |
IDEMPOTENCY_KEY_INVALID | 400 | That Idempotency-Key does not meet the required format. | Do not retry automatically |
IDEMPOTENCY_KEY_REQUIRED | 400 | An Idempotency-Key header is required for this request. | Do not retry automatically |
REQUEST_MALFORMED | 400 | The request could not be parsed. | Do not retry automatically |
AUTH_KEY_EXPIRED | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_INVALID | 401 | The API key is not valid. | Do not retry automatically |
AUTH_KEY_MISSING | 401 | No API key was presented. | Do not retry automatically |
AUTH_KEY_REVOKED | 401 | The API key is not valid. | Do not retry automatically |
INSUFFICIENT_BALANCE | 402 | The available balance is not enough for this request. | Do not retry automatically |
AUTH_IP_NOT_ALLOWED | 403 | This API key may not be used from this address. | Do not retry automatically |
ENTITLEMENT_MISSING | 403 | This organization is not entitled to that product in this environment. | Do not retry automatically |
ORGANIZATION_SUSPENDED | 403 | This organization is not active. | Do not retry automatically |
PRODUCT_NOT_AVAILABLE | 403 | That product is not available. | Do not retry automatically |
PRODUCT_RETIRED | 403 | That product has been withdrawn. | Do not retry automatically |
SCOPE_INSUFFICIENT | 403 | This API key does not carry the scope this product requires. | Do not retry automatically |
DIGILOCKER_SESSION_NOT_FOUND | 404 | No open DigiLocker session has that id. | Do not retry automatically |
PRODUCT_NOT_FOUND | 404 | No such product. | Do not retry automatically |
DIGILOCKER_CONSENT_PENDING | 409 | The person has not yet given consent on DigiLocker. | Safe to retry |
DIGILOCKER_STEP_INVALID | 409 | The DigiLocker session is not at this step. | Do not retry automatically |
IDEMPOTENCY_KEY_REUSED | 409 | That idempotency key was already used for a different request. | Do not retry automatically |
PRICE_UNAVAILABLE | 409 | No active price covers this product right now. | Safe to retry |
REQUEST_IN_PROGRESS | 409 | An earlier attempt with this key is still running. | Safe to retry |
SETTLEMENT_PENDING | 409 | This request is awaiting reconciliation by an operator. | Do not retry automatically |
API_VERSION_SUNSET | 410 | That API version passed its announced sunset date. | Do not retry automatically |
REQUEST_TOO_LARGE | 413 | The request body is too large. | Do not retry automatically |
UNSUPPORTED_MEDIA_TYPE | 415 | That content type is not accepted on this route. | Do not retry automatically |
CONSENT_REQUIRED | 422 | This product requires an explicit consent flag. | Do not retry automatically |
DIGILOCKER_CONSENT_DENIED | 422 | The person did not give consent on DigiLocker. | Do not retry automatically |
DIGILOCKER_DETAILS_MISMATCH | 422 | The details do not match the person's DigiLocker record. | Do not retry automatically |
DIGILOCKER_OTP_INVALID | 422 | The code was not accepted. Ask the person for the code they received and try again. | Do not retry automatically |
DIGILOCKER_SESSION_EXPIRED | 422 | The DigiLocker session has expired. Start a new session. | Do not retry automatically |
SANDBOX_FIXTURE_MISSING | 422 | No sandbox fixture exists for this input. Use a different test value. | Do not retry automatically |
UPSTREAM_REJECTED | 422 | The upstream source rejected the input. | Do not retry automatically |
VALIDATION_FAILED | 422 | The request payload is invalid. | Do not retry automatically |
CONCURRENCY_LIMIT | 429 | Too many simultaneous requests. | Safe to retry |
QUOTA_EXCEEDED | 429 | The allowance for this window is spent. | Do not retry automatically |
RATE_LIMITED | 429 | Too many requests. | Safe to retry |
INTERNAL_ERROR | 500 | An unexpected error occurred. | Safe to retry |
OUTCOME_UNCERTAIN | 502 | The outcome of this request is not yet known. Retry with the same Idempotency-Key. | Do not retry automatically |
UPSTREAM_UNAVAILABLE | 502 | The upstream source is unavailable. Retry shortly. | Safe to retry |
MAINTENANCE_MODE | 503 | The service is in a maintenance window. | Safe to retry |
NO_PROVIDER_AVAILABLE | 503 | No provider can serve this product right now. | Safe to retry |
SERVICE_OVERLOADED | 503 | The service is shedding load. Retry shortly. | Safe to retry |
UPSTREAM_TIMEOUT | 504 | The upstream source did not respond in time. | Safe to retry |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Rate limits
| Scope | Limit | Window | At the limit |
|---|---|---|---|
| Your API key, within your organisation's limit | The figure in X-RateLimit-Limit | Per minute | 429 RATE_LIMITED, with Retry-After in seconds. Every answer past authentication carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. |
Supplied by FinSour platform API contract (finsour development at 80e8b83bf) on . OpenAPI document at commit 436311c32, API version 2026-11-01. The beta is served from the staging gateway.
Use cases
- Lending: taking a borrower's PAN record from DigiLocker in a remote application
- Broking and wealth: completing account opening with an issued PAN
- Payroll: confirming a new employee's PAN with their consent
- Fintech onboarding: replacing PAN card uploads with DigiLocker
What this service does
The PAN from its issuer
The holder's name, date of birth and the PAN's status, from the record the issuing tax department placed in the person's DigiLocker.
The number arrives masked
The PAN comes back with only its first three and last two characters shown.
Consent link or code
Read it from a session opened by a consent link that asks for PAN, or by Aadhaar details and a one-time code.
A clear not-found answer
When DigiLocker holds no matching PAN record, the response says so, and your flow can offer another route.
How a check runs
Arrange access
Tell us how DigiLocker PAN fits your onboarding. We arrange access for your organization under the applicable service contract.
Open a DigiLocker session
The person consents through a consent link that asks for PAN, or with their Aadhaar details and a code.
Read the PAN
Your application sends the session reference, the PAN and the name on it.
Use the record
Fill the PAN, name and date of birth on the application and act on the status.
Store with the application
Keep the record with the decision it supported, and limit who can see it.
Questions
- What do I send to read a PAN from DigiLocker?
- The reference of an open DigiLocker session, the PAN and the name printed on it.
- What does the response include?
- The masked PAN, the holder's name, their date of birth and the PAN's status, where the record holds them.
- Can I read PAN through a consent link?
- Yes. Ask for PAN when you create the consent link, and read it from the session once the person has consented.
- How is this different from PAN Verification?
- PAN Verification checks a PAN you send against the record. DigiLocker PAN reads the PAN the person shares from their own DigiLocker, with their consent, from the issuer.
- Do I need the person's consent?
- Yes. The DigiLocker session is the person's consent, and the read names their PAN, so use the result only for the purpose they agreed to.
- How do I get access to the DigiLocker PAN API?
- Start with Get API and tell us how DigiLocker fits your onboarding and what volumes you expect. We set up access under the applicable service contract.
Catalog entry last updated .