Signature Match
Introduction
Signature match API verify whether two files contain same signature of not. The input file should be a cropped signature of the signature only. The API aims at giving a probabilistic score between the two signatures provided to it.
How to call the API
Before making API requests, you need to perform a login authentication and obtain an access token. The access token should be included in the authorization header of subsequent API requests. The API endpoints and environments for different operations are provided below.
API Input Guidelines
The Signature Match API is used to determine if two document contain same signature. You can provide two images either by uploading them or by providing their URLs as input to the API.
Endpoint Details
Endpoints | Environment |
|---|---|
https://api-preproduction.signzy.app/api/v3/signature/match | Preproduction |
https://api.signzy.app/api/v3/signature/match | Production |
Request Body Parameters
PARAMETER NAME | Required/Optional | DESCRIPTION |
|---|---|---|
urls | Required | Array of URLs of length 2 - Accepts two File URLs |
threshold | Optional | This threshold parameter helps define a value, beyond which, the result would be shown as "Match". Defaults to 0.5 |
{
"urls": [
"https://preproduction-persist.signzy.tech/api/files/abcd/download/xxxx.jpeg",
"https://preproduction-persist.signzy.tech/api/files/abcd/download/xxxx.jpeg"
]
}Request Body Headers
Header Name | Required/Optional | DESCRIPTION |
|---|---|---|
Authorization | Required | access token returned as id field of login request |
Content-Type | Required | application/json |
Code Samples
curl --location 'https://api.signzy.app/api/v3/signature/match' \
--header 'Content-Type: application/json' \
--header 'Authorization: <token>' \
--data '{
"urls": [
"https://preproduction-persist.signzy.tech/api/files/abcd/download/xxxx.jpeg",
"https://preproduction-persist.signzy.tech/api/files/abcd/download/xxxx.jpeg"
]
}'Sample Response
// File is Encrypted / Closed / Not readable
{
"error":
{
"status": 415,
"msg": "Failed to get image because document closed or encrypted",
"responseCode": "fail"
}
}Response Parameter
Parameter Name | Data Type | Description |
|---|---|---|
result | String | Whether signature is matching in both the input documents |
score | Float | Score for signature match. |
Status Codes
Status Code | Description |
|---|---|
200 | OK |
400 | Bad Request |
401 | Authorization token is invalid |
422 | Unprocessable Entity |
415 | Unsupported File Type |
Maximum file size of 10 MB per URL input is allowed
The signature image must be free of any surrounding text, watermarks, or graphical overlays, else it might lead the AI Model to behave unpredictably
The signature may be submitted with a rotation or tilt as well, provided it remains fully discernible by the verification system.
Supported document types:
- Image - JPEG, JPG, PNG and TIFF/TIF.
- Single page PDF
Getting help
Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.
You can reach out to us at [email protected].