Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB
Face capture

Add face/Selfie image

Uploads selfie image for onboarding session. Response will contain data regarding liveness — if that is the photo of a real person. Number of retries is not limited.

Note: After selfie and front-id are uploaded, endpoint for comparing faces process-face on those two images can be called.

It is required that person is alone on the photo.

post/omni/add/face/third-party

Query parameters

imageType'selfie' | 'videoSelfie' | 'id' | 'nfc'

Image type. Default is selfie

captureType'AUTO' | 'MANUAL' | 'NATIVE' | 'UPLOAD'
externalCaptureIdstring
recordingIdstring

Headers

api-versionstring required

Request body

base64Imagestring

Image of user's face represented in base64.

imageUrlstring

URL of face image, required to belong to a whitelisted domain

Example request

{
  "base64Image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEB...",
  "imageUrl": "https://...",
  "faceCoordinates": {
    "leftEyeX": 1391.01,
    "leftEyeY": 1334.62,
    "rightEyeX": 918.383,
    "rightEyeY": 1359.96,
    "mouthX": 918.383,
    "leftMouthX": 918.383,
    "mouthY": 1359.96,
    "leftMouthY": 1359.96,
    "rightMouthX": 918.383,
    "rightMouthY": 1359.96,
    "noseTipX": 918.383,
    "noseTipY": 1359.96,
    "x": 448,
    "y": 778,
    "width": 1366,
    "height": 1366
  }
}

Response

OK

ageinteger

Age of th person in the photo.

isBrightboolean

We recommend capturing another photo if value is false.

confidencenumber float

Value 0 means that person on photo is alive. We recommend capturing another photo if value is 1.

hasLensesboolean

We recommend capturing another photo if value is true.

hasFaceMaskboolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

hasClosedEyesboolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

hasHeadCoverboolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

faceOccludedboolean

Checked only if configured in the session flow. We recommend capturing another photo if value is true.

sessionStatus'Alive' | 'Closed' | 'Deleted'

SessionStatus