Quick Start
We suggest you read through the step by step integration guide to understand the integration in detail. Please see below for example code snippets, examples projects and a demo.
Before you start
You will need to download the Yoti app on your phone and register your business with Yoti.
Please ensure you have a verified organisation and generate Age estimation keys.
Example code
Good to know
We strongly recommend you use the Face capture module.
First you need to install the SDK:
npm install -S -E yoti
There are three endpoints which can be used with this API:
Endpoint | Description |
---|---|
https://api.yoti.com/ai/v1/age | Use Yoti's age estimation service. |
https://api.yoti.com/ai/v1/age-antispoofing | Use Yoti's age estimation service and the Anti-spoofing check. |
https://api.yoti.com/ai/v1/antispoofing | Use Yoti's anti-spoofing check as a standalone product. |
x
const PATHS = {
AGE: '/age',
LIVENESS: '/antispoofing',
AGE_LIVENESS: '/age-antispoofing',
};
const data = {
img: 'base64img',
};
const request = new RequestBuilder()
.withBaseUrl('https://api.yoti.com/ai/v1')
.withPemFilePath('<YOTI_KEY_FILE_PATH>')
.withEndpoint(PATHS.AGE_LIVENESS) // optionally PATHS.AGE or PATHS.LIVENESS
.withPayload(new Payload(data))
.withMethod('POST')
.withHeader('X-Yoti-Auth-Id', '<YOTI_CLIENT_SDK_ID>')
.build();
Demos
We've created a suite of live demos in Yoti World to show you how the Anti-spoofing API can best serve your business when integrated:
Face capture example
Was this page helpful?