# Authorized Partner API Specification API

> Authorized Partner API Specification API on Apizie: 22 endpoints (Push URI to Account, Verify Account, Get Authorization Code, Get Device Code, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `open-data:digitallocker-gov-in-authpartner`
- Category: Open Data
- Status: byok
- Source: https://digitallocker.gov.in
- Page: https://zieapi.vercel.app/api/open-data/digitallocker-gov-in-authpartner
- OpenAPI: https://zieapi.vercel.app/api/open-data/digitallocker-gov-in-authpartner/openapi.json

To access files in user’s DigiLocker account from your application, you must first obtain user’s authorization.

## Endpoints

### Push URI to Account
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/push-uri-to-account-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Verify Account
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/verify-account-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get Authorization Code
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-authorization-code-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| client_id | string | no | Provide the client id that was created during the application registration process on Partners Portal. |
| response_type | string | yes | Provide the grant type requested, either token or code. |
| redirect_uri | string | yes | The URI to redirect the user after authorization has completed. |
| state | string | yes | This is your application specific data that will be passed back to your application through redirect_uri. |
| Code_challenge | string | no | A unique random string called code verifier (code_verifier) is created by the client application for every authorization request. The… |
| Code_challenge_method | string | no | Specifies what method was used to encode a code_verifier to generate code_challenge parameter above. This parameter must be used with the… |
| dl_flow | string | no | If this parameter is provided its value will always be signup. This parameter indicates that the user does not have a DigiLocker account… |
| Verified_mobile | integer | no | Verified mobile number of the user. If this parameter is passed, DigiLocker will skip the mobile OTP verification step during sign up.… |

### Get Device Code
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-device-code-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Upload file to locker
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/upload-file-to-locker-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| path | string | no | The destination path of the file in DigiLocker including filename. |
| hmac | string | no | This is used to verify the integrity of the file data. The client app calculates the hash message authentication code (HMAC) of the file… |

### Get File from URI
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-file-from-uri-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| uri | string | yes | This is the unique identifier of the document. |

### Get List of Self Uploaded Documents
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-self-uploaded-documents` (byok)

### Issued Documents
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issued-documents-version1-id` (byok)

### Get List of Self Uploaded Documents
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-self-uploaded-documents-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | yes | The id of the folder to list. To list the files of root folder of a user’s locker, do not send this parameter. This is sent as a part of… |

### Get List of Documents Provided by an Issuer
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-documents-provided-by-an-issuer-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get List of Issuers
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issuers-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get Search Parameters for a Document
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-search-parameters-for-a-document-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Pull Document
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/pull-document-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Revoke Token.
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-token-revocation-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get Access Token
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/getaccesstoken-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Get User Details
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/account-detail-api-id` (byok)

### Get Certificate Data in XML Format from URI
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-certificate-data-in-xml-format-from-uri-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| uri | string | yes |  |

### Issued Documents
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issued-documents-id` (byok)

### Get e-Aadhaar Data in XML Format
`GET https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-e-aadhaar-data-in-xml-format-id` (byok)

### Verify OTP
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/verify-otp-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### SIGN UP
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/sign-up-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get Statistics
`POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/get-statistics-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

## Example
```
curl "https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/push-uri-to-account-id" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Authorized Partner API Specification API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/open-data:digitallocker-gov-in-authpartner/push-uri-to-account-id with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Authorized Partner API Specification API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Authorized Partner API Specification itself also needs your own key from digitallocker.gov.in.

### Can AI agents use the Authorized Partner API Specification API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key open-data:digitallocker-gov-in-authpartner.

### What is the status of the Authorized Partner API Specification API?
Needs your own provider key (bring your own key)