Handle the image

After capturing an image with the face capture module, you can request our Age estimation endpoint to verify an individual's age. The base64 image obtained from the FCM module will need to be converted into a JPEG or PNG image. The image will need to be sent in the request body to the following endpoint:

Endpoint

POST https://age.yoti.com/api/v1/sessions/<sessionId>/age-estimation

Headers

Header	Description
Yoti-Sdk-Id	Your unique SDK ID obtained from the Yoti Hub
Content-Type	multipart/form-data; boundary

Request Body

The request body must be sent as multipart form-data along with the relevant boundary.

For Web FCM Integration

Secure Image Capture (SICAP) is enforced to ensure the best security. The Web FCM secure object must be included in the request body.

{

"image": "<File>",

"biometric_consent": "<File>",

"secure_token": "<fcm_secure_object>"

}

const IMAGE_PATH = path.join(__dirname, 'user-selfie.jpg');

const CONSENT_PATH = path.join(__dirname, 'biometric_consent');

const ENDPOINT = `https://age.yoti.com/api/v1/sessions/${SESSION_ID}/age-estimation`;

async function sendAgeEstimationRequest() {

try {

const imageBuffer = fs.readFileSync(IMAGE_PATH);

const imageBlob = new Blob([imageBuffer], { type: 'application/octet-stream' });

const consentBuffer = fs.readFileSync(CONSENT_PATH);

const consentBlob = new Blob([consentBlob], { type: 'text/plain' });

const formData = new FormData();

formData.append('file', imageBlob, 'image');

formData.append('file', consentBlob, 'biometric_consent');

const response = await fetch(ENDPOINT, {

method: 'POST',

$imageContents = file_get_contents(__DIR__ . '/user-selfie.jpg');

$consentContents = file_get_contents(__DIR__ . '/biometric_consent');

$boundary = '--------------------------' . microtime(true);

$body = "";

$body .= "--{$boundary}\r\n";

$body .= 'Content-Disposition: form-data; name="file"; filename="image"' . "\r\n";

$body .= "Content-Type: application/octet-stream\r\n\r\n";

$body .= $imageContents . "\r\n";

$body .= "--{$boundary}\r\n";

$body .= 'Content-Disposition: form-data; name="file"; filename="biometric_consent"' . "\r\n";

$body .= "Content-Type: text/plain\r\n\r\n";

$body .= $consentContents . "\r\n";

$body .= "--{$boundary}--\r\n";

$ch = curl_init('https://age.yoti.com/api/v1/sessions/<SESSION_ID>/age-estimation');

Parameter	Type	Content-type	File Format	Description
image	File	application/octet-stream	JPEG or PNG	Facial image of the user on which the age estimation is performed. The facial image captured from the web FCM is required to be converted from base64 into a JPEG/PNG image file first. The image should then be attached as one of the payload. Note: `encryptImage` should be disabled in web FCM to ensure a correct image conversion.
biometric_consent	File	text/plain	Plain text file without any file extension	A plain text file with a text string of either `true` or `false` value inside. `true` represents that the end user has given consent to biometric data collection for the age estimation check.
secure_token	Text	text/plain	Text string	The entire `secure` JSON object obtained from the Web FCM as a plain text string. Not required for Mobile FCM integrations.

Parameter

Type

Content-type

File Format

Description

image

File

application/octet-stream

JPEG or PNG

Facial image of the user on which the age estimation is performed.

The facial image captured from the web FCM is required to be converted from base64 into a JPEG/PNG image file first. The image should then be attached as one of the payload.

Note: encryptImage should be disabled in web FCM to ensure a correct image conversion.

biometric_consent

File

text/plain

Plain text file without any file extension

A plain text file with a text string of either true or false value inside. true represents that the end user has given consent to biometric data collection for the age estimation check.

secure_token

Text

text/plain

Text string

The entire secure JSON object obtained from the Web FCM as a plain text string.

Not required for Mobile FCM integrations.

Response

The response body is returned with the content type of application/json.

{

"status": "COMPLETE"

}

{

"status": "FAIL",

"attempts_remaining":5,

"retries_depleted": false

}

{

"context": "<Context_Message>",

"error_code": "<Error_Code>",

"attempts_remaining": 6, // optional

"retries_depleted": false // optional

}

Error Codes

Error Code	Description
`E600408`	Potential Spoofing attempt detected
`PAYLOAD_TOO_LARGE`	Payload too large.
`IMAGE_NOT_PROVIDED`	Image has not been provided.
`INVALID_B64_IMAGE`	Base64 image is incorrectly padded. Cannot create image from base64 decoded bytes
`UNSUPPORTED_IMAGE_FORMAT`	Image format not supported. Please use JPEGs (95 to 100 quality) and PNGs.
`IMAGE_SIZE_TOO_BIG`	Image size too big, the maximum size is 1.5MB.
`IMAGE_SIZE_TOO_SMALL`	Image size too small, the minimum size is 50KB.
`MIN_HEIGHT`	The image height is incorrect. Image minimum height required is 300 pixels.
`MAX_HEIGHT`	The image height is incorrect. Image maximum height required is 2000 pixels.
`MIN_WIDTH`	The image width is incorrect. Image minimum width required is 300 pixels.
`MAX_WIDTH`	The image width is incorrect. Image maximum width required is 2000 pixels.
`MIN_PIXELS`	To process the image the minimum number of pixels required is 90,000 pixels.
`MAX_PIXELS`	To process the image the maximum number of pixels required is 2,100,000 pixels.
`IMAGE_WRONG_CHANNELS`	Missing colour channel, the input image must be RGB or RGBA.
`IMAGE_GRAYSCALE_NOT_SUPPORTED`	Grayscale images not supported.
`FACE_NOT_FOUND`	Face not found.
`MULTIPLE_FACES`	Multiple faces in the image provided.
`FACE_BOX_TOO_SMALL`	The face in the image provided is too small.
`FACE_TO_IMAGE_RATIO_TOO_LOW`	Face ratio is lower than the minimum ratio.
`FACE_TO_IMAGE_RATIO_TOO_HIGH`	Face ratio is bigger than the maximum ratio.
`INSUFFICIENT_AREA_AROUND_THE_FACE`	Insufficient area around the face in the image provided.
`IMAGE_TOO_BRIGHT`	Image too bright.
`IMAGE_TOO_DARK`	Image too dark.
`INVALID_REQUEST_BODY`	Request body is invalid.
`UNSPECIFIED_ERROR`	An internal server error occurred.

Retries

It's possible to trigger a check again when a success (fail) or an error response is returned with the same session. The prerequisite is that the value of attempts_remaining is greater than zero and retries_depleted is not true.

To trigger the retry check, you have to make the API call again with the same request body as mentioned at the top.

Last updated on

Was this page helpful?