{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:digitallocker-gov-in-authpartner/push-uri-to-account-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_push_uri_to_account_id","summary":"Push URI to Account","description":"POST /account/1/pushuri","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/verify-account-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_verify_account_id","summary":"Verify Account","description":"POST /account/2/verify","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-authorization-code-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_authorization_code_id","summary":"Get Authorization Code","description":"GET /oauth2/1/authorize","tags":["open-data"],"parameters":[{"name":"client_id","in":"query","required":false,"description":"Provide the client id that was created during the application registration process on Partners Portal.","schema":{"type":"string","description":"Provide the client id that was created during the application registration process on Partners Portal."}},{"name":"response_type","in":"query","required":true,"description":"Provide the grant type requested, either token or code.","schema":{"type":"string","description":"Provide the grant type requested, either token or code."}},{"name":"redirect_uri","in":"query","required":true,"description":"The URI to redirect the user after authorization has completed.","schema":{"type":"string","description":"The URI to redirect the user after authorization has completed."}},{"name":"state","in":"query","required":true,"description":"This is your application specific data that will be passed back to your application through redirect_uri.","schema":{"type":"string","description":"This is your application specific data that will be passed back to your application through redirect_uri."}},{"name":"Code_challenge","in":"query","required":false,"description":"A unique random string called code verifier (code_verifier) is created by the client application for every authorization request. The…","schema":{"type":"string","description":"A unique random string called code verifier (code_verifier) is created by the client application for every authorization request. The…"}},{"name":"Code_challenge_method","in":"query","required":false,"description":"Specifies what method was used to encode a code_verifier to generate code_challenge parameter above. This parameter must be used with the…","schema":{"type":"string","description":"Specifies what method was used to encode a code_verifier to generate code_challenge parameter above. This parameter must be used with the…"}},{"name":"dl_flow","in":"query","required":false,"description":"If this parameter is provided its value will always be signup. This parameter indicates that the user does not have a DigiLocker account…","schema":{"type":"string","description":"If this parameter is provided its value will always be signup. This parameter indicates that the user does not have a DigiLocker account…"}},{"name":"Verified_mobile","in":"query","required":false,"description":"Verified mobile number of the user. If this parameter is passed, DigiLocker will skip the mobile OTP verification step during sign up.…","schema":{"type":"integer","description":"Verified mobile number of the user. If this parameter is passed, DigiLocker will skip the mobile OTP verification step during sign up.…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-device-code-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_device_code_id","summary":"Get Device Code","description":"POST /oauth2/1/code","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/upload-file-to-locker-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_upload_file_to_locker_id","summary":"Upload file to locker","description":"POST /oauth2/1/file/upload","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"The destination path of the file in DigiLocker including filename."},"hmac":{"type":"string","description":"This is used to verify the integrity of the file data. The client app calculates the hash message authentication code (HMAC) of the file…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-file-from-uri-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_file_from_uri_id","summary":"Get File from URI","description":"GET /oauth2/1/file/{uri}","tags":["open-data"],"parameters":[{"name":"uri","in":"query","required":true,"description":"This is the unique identifier of the document.","schema":{"type":"string","description":"This is the unique identifier of the document."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-self-uploaded-documents":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_self_uploaded_documents","summary":"Get List of Self Uploaded Documents","description":"GET /oauth2/1/files/","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issued-documents-version1-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_issued_documents_version1_id","summary":"Issued Documents","description":"GET /oauth2/1/files/issued","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-self-uploaded-documents-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_self_uploaded_documents_id","summary":"Get List of Self Uploaded Documents","description":"GET /oauth2/1/files/{id}","tags":["open-data"],"parameters":[{"name":"id","in":"query","required":true,"description":"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…","schema":{"type":"string","description":"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…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-documents-provided-by-an-issuer-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_documents_provided_by_an_issuer_id","summary":"Get List of Documents Provided by an Issuer","description":"POST /oauth2/1/pull/doctype","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issuers-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_issuers_id","summary":"Get List of Issuers","description":"POST /oauth2/1/pull/issuers","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-search-parameters-for-a-document-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_search_parameters_for_a_document_id","summary":"Get Search Parameters for a Document","description":"POST /oauth2/1/pull/parameters","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/pull-document-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_pull_document_id","summary":"Pull Document","description":"POST /oauth2/1/pull/pulldocument","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-token-revocation-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_token_revocation_id","summary":"Revoke Token.","description":"POST /oauth2/1/revoke","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/getaccesstoken-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_getaccesstoken_id","summary":"Get Access Token","description":"POST /oauth2/1/token","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/account-detail-api-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_account_detail_api_id","summary":"Get User Details","description":"GET /oauth2/1/user","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-certificate-data-in-xml-format-from-uri-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_certificate_data_in_xml_format_from_uri_id","summary":"Get Certificate Data in XML Format from URI","description":"GET /oauth2/1/xml/{uri}","tags":["open-data"],"parameters":[{"name":"uri","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-list-of-issued-documents-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_list_of_issued_documents_id","summary":"Issued Documents","description":"GET /oauth2/2/files/issued","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-e-aadhaar-data-in-xml-format-id":{"get":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_e_aadhaar_data_in_xml_format_id","summary":"Get e-Aadhaar Data in XML Format","description":"GET /oauth2/2/xml/eaadhaar","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/verify-otp-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_verify_otp_id","summary":"Verify OTP","description":"POST /signup/1/demoauthverify","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/sign-up-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_sign_up_id","summary":"SIGN UP","description":"POST /signup/2/demoauth","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:digitallocker-gov-in-authpartner/get-statistics-id":{"post":{"operationId":"open_data_digitallocker_gov_in_authpartner_get_statistics_id","summary":"Get Statistics","description":"POST /statistics/1/counts","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}