List User Documents

List documents for a user by email or phone

GET /di/document/list

Query parameters

ParamRequiredDescription
emailOne of email/phoneUser email
phoneOne of email/phonePhone number (e.g. 919606406404)
docTypeNoComma-separated document types (e.g. ADHAR or ADHAR,PANCR)

Example request

curl 'https://api.qidpro.xyz/di/document/list?email=user%40example.com&docType=ADHAR%2CPANCR' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id'

Example response

{
  "code": 303,
  "message": "Documents found",
  "data": [
    {
      "document_id": "65c86902b4c369711588d027",
      "sidKeyName": "ADHAR",
      "sidName": "Aadhaar",
      "documentCreateTime": "2024-02-11T06:28:18.348Z",
      "access_id": null,
      "accessCreateTime": null
    }
  ]
}

Response codes

CodeMessage
3001No user found with the provided email or phone
3002User does not have the required document
3003Documents found

Did this page help you?