SDK guide

Once you've set up a verified organisation account on the Yoti Hub, you’re ready to start integrating with the Age estimation and Anti-spoofing API.

Note: After you successfully onboard your organisation and generate the SDK ID for 'Age estimation' application, please contact us to have it whitelisted. This is necessary for use with our dedicated endpoint for this integration.

Face Capture

For optimal face capture, Yoti provides the Face Capture Module (FCM) which is designed to capture optimal images meeting the requirements of the API. This is available as a Native .Net package.

Info: We also provide React & JavaScript Face capture module for Web-based clients.

Integration

Install the SDK

To simply the integration process, Yoti provides SDKs to integrate with our API. These are available via popular dependency management systems.

npm install -S -E yoti

Create a request

Once you have added the Yoti SDK dependency to your project, you can use it to build and send your request. See the code snippets below for examples.

const PATHS = {

    AGE_LIVENESS: '/age-antispoofing',

};

​

const data = {

    img: 'base64img',

};

​

const request = new RequestBuilder()

    .withBaseUrl('https://api.yoti.com/ai/v1/self-checkout')

    .withPemFilePath('<YOTI_KEY_FILE_PATH>')

    .withEndpoint(PATHS.AGE_LIVENESS)

    .withPayload(new Payload(data))

    .withMethod('POST')

    .withHeader('X-Yoti-Auth-Id', '<YOTI_CLIENT_SDK_ID>')

    .withHeader('Terminal-Id', '<TERMINAL_ID>')

    .withHeader('Session-Id', '<SESSION_ID>') // Optional

    .build();

​

const response = request.execute();

Retrieve Results

The endpoint will return the Anti-spoofing result alongside Age estimation.

{

   "antispoofing": {

       "prediction": "real | fake"

   },

   "age": {

       "st_dev": float,

       "age": float

   }

}