Image Quality API

Introduction

The "Image Quality API" is a specialized tool designed to evaluate and ensure the quality of image documents. This API provides a comprehensive assessment of various image quality parameters, including text clarity, brightness, sharpness, and compression quality. With a simple request, users can obtain detailed insights into each aspect of an image's quality. The API returns a set of quality scores, indicating whether each quality parameter meets the specified acceptance threshold. Additionally, it provides an overall extraction quality rating and a summary verdict of 'accept' or 'reject'. Ideal for applications where image quality is critical, this API serves as an essential tool for maintaining high standards in document processing and verification.

Key Features:

Text Quality Assessment: For images containing textual information, our API checks the quality of the text, verifying its readability.
Brightness Assessment: Our API analyzes the brightness of the image, ensuring that the image has enough lighting for the information to be consumed.
Sharpness Evaluation: Sharpness is a crucial factor in image quality. Checking the sharpness of an image involves assessing its clarity and focus. Our API assesses the image's sharpness to ensure that details are clear and well-defined.
Compression Quality Analysis: Our API evaluates the compression quality, helping you strike the right balance between file size and image quality.

Our Image quality model training suggests that the acceptanceThreshold >0.6 is perfect for an optimal classification of good images.

API details

Endpoint

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

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

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.

Request body parameters

Parameter	Data Type	Description	Required
acceptanceThreshold	Float	Threshold value between 0.05-0.95. The default value is 0.5	Optional
url	String	URL of the input image	Mandatory

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

Code samples

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

Response body parameters

Parameter	Data Type	Description
result	Object	Contains the Quality check results, including quality scores and a summary of the check performed.
result.qualityScores	Object	Contains scores for different quality parameters.
result.qualityScores.textQuality	Object	Contains the result of Text Quality
result.qualityScores.textQuality.valid	String	A string indicating if the text quality is valid. Returns Yes if the score is more than acceptanceThreshold else No.
result.qualityScores.textQuality.score	String	A number specifying the text quality score.
result.qualityScores.brightness	Object	Contains the result of brightness.
result.qualityScores.brightness.valid	String	A string indicating if the brightness quality is valid. Returns Yes if the score is more than acceptanceThreshold else No.
result.qualityScores.brightness.score	String	A number specifying the brightness score.
result.qualityScores.sharpness	Object	Contains the result of sharpness.
result.qualityScores.sharpness.valid	String	A string indicating if the sharpness quality is valid. Returns Yes if the score is more than acceptanceThreshold else No.
result.qualityScores.sharpness.score	String	A number specifying the sharpness score.
result.qualityScores.compressionQuality	Object	Contains the result of compression Quality.
result.qualityScores.compressionQuality.valid	String	A string indicating if the compression quality is valid. Returns Yes if the score is more than acceptanceThreshold else No.
result.qualityScores.compressionQuality.score	String	A number specifying the compression quality score.
result.extractionQuality	String	Indicates the overall extraction quality. This is returned by comparing the input “acceptanceThreshold” and “score” in the response. Returns “high” if the score is greater than the threshold, “medium“ if the score is equal to the threshold, “low” if the score is less than the threshold and ”verylow” if the score is very less than the threshold.
result.score	String	The overall score of the Quality check. When “all” parameters are checked, the lowest or minimum score of the quality parameters is returned.
result.summary	String	A summary of the quality check, indicating whether the analysis is accepted or not. Returns “accept” when extraction quality(defined above) is medium or high else “reject”.
result.msg	String	A message indicating the status of the quality check.

{
    "result": {
        "qualityScores": {
            "textQuality": {
                "valid": "yes",
                "score": "1.0"
            },
            "brightness": {
                "valid": "yes",
                "score": "1.0"
            },
            "sharpness": {
                "valid": "yes",
                "score": "1.0"
            },
            "compressionQuality": {
                "valid": "yes",
                "score": "0.62"
            }
        },
        "extractionQuality": "high",
        "score": "0.62",
        "summary": "accept",
        "msg": "done",
        "status": "200"
    }
}

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!