# Face API

You can find the full YAML swagger specification [here](https://id.uqudo.io/doc/v3/id-api.yaml/face)

You can find the full JSON swagger specification [here](https://id.uqudo.io/doc/v3/id-api/face)

Every API below requires an access token that you can retrieve using the [Authorisation](https://docs.uqudo.com/docs/kyc/uqudo-api/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.

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/face>" path="/api/v1/face" method="post" %}
<https://id.uqudo.io/doc/v3/id-api/face>
{% endopenapi %}

### 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.

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/face>" path="/api/v1/face/match" method="post" %}
<https://id.uqudo.io/doc/v3/id-api/face>
{% endopenapi %}

***

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/face>" path="/api/v1/face/one-to-n/search" method="post" %}
<https://id.uqudo.io/doc/v3/id-api/face>
{% endopenapi %}

**Note:** This API requires a specific permission

***

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/face>" path="/api/v1/face/one-to-n/insert" method="post" %}
<https://id.uqudo.io/doc/v3/id-api/face>
{% endopenapi %}

**Note:** This API requires a specific permission

***

{% openapi src="<https://id.uqudo.io/doc/v3/id-api/face>" path="/api/v1/face/one-to-n/search/{oneToNVerificationId}" method="delete" %}
<https://id.uqudo.io/doc/v3/id-api/face>
{% endopenapi %}

**Note:** This API requires a specific permission