Identify API

Real-time 1:N search capability of user biometric identifier is available as a part of authID platform duplicate check APIs.

Please see swagger reference documentation for details and please read 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 can be uploaded to the API. This image will be used to search for the user against the existing users in the authID platform.

• operationId (optional): the Operation Id from a Proof or Selfie transaction can be provided. This specifies which user image should be used for the search against the existing users in the authID platform.

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

Either operationId or image must be provided.

📘

Threshold Setting

authID recommends a threshold setting of 84, which equates 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

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 the array of records, it can be empty or it can contain one or more records.

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 authID platform. Note that user account can only have one biometric credential active at a given point in 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.

Therefore, deleted accounts identifiers are still going to be returned when performing the search. Developer can easily check the DeletedDate attribute from Get Account By UIN API response to determine if account is active or removed.

📘

Deleted Biometric Identifiers - Policies

An alternative policy or removing deleted biometrics from search space is going to be available in the future platform updates.