{"@context": "https://schema.org", "@type": "WebAPI", "name": "Authorized Partner API Specification API", "description": "To access files in user’s DigiLocker account from your application, you must first obtain user’s authorization.", "provider": {"@type": "Organization", "name": "digitallocker.gov.in"}, "documentation": "https://apisetu.gov.in/api_specification_v8/authpartner.yaml"}
To access files in user’s DigiLocker account from your application, you must first obtain user’s authorization.
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://betaapi.digitallocker.gov.in/public
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
To access files in user’s DigiLocker account from your application, you must first obtain user’s authorization.
| method | path | what the vendor says it does |
|---|---|---|
POST | /account/1/pushuri | Push URI to Account The API can use to push or delete a single URI into Digital Locker using DigiLocker Id acq |
POST | /account/2/verify | Verify Account This API can be used to verify whether a mobile number or Aadhaar number is already registered |
GET | /oauth2/1/authorize | Get Authorization Code Call to this API starts authorization flow using OAuth 2.0 protocol. This isn't an API |
POST | /oauth2/1/code | Get Device Code The client device calls the DigiLocker API to get the device code by providing the client_id i |
POST | /oauth2/1/file/upload | Upload file to locker This API can be used to save/upload a file to uploaded documents in DigiLocker. The allo |
GET | /oauth2/1/file/{uri} | Get File from URI Returns a file from URI. This API can be used to fetch both issued document and uploaded doc |
GET | /oauth2/1/files/ | Get List of Self Uploaded Documents Returns the list of meta-data about documents or folders in user’s DigiLoc |
GET | /oauth2/1/files/issued | Issued Documents Returns the list of meta-data about issued documents in user’s DigiLocker. File APIs |
GET | /oauth2/1/files/{id} | Get List of Self Uploaded Documents Returns the list of meta-data about documents or folders in user’s DigiLoc |
POST | /oauth2/1/pull/doctype | Get List of Documents Provided by an Issuer Returns a list of documents/certificates issued by an issuer organ |
POST | /oauth2/1/pull/issuers | Get List of Issuers Returns the list of issuers registered with DigiLocker. DigiLocker Meta APIs |
POST | /oauth2/1/pull/parameters | Get Search Parameters for a Document Returns a list of parameters required to search a document/certificate of |
POST | /oauth2/1/pull/pulldocument | Pull Document This API allows a client application to search a document/certificate from issuer’s repository u |
POST | /oauth2/1/revoke | Revoke Token. Client applications can revoke a previously obtained refresh or access token when it is no longe |
POST | /oauth2/1/token | Get Access Token This endpoint only applies to apps using the authorization code flow. An app calls this endpo |
GET | /oauth2/1/user | Get User Details Client applications can call this API to get the DigiLocker Id, name, date of birth and gende |
GET | /oauth2/1/xml/{uri} | Get Certificate Data in XML Format from URI Returns the certificate data in machine readable XML format for a |
GET | /oauth2/2/files/issued | Issued Documents Returns the list of meta-data about issued documents in user’s DigiLocker. File APIs |
GET | /oauth2/2/xml/eaadhaar | Get e-Aadhaar Data in XML Format Returns e-Aadhaar data in XML format for the account. File APIs |
POST | /signup/1/demoauthverify | Verify OTP This API is used to verify the OTP sent by DigiLocker during the sign up API call above. DigiLocker |
POST | /signup/2/demoauth | SIGN UP This API is used to validate Aadhaar details and verify the mobile number by generating an OTP. This A |
POST | /statistics/1/counts | Get Statistics Returns DigiLocker statistics such as the count of users, authentic documents, issuers and requ |
specification origin: https://apisetu.gov.in/api_specification_v8/authpartner.yaml
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.