Age estimation v2

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

There is one step to follow to integrate the Age estimation and anti-spoofing API:

1. Create a request

Face Capture

For optimal results, Yoti provides and recommends to use the Yoti Face Capture modules, which are designed to capture optimal images meeting the requirements of the API. This is available as a Native package, and Web implementation.

Create a request

After completing the Yoti onboarding, you will need to complete authentication for the API by using the Yoti SDK to simplify the process. The Yoti SDKs are available via popular dependency management systems.

npm install -S -E yoti

You can create two types of requests using the API:

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: '/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();

This endpoint will return an anti-spoofing result alongside an Age Estimation.

This JSON string must be sent in the img parameter in withPayload.

{

    "img": "/9j/4AAQSkZJRgABAgAAAQABAAD/2wAcHNXCKigjEaYH51Me1Zy1Za0P/Z...."

}

{

   "antispoofing": {

       "prediction": "real|fake|undetermined"

   },

   "age": {

       "st_dev": float,

       "age": float

   }

}

If integrating into a non-browser client, we recommend you contact us through our support form for additional support.

Terminal integrations

Optionally, additional headers may be provided to the request to allow Yoti to track error responses coming from a particular machine. This would typically be used in a non-browser client scenario, such as an ePOS terminal where each individual machine must be registered by the business.

In order to do this, the following headers should be applied:

Example response

The response received from the API will be below:

{

    "antispoofing": {

        "prediction": "real"

    },

    "age": {

        "age": 25.1,

        "st_dev": 3.5

    }

}

Error codes