Image Quality Lite API

Introduction

The Image Quality Lite API is a streamlined solution for assessing the readability and clarity of document images. This API is tailored to quickly evaluate the overall quality of an image, focusing on its readability and optionally checking for blur when enabled. Users can effortlessly initiate an assessment with a simple request, providing the image URL and setting their desired acceptance threshold. When blur check is activated, the API additionally scrutinizes the image for any signs of blurring, ensuring the image clarity meets specific standards. The response includes a quality rating and a numeric score, offering a concise evaluation of the image's suitability for further processing or analysis. This API is ideal for scenarios where rapid and reliable image quality assessment is essential.

API details

Endpoint

POST https://api.signzy.app/api/v3/assess-image-quality/lite

POST https://api-preproduction.signzy.app/api/v3/assess-image-quality/lite

Request body parameters

Parameter	Data Type	Description	Required
acceptanceThreshold	Float	The threshold value to be used to compare the image quality scores. The field can take a value between 0.05 and 0.95. The default value is 0.6	Optional
url	String	Image URL to be tested for image quality.	Mandatory
blurCheck	Boolean	To use the blur detection model while evaluating the quality of the image.	Optional

{
    "acceptanceThreshold": 0.6,
    "url": "https://persist.signzy.xyz/api/files/3938547/download/xxxxx.jpg",
    "blurCheck": true
}

Request Headers

Name	Value	Required	Description
Content-Type	application/json	Mandatory	The type of content that the request body contains.
Authorization	XXXXXXXXXXXXXXX	Mandatory	An authentication token to authorize the request. Reach out to the Signzy support team to get one created.

Code samples

curl --location 'https://api.signzy.app/api/v3/assess-image-quality/lite' \
--header 'Content-Type: application/json' \
--header 'Authorization: <Your access token>' \
--data '{
    "acceptanceThreshold": 0.6,
    "url": "https://persist.signzy.xyz/api/files/3938547/download/5065d677d68c4e249a5da3032c15cdda09a6b77195544db285d7a45c8e75219e.jpg",
    "blurCheck": true
}'

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the Quality check results
result.quality	String	The output image quality score is compared with the input threshold. If the output quality score is more than the threshold then the value of this field would be "good" else "bad".
result.score	Float	Image quality score between 0 and 1.

{
    "result": {
        "quality": "good",
        "score": 0.74
    }
}

The size of the document should not exceed 5 MB.

For best results, ensure the image you use fits tightly in the camera view and horizontally aligned.

Supported document types:

Image - JPEG, JPG, PNG and TIFF/TIF.
Single page PDF - In the case of multipage PDF input the API will only consider the first page for image analysis.

Contact Us for Any Assistance

If you have any questions or need assistance, please reach out to our customer support team. You can contact us via email at [email protected]. We strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively.

We value your feedback and are committed to making your experience smooth and enjoyable. Our team is dedicated to assisting you with any needs you may have. Thank you for choosing our services. We look forward to helping you!