curl --request POST \
--url https://api.privue.ai/digilocker/v1/pull-document.1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "652523835a9f9000112b1ee6",
"doc_type": "PANCR",
"org_id": "001891",
"search_parameters": {
"panName": "Name",
"panno": "ABCDE1234F"
},
"get_base64_files": true,
"get_e_aadhaar_pdf": true
}
'import requests
url = "https://api.privue.ai/digilocker/v1/pull-document.1"
payload = {
"request_id": "652523835a9f9000112b1ee6",
"doc_type": "PANCR",
"org_id": "001891",
"search_parameters": {
"panName": "Name",
"panno": "ABCDE1234F"
},
"get_base64_files": True,
"get_e_aadhaar_pdf": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_id: '652523835a9f9000112b1ee6',
doc_type: 'PANCR',
org_id: '001891',
search_parameters: {panName: 'Name', panno: 'ABCDE1234F'},
get_base64_files: true,
get_e_aadhaar_pdf: true
})
};
fetch('https://api.privue.ai/digilocker/v1/pull-document.1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"details": {
"pdf": "https://files.example.com/digilocker/5d2a7c19f1.pdf",
"xml": "https://files.example.com/digilocker/5d2a7c19f2.xml",
"file_id": "in.gov.pan-PANCR-ABCDE1234F"
}
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}DigiLocker document pull
Pull a document from its issuer into the person’s DigiLocker account, and return it.
/digilocker/v1/document-types.1 lists every document that can be pulled, the org_id of its issuer, and the search_parameters it is pulled by.
curl --request POST \
--url https://api.privue.ai/digilocker/v1/pull-document.1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"request_id": "652523835a9f9000112b1ee6",
"doc_type": "PANCR",
"org_id": "001891",
"search_parameters": {
"panName": "Name",
"panno": "ABCDE1234F"
},
"get_base64_files": true,
"get_e_aadhaar_pdf": true
}
'import requests
url = "https://api.privue.ai/digilocker/v1/pull-document.1"
payload = {
"request_id": "652523835a9f9000112b1ee6",
"doc_type": "PANCR",
"org_id": "001891",
"search_parameters": {
"panName": "Name",
"panno": "ABCDE1234F"
},
"get_base64_files": True,
"get_e_aadhaar_pdf": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
request_id: '652523835a9f9000112b1ee6',
doc_type: 'PANCR',
org_id: '001891',
search_parameters: {panName: 'Name', panno: 'ABCDE1234F'},
get_base64_files: true,
get_e_aadhaar_pdf: true
})
};
fetch('https://api.privue.ai/digilocker/v1/pull-document.1', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"details": {
"pdf": "https://files.example.com/digilocker/5d2a7c19f1.pdf",
"xml": "https://files.example.com/digilocker/5d2a7c19f2.xml",
"file_id": "in.gov.pan-PANCR-ABCDE1234F"
}
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}{
"code": 123,
"timestamp": 123,
"message": "<string>"
}Authorizations
Your API key, sent as Authorization: Bearer <your-key>.
Body
The document to pull from its issuer, found by the search parameters its type requires.
The request_id the consent link was created with
1"652523835a9f9000112b1ee6"
The document type, as /digilocker/v1/document-types.1 lists it
1"PANCR"
The issuer's organisation id, as /digilocker/v1/document-types.1 lists it
1"001891"
Whether the person consents to the document being pulled
Y, N The search parameters the document type requires, each named exactly as Document types lists it in parameter_name.
Show child attributes
Show child attributes
{ "panName": "Name", "panno": "ABCDE1234F" }
Whether files come back as base64 in place of a download link
Whether the e-Aadhaar PDF comes back
Response
Successful Response
A document pulled from its issuer into the person's DigiLocker account.
The document, and its file id
Show child attributes
Show child attributes
