Identify API

The real-time 1:N search capability for user biometric identifiers is available as part of the authID platform's duplicate check APIs.

Refer to the swagger reference documentation for detailed information, and review the "Accessing the API" section for prerequisites.

Identify API Endpoint

The Biometric Search Identify endpoint requires the following inputs:

• image (optional): A JPEG image of the user that can be uploaded to the API. This image is used to search for matches against existing users in the authID platform.

• operationId (optional): The Operation ID from a Proof or Selfie transaction. This specifies the user image to be used in the search against existing users in the authID platform.

• threshold (mandatory): defines the match threshold, which determines the required level of accuracy for a positive match result.

Either operationId or image must be provided.

📘

Threshold Setting

authID recommends a threshold setting of 84, corresponding to a False Accept Rate (FAR) of 1:10M

Sample API Call using operationId

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

Sample API Call with jpeg image

curl -X 'POST' \
'https://id.authid.ai/search/identify' \
-H 'accept: text/plain' \
-H 'Authorization: Bearer <Authid Token>' \
-H 'Content-Type: multipart/form-data' \
-F '[email protected];type=image/jpeg' \
-F 'threshold=84'

API Response

The search returns an array of records, which may be empty or contain one or more entries.

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

[
  {
    "id": "2d9334f7-d8ff-4599-baa8-ed27feb9af31",
    "owner": {
      "id": "d95bfab2-5a62-4ed9-9453-1e1b1a6a1ce4",
      "name": "[email protected]"
    },
    "modifiedDate": "2024-09-103T03:30:10.239Z",
    "score": 110
  }
]

id : contains the unique identifier of the biometric credential within the authID platform. Note that a user account can have only one active biometric credential at any given time.

owner.id contains the unique identifier (UIN) of the user account the biometric credential belongs to

owner.name contains the Display Name attribute of the account.

All available account attributes, including AccountNumber can be retrieved using Get Account By UIN API.

Search API vs Deleted Biometrics

Account and/or Account Biometrics can be deleted using corresponding DELETE Restful API endpoints.

Duplicates check authID platform service currently implements a policy targeting prevention of re-onboarding of banned / deleted users.

Deleted account identifiers will still be returned during searches. Developers can check the DeletedDate attribute in the Get Account By UIN API response to determine whether an account is active or removed.

📘

Deleted Biometric Identifiers - Policies

An alternative policy for removing deleted biometrics from the search space is available. Please contact authID Support to request that this policy be enabled.