Create Document

Create a new identity document from ScanXtract data

POST /di/document/

Query parameters

ParamTypeDescription
fullNamestringFull name of the document owner
emailstringEmail address
phonestringPhone number with country code (e.g. 919606406404)
docTypestringDocument type key (e.g. ADHAR)
accessRemarkstringAccess remark
childAccountIdstringChild account ID

Example request

Most of the request body comes from the ScanXtract result.

curl --request POST 'https://api.qidpro.xyz/di/document/?fullName=Adarsh%20Kumar&email=user%40example.com&phone=9606406404&countryCode=91&docType=ADHAR&accessRemark=Identity%20verification' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id' \
  --header 'Content-Type: application/json' \
  --data '{
    "idNumber": "203267322804",
    "expiry": null,
    "scannedImages": [
    {
      "imageUrl": "fe39d9a864.jpeg",
      "keywords": ["KOR", "भरत सरकार", "नाम/Name:", "Adarsh kumar"],
      "keyString": "KOR भरत सरकार INMENT OF INDI नाम/Name: Adarsh kumar",
      "faceLandmark": [
        { "x": 39, "y": 153 },
        { "x": 148, "y": 153 },
        { "x": 148, "y": 280 },
        { "x": 39, "y": 280 }
      ]
    }
  ],
    "fullName": "Adarsh Kumar",
    "firstName": null,
    "lastName": null,
    "nameMatchPercentage": 90,
    "dob": null,
    "yearOfBirth": "1995",
    "gender": "Male",
    "userPhotoURL": null,
    "userPhotoURI": null,
    "careOf": null,
    "address": null,
    "manualFields": null
  }'

See the API Reference for the full interactive spec.


Did this page help you?