Privacy Key Search

Privacy Key Search allows to compare user biometric information to multiple Privacy Keys stored within authID platform using single API call.

As one of the use cases, it allows to compare biometric information of the user being onboarded via Proof to currently enrolled Privacy Keys.

Please see swagger reference documentation for details and please read Accessing the API section for prerequisites.

🚧

Role Requirements

The API Key needs Transaction Result Auditor and Configurator roles to run Privacy Key Search.

To access the search API in general the API Key also needs the Biometric Credentials Reader role.

Search API Endpoint

The Privacy Key search endpoint requires the following inputs:

• operationId: the Operation Id of a Proof or a Selfie transaction can be provided. The live user image information captured during Proof / Selfie transaction is used to search against existing Privacy Keys.

• numberOfBitsCorrection (optional): the accuracy-related parameter allowing for a measure of discrepancy between Privacy Key and incoming facial image information. When omitted, the tenant-level default is used.

Sample API Call

curl -X 'POST' \
  'https://id.authid.ai/search/search' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer <Authid Token>' \
  -H 'Content-Type: multipart/form-data' \
  -F 'operationId=d363b7e9-804c-d13f-4834-da0e3f884924' \
  -F 'numberOfBitsCorrection=2'

API Response

The search returns the list of records, providing the data for each Account specified in accountNumbers list.

An example of response with one unique record is shown below:

{
  "matches": [
    {
      "score": 0,
      "searchSpaceEntity": {
        "operationId": "26abdd6d-7e95-b20b-322d-7f5555a92c23",
        "accountNumber": "[email protected]",
        "credentialId": "79c96289-defe-4b7e-bf2a-1ac28ad9e783"
      },
      "id": "79c96289-defe-4b7e-bf2a-1ac28ad9e783",
      "owner": {
        "name": "[email protected]"
      },
      "modifiedDate": "0001-01-01T00:00:00"
    }
  ],
  "warnings": []
}

Successful Match

matches array contains information about the Privacy Keys that matched the user. Each array element is described below:

owner.name contains the accountNumber attribute of the account.

id and searchSpaceEntity.credentialId contains the Id attribute of the specific Privacy Key that matched.

No Match Found

If the provided biometric information does not match any existing Privacy Key, the output will contain an empty array — no matches or warnings are generated.