Digio | Documentation

A liveness check is used in face authentication systems to ensure that the face being presented for authentication is from a living person and not a static image, photograph, or video. It helps prevent spoofing attempts, where an unauthorized person might try to use a photograph, video, or other non-living representation of an authorized individual face to bypass security checks. Digio performs both active and passive liveness checks.

For a single image via the API, the maximum allowed size is 5 MB.

For API Base URL's, click here

Liveness Check API

post {BASE_URL}/v3/client/kyc/analyze/file/liveness

Call this API for passive liveness check from an image

Maximum file size for a single image: 5 MB
Maximum file size for bulk liveness checks: 500 KB per image, with a cumulative ZIP file size not exceeding 50 MB

REQUEST

REQUEST BODY multipart/form-data

image*

binary

Image file in JPEG/JPG/PNG or PDF format on which the liveness check is to be performed

unique_request_id

string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/v3/client/kyc/analyze/file/liveness" \
 -H 'accept: application/json'

RESPONSE

application/json

Results from the checks for the back part of the ID Card

Field

Type

Description

score

number

Confidence of image being live or real/acceptable. Higher the better

result

enum

➔ Result for the validation check (UNKNOWN is from Gray-area where manual verification can be done if you don't want customers to reattempt). Ideally consider Unknown also as Fail and ask user to reattempt.

Allowed: PASS┃FAIL┃UNKNOWN

errors

[string]

In case there are errors, list of errors found in image
⮕ [ In case there are errors, list of errors found in image ]

count

integer

Count