1:1 Privacy Key Matching API

Overview

The 1:1 Privacy Key Matching API compares two images to determine whether they belong to the same subject. It uses Privacy Key–based matching and Omnifaces image processing and augmentation AI to introduce required variance into the input.

Authentication & Authorization

Requests must include a valid bearer customer token
The Biometric Match Executor role is required to invoke this API

When to Use

Use this API when you:

Need to validate a single candidate match (1:1)
Want to reduce false positives from broader searches (e.g., 1:Few, 1:N)
Require Privacy Key output for downstream workflows

📘
Privacy Key generated by this output is unique to Customer's tenant. authID platform derives the target tenant from bearer access token.

Endpoint

POST /search/match

Compares a candidate image against a reference image using Privacy Key matching.

The swagger can be found at the following URL https://id.authid.ai/search/swagger/index.html

curl -X POST "https://<host>/search/match" \
  -H "Authorization: Bearer <token>" \
  -F "[email protected]" \
  -F "[email protected]"

Request

Content-Type: multipart/form-data

Parameters

Query Parameters

Field	Type	Required	Description
numberOfStableBits	integer (int32)	No	Controls stable bit count (default: 35)

Request Body (multipart/form-data)

Field	Type	Required	Description
imageA	binary	Yes	Reference image used as the baseline
imageB	binary	Yes	Candidate image to compare against the reference

Response

{
  "matched": true,
  "matchedAtEC": 2,
  "privacyKey": "string"
}

Fields

Field	Type	Description
matched	boolean	Indicates whether the images are considered a match
matchedAtEc	integer	Match strength based on error correction level
privacyKey	string	Privacy Key generated from imageA

matchedAtEC Values

Value	Meaning
-1	No match
0	Strongest match (no error correction applied)
1	Match with 1 bit correction
2	Match with 2 bits correction
3	Weakest match (3 bits corrected)