Read Document

Read a document by ID with access details

GET /di/document-access/read

Query parameters

ParamRequiredDescription
document_idYesDocument ID
accessRemarkNoOptional access remark

Example request

curl 'https://api.qidpro.xyz/di/document-access/read?document_id=66b3174a38534634dd13040b&accessRemark=Identity%20verification' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id'

Example response

{
  "_id": "66b3174a38534634dd13040b",
  "document": {
    "account_id": "66acb5467772dba5e9cdd63c0",
    "accountType": "user",
    "sid": {
      "name": "Passport",
      "logoUrl": "d292c84101e.png",
      "_id": "63de6e37892662f53b0fcf98"
    },
    "documentNumberMasked": "E4XX4756",
    "documentNumberHash": "6d2aef74b48376b51961cd5bd9b",
    "_id": "66b31738387465634dd1303f7"
  },
  "documentOwnerAccount": {
    "name": "SREEGOPAL NARAYANA SREEKUMARAN",
    "email": "[email protected]",
    "phoneNumber": null
  },
  "grantedToAccount": {
    "_id": "66a9b3cdc784371egte15634",
    "name": "HotelX"
  },
  "documentData": {
    "scannedImages": [
      { "imageUrl": "1034424431d.jpeg" }
    ],
    "idNumber": "E4364756"
  }
}

Did this page help you?