Image Text Match

Introduction

The Image Text Match API is designed to verify whether specific text values appear within images or document files such as PDFs, scanned forms, or ID cards. It provides an automated and intelligent way to confirm textual information by performing OCR-based extraction and semantic text comparison.

Endpoint

POST https://api-preproduction.signzy.app/api/v3/text-match/forgeries

POST https://api.signzy.app/api/v3/text-match/forgeries

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
Parameter	Data Type	Description	Required
images	Array of Strings	List of image or PDF URLs from which the API will extract and analyze text.	Mandatory
fields	Object	Object containing key–value pairs of the text fields that need to be verified within the image.	Mandatory
fields.name	String	The expected text value for the field name that will be checked against the extracted text from the image.	Mandatory

Code samples

curl --location 'https://api-preproduction.signzy.app/api/v3/text-match/forgeries' \
--header 'Content-Type: application/json' \
--header 'Authorization: <auth_key>' \
--data '{
    "images": [
        "https://persist.signzy.tech/api/files/645127873/download/8c017bdcbf4a40c4802a3467e339cd4ae7493f1f738e4c06940b45f2966379e5.pdf"
    ],
    "fields": {
        "name": "400063,CIN: U66010MH2008PLC183679"
    }
}'

Response body parameters

Parameter	Data Type	Description
name	Object	Contains the match result details for the name field that was validated.
name.score	Float	Similarity score between the provided field value and the closest extracted text. Ranges from 0.0 to 1.0.
name.verb	String	Indicates the match status. Possible values: "MATCH", "PARTIAL MATCH", "NO MATCH".
name.bestMatch	String	The closest text detected in the image related to the field. Returned only if best match information is enabled.

{
    "name": {
        "score": 0.19,
        "verb": "NO MATCH",
        "bestMatch": "FINANCIAL IN PLAN"
    }
}

Max Image size supported is 5 MB

For best results, please make sure the image you use fits tightly in the camera view and is horizontally aligned.

Don't pass the same URL in both the input images. it will throw a 400 error if the same URL is passed in both the first and second image.

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!