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
Bearer token
Id photo of the user
POST /api/v1/face HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: multipart/form-data
Accept: */*
Content-Length: 20
{
"idPhoto": "binary"
}
{
"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
Bearer token
Minimum match level 1 -> 5, the default value is 3
POST /api/v1/face/match HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 73
{
"sourceImage": "Ynl0ZXM=",
"targetImage": "Ynl0ZXM=",
"minimumMatchLevel": 1
}
{
"match": true,
"matchLevel": 1
}
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.
Bearer token
Base64 encoded binary of the image. Only JPG and PNG are supported. Max file size allowed of 5 MB
If true will insert the idPhoto if not found. Default to false
false
POST /api/v1/face/one-to-n/search HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 37
{
"idPhoto": "Ynl0ZXM=",
"insert": false
}
{
"oneToNVerificationId": "text",
"oneToNVerificationMatch": true
}
Note: This API requires a specific permission
The 1:N Search Insert API enables customers to directly include the selfie in the database.
Bearer token
Base64 encoded binary of the image. Only JPG and PNG are supported. Max file size allowed of 5 MB
POST /api/v1/face/one-to-n/insert HTTP/1.1
Host: id.uqudo.io
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 22
{
"idPhoto": "Ynl0ZXM="
}
{
"oneToNVerificationId": "text"
}
Note: This API requires a specific permission
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.
Bearer token
DELETE /api/v1/face/one-to-n/search/{oneToNVerificationId} HTTP/1.1
Host: id.uqudo.io
Authorization: text
Accept: */*
No content
Note: This API requires a specific permission
Last updated
Was this helpful?