Business document QR API reference

Business document QR

Decodes the QR code printed on a PAN card, GST, CIN or Udyam certificate, or TAN letter.

Endpoint

POST https://api.finovel.in/v1/document-qr

Charged only when the call succeeds. Errors are never charged. See how every API works for keys, retries and status codes.

Request fields

Field	Type	Required	Description
`document`	file	Yes	Document photo or PDF
`document_type`	select	Yes	Document type One of: PAN, GST, CIN, MSME, TAN.
`pdf_password`	text	No	PDF password. Only for a password-protected PDF.

Example request

curl -X POST https://api.finovel.in/v1/document-qr \
  -H "Authorization: Bearer fin_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{"document_type":"GST"}'

Response fields

Inside data:

Field	Description
`documentType`	Document type
`qr.decoded`	QR decoded
`verification.status`	Verification

Example response from the sandbox

{
  "request_id": "req_...",
  "success": true,
  "status": "success",
  "environment": "sandbox",
  "message": "OK",
  "data": {
    "qr": {
      "decoded": true
    },
    "documentType": "GST",
    "verification": {
      "status": "VERIFIED"
    }
  },
  "error": null,
  "charged_paise": 0
}

Sandbox scenarios

With a test key, this API can return:

QR decoded (default)