AI Services API 1.0.0

Authentication

Header is needed to verify the signature of the signed request.

Fields

Key	In
X-Yoti-Auth-Digest	Header

apiKey X-Yoti-Auth-Id

Header is used to access your application data.

Fields

Key	In
X-Yoti-Auth-Id	Header

Endpoints

Liveness

POST

/ai/v1/antispoofing

Perform a liveness check

Auth

Query String

nonce	string	Value auto-generated by the Web Face Capture Module
timestamp	string	Value auto-generated by the Web Face Capture Module
secure	boolean	Enable the use of Secure Image Capture (SICAP) in Web Face Capture Module https://developers.yoti.com/age-estimation/secure-image-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	High quality Base64 encoded image. Subject to image requirements https://developers.yoti.com/age-estimation/overview#image-requirements
level_of_assurance	string	(optional) The level of assurance to apply for the model score threshold. Enum: `low`,`medium`,`high` Default: medium
secure4 fields	object	(Required for Web FCM) Secure information that certifies the image was not modified. The Yoti React Face Capture provides this information that shouldn't be edited.
version	string	The version of the secure module used to capture the image.
token	string	The token used to verify the session used to capture the image.
signature	string	Data used to verify that the payload hasn't been modified after the capture.
verification	string	Encrypted data used to perform secure payload validation. This field is available from version SICAP 1.3.0.
antispoofing_model	string	(optional) Select a specific antispoofing model to execute. yoti_antispoofing_10 is the current production model. yoti_antispoofing_11 is our ibeta level 3 model. [Please contact us to discuss switching to a different model.] Enum: `yoti_antispoofing_10`,`yoti_antispoofing_11`,`yoti_antispoofing_11_thinking`,`laptop_antispoofing` Default: yoti_antispoofing_10

POST /ai/v1/antispoofing

Responses

200

A prediction was made

prediction string

400

Image validation error or malformed request

401

Unauthorized

403

Forbidden

404

Resource not found

413

Payload too large

500

Internal server error

503

Service temporarily unavailable

Response

Age Estimation

POST

/ai/v1/age-antispoofing

POST

/ai/v1/age

Perform a liveness and age estimation check on an image

Auth

Query String

nonce	string	Value auto-generated by the Web Face Capture Module
timestamp	string	Value auto-generated by the Web Face Capture Module
secure	boolean	Enable the use of Secure Image Capture (SICAP) in Web Face Capture Module https://developers.yoti.com/age-estimation/secure-image-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	High quality Base64 encoded image. Subject to image requirements https://developers.yoti.com/age-estimation/overview#image-requirements
level_of_assurance	string	(optional) The level of assurance to apply for the model score threshold. Enum: `low`,`medium`,`high` Default: medium
secure4 fields	object	(Required for Web FCM) Secure information that certifies the image was not modified. The Yoti React Face Capture provides this information that shouldn't be edited.
version	string	The version of the secure module used to capture the image.
token	string	The token used to verify the session used to capture the image.
signature	string	Data used to verify that the payload hasn't been modified after the capture.
verification	string	Encrypted data used to perform secure payload validation. This field is available from version SICAP 1.3.0.
age_estimation_model	string	(optional) Select a specific age estimation model to execute. Enum: `mar23`,`aug24`,`nist_age_003`,`nist_age_004` Default: nist_age_003
antispoofing_model	string	(optional) Select a specific antispoofing model to execute. yoti_antispoofing_10 is the current production model. yoti_antispoofing_11 is our ibeta level 3 model. [Please contact us to discuss switching to a different model.] Enum: `yoti_antispoofing_10`,`yoti_antispoofing_11`,`yoti_antispoofing_11_thinking`,`laptop_antispoofing` Default: yoti_antispoofing_10

POST /ai/v1/age-antispoofing

Responses

200

A prediction was made

object	object
antispoofing	object
prediction	string
age	object
age	number
std_dev	number

400

Image validation error or malformed request

401

Unauthorized

403

Forbidden

404

Resource not found

413

Payload too large

500

Internal server error

503

Service temporarily unavailable

Response

Perform an age estimation check on an image

Auth

Query String

nonce	string	Value auto-generated by the Web Face Capture Module
timestamp	string	Value auto-generated by the Web Face Capture Module
secure	boolean	Enable the use of Secure Image Capture (SICAP) in Web Face Capture Module https://developers.yoti.com/age-estimation/secure-image-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	High quality Base64 encoded image. Subject to image requirements https://developers.yoti.com/age-estimation/overview#image-requirements
img_validation_level	string	(optional) The level of validations to be applied against the image and bounding boxes to support different sizes of images. Enum: `low`,`high` Default: high
secure4 fields	object	(Required for Web FCM) Secure information that certifies the image was not modified. The Yoti React Face Capture provides this information that shouldn't be edited.
version	string	The version of the secure module used to capture the image.
token	string	The token used to verify the session used to capture the image.
signature	string	Data used to verify that the payload hasn't been modified after the capture.
verification	string	Encrypted data used to perform secure payload validation. This field is available from version SICAP 1.3.0.
age_estimation_model	string	(optional) Select a specific age estimation model to execute. Enum: `mar23`,`aug24`,`nist_age_003`,`nist_age_004` Default: nist_age_003

POST /ai/v1/age

Responses

200

A prediction was made

object	object
age	number
std_dev	number

400

Image validation error or malformed request

401

Unauthorized

403

Forbidden

404

Resource not found

413

Payload too large

500

Internal server error

503

Service temporarily unavailable

Response

Self-checkout

POST

/ai/v1/self-checkout/age-antispoofing

Perform a liveness and age estimation check on an image

Auth

Headers

Terminal-ID	string	Terminal ID
Session-ID	string	Session ID

Query String

nonce	string	Value auto-generated by the Web Face Capture Module
timestamp	string	Value auto-generated by the Web Face Capture Module
secure	boolean	Enable the use of Secure Image Capture (SICAP) in Web Face Capture Module https://developers.yoti.com/age-estimation/secure-image-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	High quality Base64 encoded image. Subject to image requirements https://developers.yoti.com/age-estimation/overview#image-requirements
secure4 fields	object	(Required for Web FCM) Secure information that certifies the image was not modified. The Yoti React Face Capture provides this information that shouldn't be edited.
version	string	The version of the secure module used to capture the image.
token	string	The token used to verify the session used to capture the image.
signature	string	Data used to verify that the payload hasn't been modified after the capture.
verification	string	Encrypted data used to perform secure payload validation. This field is available from version SICAP 1.3.0.
age_estimation_model	string	(optional) Select a specific age estimation model to execute. Enum: `mar23`,`aug24`,`nist_age_003`,`nist_age_004` Default: nist_age_003

POST /ai/v1/self-checkout/age-antispoofing

Responses

200

A prediction was made

object	object
antispoofing	object
prediction	string
age	object
age	number
std_dev	number

400

Image validation error or malformed request

401

Unauthorized

403

Forbidden

404

Resource not found

413

Payload too large

500

Internal server error

503

Service temporarily unavailable

Response