Secure image capture

Yoti age estimation comes with SICAP (Secure Image Capture). This ensures the captured image has not been manipulated (for example, injected) before it is submitted to the Yoti backend for processing.

In order to use SICAP, you will need to:

• Install Yoti’s Face Capture Module (FCM)
• Set the secure prop to true
• Use the full FCM output for the image and secure data
• Add a query parameter when calling the Yoti API endpoints
• Ensure to pass both the image and secure body to Yoti API endpoints

Endpoints

If you wish to use the secure feature, you will need to add the query parameter ‘?secure=true’ to the applicable endpoint below:

• /v1/age?secure=true
• /v1/age-antispoofing?secure=true
• /v1/antispoofing?secure=true

Note: if secure is requested, you will also need to add a “secure” field in the request body, or you will get an 'INVALID_REQUEST_BODY' error message.

If using the YotiSDK, the query parameter should be set with the appropriate query parameter function call, not directly to the endpoint.

Request body

Face capture module will automatically return “img” and “secure” on success. Do not modify these fields manually.

{

    "img": "base64_image",

    "metadata": {

        "device": "mobile | laptop"

    },

    "secure": {

        "version": "<module_version>",

        "token": "<session_jwt>",

        "signature": "<result_signature>",

        "verification": "<verification_data>"

    }

}

Response body

This remains the same as the response without the SICAP. Example for /v1/age-antispoofing:

{

   "antispoofing": {

       "prediction": "real | fake"

   },

   "age": {

       "st_dev": float,

       "age": float

   }

}

Error codes

SICAP feature introduces new API error codes: