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

POSThttps://id.uqudo.io/api/v1/face

Header parameters

Body

multipart/form-dataapplication/json

idPhoto*string (binary)

Id photo of the user

Response

201400401403413415500

Face init session result

Body

application/json

sessionIdstring

Session id needed to trigger the "Face Session Flow" in the uqudo SDK. It's valid for 10 minutes

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/face', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "idPhoto": "binary"
    }),
});
const data = await response.json();

Response

201

{
  "sessionId": "text"
}

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

POSThttps://id.uqudo.io/api/v1/face/match

Header parameters

Body

application/json

sourceImage*string (byte)

targetImage*string (byte)

minimumMatchLevelinteger (int32)

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

Response

200400401403413415500

Face match result

Body

application/json

matchboolean

matchLevelinteger (int32)

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/face/match', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceImage": "Ynl0ZXM=",
      "targetImage": "Ynl0ZXM="
    }),
});
const data = await response.json();

Response

200

{
  "match": false,
  "matchLevel": 0
}

---

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.

POSThttps://id.uqudo.io/api/v1/face/one-to-n/search

Header parameters

Body

application/json

idPhoto*string (byte)

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

insertboolean

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

Response

200400401403413415500

Face match result

Body

application/json

oneToNVerificationIdstring

oneToNVerificationMatchboolean

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/face/one-to-n/search', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "idPhoto": "Ynl0ZXM="
    }),
});
const data = await response.json();

Response

200

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

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.

POSThttps://id.uqudo.io/api/v1/face/one-to-n/insert

Header parameters

Body

application/json

idPhoto*string (byte)

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

Response

200400401403413415500

Face match result

Body

application/json

oneToNVerificationIdstring

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/face/one-to-n/insert', {
    method: 'POST',
    headers: {
      "Authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "idPhoto": "Ynl0ZXM="
    }),
});
const data = await response.json();

Response

200

{
  "oneToNVerificationId": "text"
}

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.

DELETEhttps://id.uqudo.io/api/v1/face/one-to-n/search/{oneToNVerificationId}

Path parameters

oneToNVerificationId*string

Header parameters

Response

204401403404500

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://id.uqudo.io/api/v1/face/one-to-n/search/{oneToNVerificationId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "text"
    },
});
const data = await response.json();

Note: This API requires a specific permission