Skip to main content
POST
The response includes a similarity score, the match verdict, and the verification status for the two submitted signatures.

Request fields

image1

The first signature image. For example, the reference signature you hold on file for the customer. Required. Each image can be at most 2 MB after decoding.

image2

The second signature image to compare against image1. For example, a newly captured signature. Required. Accepts the same formats as image1.

metadata

Optional client-provided correlation data, such as your own reference ID. The API returns this object unchanged in the response.

Supported image formats

Send application/json with each image as a Base64-encoded string. The data URI prefix is optional.

Example request

This request compares a PNG signature with a JPEG signature sent as data URIs, and attaches a reference ID and source for correlation.

Interpret the response

success: true means the API completed the comparison. Use verificationStatus and data.verdict to determine the outcome. The verdict maps to the verification status as follows: REJECTED and REVIEW_NEEDED are completed comparisons, not API failures. FAILED means the comparison could not be completed, either because no signature was found in one of the images (HTTP 400) or because the verification provider is unavailable (HTTP 502). A request missing image1 or image2 also returns HTTP 400, before a transaction is created.

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

image1
string
required

First signature image. In JSON, a Base64-encoded image with or without a data URI prefix (for example data:image/png;base64,...). In multipart/form-data, an image file. Maximum 2 MB after decoding. URLs are not accepted.

image2
string
required

Second signature image to compare against image1, in the same accepted formats. Maximum 2 MB after decoding. URLs are not accepted.

metadata
object

Optional client-provided correlation data, echoed back on the response.

Example:

Response

Comparison completed. Verified, review-needed, and rejected outcomes all use HTTP 200 and are billed.

success
boolean
required
Example:

true

message
string
required
Example:

"Signature Matching processed successfully"

data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REVIEW_NEEDED,
REJECTED
verificationStatusCode
enum<integer>
required

3 = Verified, 2 = Review Needed, 1 = Rejected.

Available options:
3,
2,
1
transactionId
string<uuid>
required
verificationType
string
required
Example:

"signature_matching"

createdAt
string
required
Example:

"2026-10-06 06:15:00+0000"

metadata
object | null