v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

Document Quality

post/v2/kyc/forensics/image_quality

Headers

client_idstring required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

client_secretstring required

The confidential credential provided by Decentro that is associated with the client_id

Content-Typestring

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

consentstring required

Y/N based on the consent given by the customer. Mandatory as per regulation.

consent_purposestring required

The purpose of taking this consent from your customer. Mandatory as per regulation

imagestring binary

Upload the Image upto 6MB. Supported Format: JPG, JPEG, PNG and PDF)

image_urlstring

Option to add the url to the Image, if the Image is not uploaded.

Response

200

decentroTxnIdstring

statusstring

responseCodestring

messagestring

Example response

{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "message": "Image Quality check performed successfully",
  "data": {
    "documentQualityMetrics": {
      "sharpness": 85,
      "brightness": 78,
      "compressionQuality": 88,
      "textQuality": 91,
      "glareScore": 84,
      "croppingScore": 100,
      "perspectiveScore": 90,
      "documentQuality": "high",
      "documentQualityIndex": 87,
      "summary": "ACCEPT"
    }
  }
}