DigiLocker Driving Licence API
New
Read a person's driving licence from their DigiLocker, with their consent, and get the holder, validity and vehicle classes as structured data.
Overview
A driving licence in a person's DigiLocker is issued from the transport department's records. It carries the holder's details, the licence's status and validity, and the classes of vehicle it covers. Mobility, logistics and staffing businesses need to know a driver holds a valid licence for the vehicle they will drive. A photo of a licence card does not show whether it is still valid or which classes it covers today. Once the person has opened a DigiLocker session and consented, your application sends the session reference with the licence number, and gets back the licence as structured data.
- Category
- KYC Services
- Coverage
- People whose DigiLocker holds their driving licence and who consent
- Input
- A DigiLocker session reference and the licence number
- Output
- Holder details, licence status, issue date, validity, issuing authority, RTO code and vehicle classes
- Typical users
- Mobility and delivery platforms, fleet operators, rental and leasing businesses, staffing agencies, insurers
- Coverage note
- Only people whose DigiLocker holds their driving licence 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-Z0-9]{5,20}$ |
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-driving-licence \
-H "X-Api-Key: $FINSOUR_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{
"input": {
"sessionId": "<sessionId>",
"licenceNumber": "<licenceNumber>"
},
"options": {
"consent": {
"obtained": "<obtained>",
"at": "<at>",
"purpose": "<purpose>"
}
}
}'Node.js
const response = await fetch("https://gateway.staging.finsour.io/v1/identity/digilocker-driving-licence", {
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>",
"licenceNumber": "<licenceNumber>"
},
"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-driving-licence",
headers={
"X-Api-Key": os.environ["FINSOUR_API_KEY"],
"Idempotency-Key": str(uuid.uuid4()),
},
json={
"input": {
"sessionId": "<sessionId>",
"licenceNumber": "<licenceNumber>",
},
"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
- Mobility and delivery: confirming a rider's licence before activation
- Fleet and logistics: confirming a driver's transport licence before dispatch
- Rental and leasing: reading a customer's licence before handover
- Insurance: confirming the licence of a named driver
What this service does
Validity and classes, not just a card
The licence's status, issue date, validity for transport and non-transport vehicles, and each vehicle class it covers.
The holder's details
Name, relative's name, date of birth, gender, blood group, address and photograph, where the licence holds them.
Shared through a consent link
Read it from a session the driver opened through a consent link that asks for the driving licence, after consenting on DigiLocker itself.
A clear not-found answer
When DigiLocker holds no matching licence, the response says so, and your flow can offer another route.
How a check runs
Arrange access
Tell us how licence checks fit your driver onboarding. We arrange access for your organization under the applicable service contract.
Open a DigiLocker session
The driver consents through a consent link that asks for the driving licence.
Read the licence
Your application sends the session reference and the licence number.
Check status, validity and classes
Your rules check the licence is valid for the kind of vehicle the person will drive.
Activate and schedule a review
Activate, ask for more or decline, and record the validity date so a review comes before it expires.
Questions
- What do I send to read a driving licence from DigiLocker?
- The reference of an open DigiLocker session and the licence number.
- What does the response include?
- The holder's details, the licence's status, issue date, issuing authority and validity, the RTO code and the vehicle classes it covers, where the licence holds them.
- Does it show which vehicles the person can drive?
- Yes. Each vehicle class on the licence comes back with the date it was issued, and the validity is given separately for transport and non-transport vehicles.
- Can I read a driving licence through a consent link?
- Yes. Ask for the driving licence when you create the consent link, and read it from the session once the person has consented.
- Do I need the driver's consent?
- Yes. The DigiLocker session is the driver's consent, so read the licence only for the purpose they agreed to, and limit who can see their photograph and address.
- How do I get access to the DigiLocker Driving Licence API?
- Start with Get API and tell us how licence checks fit your onboarding and what volumes you expect. We set up access under the applicable service contract.
Catalog entry last updated .