Liveness
This method submits a biometric sample for liveness check.
OK
Global unique ID of the transaction.
Bonafide score of the liveness verification. Ranges from 0 to 100 (0=attack, 100=genuine).
POST /gbds/v2/liveness HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 77
{
"data": {
"source": "ORIGINAL",
"type": "FACE",
"format": "JPEG",
"content": "text"
}
}OK
{
"tguid": "text",
"bonafideScore": 1
}This method returns the liveness check result using the TGUID.
Global unique ID of the transaction.
OK
Global unique ID of the transaction.
Bonafide score of the liveness verification. Ranges from 0 to 100 (0=attack, 100=genuine).
GET /gbds/v2/liveness/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"tguid": "text",
"biometric": {
"source": "ORIGINAL",
"type": "FACE",
"format": "JPEG",
"content": "text"
},
"bonafideScore": 1
}Retrieves the heuristic liveness configuration, including score thresholds and other parameters used in fraud detection.
OK
GET /gbds/v2/liveness/settings HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": "[Circular Reference]"
}
}
}
}
}
}Fully updates the heuristic liveness settings, changing thresholds and parameters used in proof-of-life evaluation.
OK
POST /gbds/v2/liveness/settings HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 358
{
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": "[Circular Reference]"
}
}
}
}
}
}OK
{
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": {
"settings": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"tings": "[Circular Reference]"
}
}
}
}
}
}Lists evaluated liveness transactions, allowing filtering by period, person, device, status and quality/score thresholds, returning paginated records.
OK
GET /gbds/v2/liveness/heuristic/transaction HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
[
{
"tguid": "text",
"personKey": "text",
"deviceId": "text",
"model": "text",
"soVersion": "text",
"timestamp": 1,
"bccMobileVersion": "text",
"liveness": true,
"ipAddress": "text",
"success": true,
"description": "text",
"score": 1,
"imageQuality": 1,
"originalBonafideScore": 1,
"adjustedBonafideScore": 1
}
]Retrieves the full record of a liveness transaction identified by TGUID, including scores and metadata.
OK
GET /gbds/v2/liveness/heuristic/transaction/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"tguid": "text",
"personKey": "text",
"deviceId": "text",
"model": "text",
"soVersion": "text",
"timestamp": 1,
"bccMobileVersion": "text",
"liveness": true,
"ipAddress": "text",
"success": true,
"description": "text",
"score": 1,
"imageQuality": 1,
"originalBonafideScore": 1,
"adjustedBonafideScore": 1
}Lists the PPE heuristic parameters/inputs (mask, glasses, etc.) used by the liveness check to consider or disregard facial coverings.
OK
GET /gbds/v2/liveness/heuristic/ppe HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
[
{
"personKey": "text",
"description": "text"
}
]Registers or updates the PPE information (mask, helmet, etc.) for an individual so that the liveness heuristic takes into account their permanent or temporary use.
OK
POST /gbds/v2/liveness/heuristic/ppe HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 41
{
"personKey": "text",
"description": "text"
}OK
{
"personKey": "text",
"description": "text"
}Retrieves the PPE parameters configured for the identified person, indicating which protective equipment is expected or allowed during capture.
OK
GET /gbds/v2/liveness/heuristic/ppe/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"personKey": "text",
"description": "text"
}Removes the PPE registration for the specified person, reverting to using general proof-of-life rules for that individual.
OK
DELETE /gbds/v2/liveness/heuristic/ppe/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{}Lists people with liveness heuristic information, allowing filtering by PPE flag, presence in watchlist or block, and controlling pagination.
OK
GET /gbds/v2/liveness/heuristic/person HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
[
{
"personKey": "text",
"ppe": true,
"watchlist": true,
"timeout": 1,
"tries": 1,
"devices": 1,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}
]Retrieves the liveness heuristic details of a specific person, including allowed PPE, watchlist status and block.
OK
GET /gbds/v2/liveness/heuristic/person/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"personKey": "text",
"ppe": true,
"watchlist": true,
"timeout": 1,
"tries": 1,
"devices": 1,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}Removes the specified person from the watchlist and ends any associated timeout, restoring their regular evaluation.
OK
DELETE /gbds/v2/liveness/heuristic/person/{personKey}/watchlist HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{}Queries the heuristic settings for a person-device pair, indicating whether the device is approved or blocked for that person.
OK
GET /gbds/v2/liveness/heuristic/person/{personKey}/device/{deviceId} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"personKey": "text",
"deviceId": "text",
"approved": true,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}Updates the approval status of a device for a person, marking whether the device is authorized or restricted for liveness captures.
OK
PUT /gbds/v2/liveness/heuristic/person/{personKey}/device/{deviceId}/approval/{approval} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"personKey": "text",
"deviceId": "text",
"approved": true,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}Lists the relationships between people and devices with their approval statuses, accepting filters by person key, device id and whether it is approved.
OK
GET /gbds/v2/liveness/heuristic/person/device HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
[
{
"personKey": "text",
"deviceId": "text",
"approved": true,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}
]Lists devices registered in the liveness heuristic, allowing filtering by being on watchlist or blocked, and controlling pagination.
OK
GET /gbds/v2/liveness/heuristic/device HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
[
{
"deviceId": "text",
"watchlist": true,
"timeout": 1,
"tries": 1,
"personCount": 1,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}
]Retrieves the liveness heuristic details of a specific device, such as watchlist or block flags.
OK
GET /gbds/v2/liveness/heuristic/device/{deviceId} HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{
"deviceId": "text",
"watchlist": true,
"timeout": 1,
"tries": 1,
"personCount": 1,
"success": 1,
"matchFails": 1,
"livenessFails": 1
}Removes the device from the watchlist and clears related timeouts, restoring its normal use.
OK
DELETE /gbds/v2/liveness/heuristic/device/{deviceId}/watchlist HTTP/1.1
Host: <ip>:8085
Accept: */*
OK
{}Last updated
Was this helpful?