Face API

You can find the full YAML swagger specification here

You can find the full JSON swagger specification here

Every API below requires an access token that you can retrieve using the Authorisation API

Face session API

This endpoint allows you to upload an image (e.g. id photo) and the returning session id must be used in the uqudo SDK to initiate the "Face Session Flow" to perform liveness check and face matching against the provided image. The session and related image will be automatically deleted after 10 minutes.

Face session API

post

/api/v1/face

Header parameters

Authorizationstringrequired

Bearer token

Body

application/jsonmultipart/form-data

idPhotostring · byterequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://id.uqudo.io/api/v1/face' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "idPhoto": "text"
  }'

201

400

401

403

413

415

500

201

{
  "sessionId": "text"
}

Face init session result

Face match API

This endpoint allows you to upload two images (e.g. id photo, personal image) to perform a face matching. API supports JPEG and PNG images with sizes up to 5MB. It is also possible to specify a "Minimum match level" value (from 1 to 5), that must be met for the images to be considered a match.

Face match API

post

/api/v1/face/match

Header parameters

Authorizationstringrequired

Bearer token

Body

sourceImagestring · byterequired

targetImagestring · byterequired

minimumMatchLevelinteger · int32

Minimum match level 1 -> 5, the default value is 3

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://id.uqudo.io/api/v1/face/match' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "sourceImage": "text",
    "targetImage": "text",
    "minimumMatchLevel": 1
  }'

200

400

401

403

413

415

500

200

{
  "match": true,
  "matchLevel": 1
}

Face match result

---

Face Search API

The 1:N Search API enables customers to check whether an id photo exists within the customer tenant. Furthermore, it provides the option to add the id photo if it is not found.

post

/api/v1/face/one-to-n/search

Header parameters

Authorizationstringrequired

Bearer token

Body

idPhotostring · byterequired

Base64 encoded binary of the image. Only JPG and PNG are supported. Max file size allowed of 5 MB

insertboolean · default: false

If true will insert the idPhoto if not found. Default to false

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://id.uqudo.io/api/v1/face/one-to-n/search' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "idPhoto": "text",
    "insert": false
  }'

200

400

401

403

413

415

500

200

{
  "oneToNVerificationId": "text",
  "oneToNVerificationMatch": true
}

Face match result

Note: This API requires a specific permission

---

Face Search Insert API

The 1:N Search Insert API enables customers to directly include the selfie in the database.

post

/api/v1/face/one-to-n/insert

Header parameters

Authorizationstringrequired

Bearer token

Body

idPhotostring · byterequired

Base64 encoded binary of the image. Only JPG and PNG are supported. Max file size allowed of 5 MB

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://id.uqudo.io/api/v1/face/one-to-n/insert' \
  --header 'Authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "idPhoto": "text"
  }'

200

400

401

403

413

415

500

200

{
  "oneToNVerificationId": "text"
}

Face match result

Note: This API requires a specific permission

---

Face Search Delete API

The 1:N Search Delete API allows customers to delete the original selfie image from our storage. The indexed face features will persist in the database, retaining the same oneToNVerificationId. However, it may be subject to removal at a later stage, particularly if there's a necessity to re-index all selfies due to model updates.

delete

/api/v1/face/one-to-n/search/{oneToNVerificationId}

Path parameters

oneToNVerificationIdstringrequired

Header parameters

Authorizationstringrequired

Bearer token

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://id.uqudo.io/api/v1/face/one-to-n/search/{oneToNVerificationId}' \
  --header 'Authorization: text'

204

401

403

404

500

204

No body

No Content

Note: This API requires a specific permission