nonce	string
timestamp	string
secure	boolean	Run a secure request that was built with the React Face Capture: https://www.npmjs.com/package/@getyoti/react-face-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	Base64 encoded image.
metadata (optional)	object
device	string	Device used to send the request (unknown \| laptop \| mobile \| any).
level_of_assurance (optional)	string	The level of assurance to apply for the model score threshold.
secure (optional)	object	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.

POST /ai/v1/antispoofing

xxxxxxxxxx
 
curl --request POST \ --url 'https://developers.yoti.com/ai/v1/antispoofing' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data nonce={nonce} \ --data timestamp={timestamp} \ --data secure={secure} \ --data multiframe={multiframe} \ --data '{  "img": "c2FtcGxlIGltYWdlIGRhdGE=",  "metadata (optional)": {    "device": "mobile"  },  "level_of_assurance (optional)": "medium",  "secure (optional)": {    "version": "1.0.0",    "token": "<JWT token>",    "signature": "<hmac sha512>",    "verification": "<encrypted data>"  }}'
Copy

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

xxxxxxxxxx
 
{ "prediction": "real | fake"}
Copy

Perform a liveness and age estimation check on an image

Auth

Query String

nonce	string
timestamp	string
secure	boolean	Run a secure request that was built with the React Face Capture: https://www.npmjs.com/package/@getyoti/react-face-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	Base64 encoded image.
metadata (optional)	object
device	string	Device used to send the request (unknown \| laptop \| mobile \| any).
level_of_assurance (optional)	string	The level of assurance to apply for the model score threshold.
secure (optional)	object	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 (optional)	string	Which age estimation model to execute.

POST /ai/v1/age-antispoofing

xxxxxxxxxx
 
curl --request POST \ --url 'https://developers.yoti.com/ai/v1/age-antispoofing' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data nonce={nonce} \ --data timestamp={timestamp} \ --data secure={secure} \ --data multiframe={multiframe} \ --data '{  "img": "c2FtcGxlIGltYWdlIGRhdGE=",  "metadata (optional)": {    "device": "mobile"  },  "level_of_assurance (optional)": "medium",  "secure (optional)": {    "version": "1.0.0",    "token": "<JWT token>",    "signature": "<hmac sha512>",    "verification": "<encrypted data>"  },  "age_estimation_model (optional)": "mar23 | aug24"}'
Copy

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

xxxxxxxxxx
 
{ "antispoofing": {  "prediction": "real | fake" }, "age": {  "age": 25.1,  "std_dev": 3.5 }}
Copy

Perform an age estimation check on an image

Auth

Query String

nonce	string
timestamp	string
secure	boolean	Run a secure request that was built with the React Face Capture: https://www.npmjs.com/package/@getyoti/react-face-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	Base64 encoded image.
metadata (optional)	object
device	string	Device used to send the request (unknown \| laptop \| mobile \| any).
level_of_assurance (optional)	string	The level of assurance to apply for the model score threshold.
img_validation_level (optional)	string	The level of validations to be applied against the image and bounding boxes.
secure (optional)	object	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 (optional)	string	Which age estimation model to execute.

POST /ai/v1/age

xxxxxxxxxx
 
curl --request POST \ --url 'https://developers.yoti.com/ai/v1/age' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data nonce={nonce} \ --data timestamp={timestamp} \ --data secure={secure} \ --data multiframe={multiframe} \ --data '{  "img": "c2FtcGxlIGltYWdlIGRhdGE=",  "metadata (optional)": {    "device": "mobile"  },  "level_of_assurance (optional)": "medium",  "img_validation_level (optional)": "core_low",  "secure (optional)": {    "version": "1.0.0",    "token": "<JWT token>",    "signature": "<hmac sha512>",    "verification": "<encrypted data>"  },  "age_estimation_model (optional)": "mar23 | aug24"}'
Copy

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

xxxxxxxxxx
 
{ "age": 25.1, "std_dev": 3.5}
Copy

Perform a liveness and age estimation check on an image (self-checkout)

Auth

Headers

Terminal-ID	string	Integrator terminal ID
Session-ID	string	Integrator session ID

Query String

nonce	string
timestamp	string
secure	boolean	Run a secure request that was built with the React Face Capture: https://www.npmjs.com/package/@getyoti/react-face-capture
multiframe	boolean	Use the multiframe mode for a secure request. See the 'secure' argument for more information.

Request Body

object	object
img	string	Base64 encoded image.
metadata (optional)	object
device	string	Device used to send the request (unknown \| laptop \| mobile \| any).
secure (optional)	object	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 (optional)	string	Which age estimation model to execute.

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

xxxxxxxxxx
 
curl --request POST \ --url 'https://developers.yoti.com/ai/v1/self-checkout/age-antispoofing' \ --header 'Terminal-ID: {Terminal-ID}' \ --header 'Session-ID: {Session-ID}' \ --header 'X-Yoti-Auth-Digest: {X-Yoti-Auth-Digest}' \ --data nonce={nonce} \ --data timestamp={timestamp} \ --data secure={secure} \ --data multiframe={multiframe} \ --data '{  "img": "c2FtcGxlIGltYWdlIGRhdGE=",  "metadata (optional)": {    "device": "mobile"  },  "secure (optional)": {    "version": "1.0.0",    "token": "<JWT token>",    "signature": "<hmac sha512>",    "verification": "<encrypted data>"  },  "age_estimation_model (optional)": "mar23 | aug24"}'
Copy

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

xxxxxxxxxx
 
{ "antispoofing": {  "prediction": "real | fake" }, "age": {  "age": 25.1,  "std_dev": 3.5 }}
Copy