Liveness

livenessCheck

post

This method submits a biometric sample for liveness check.

Body

application/json

Responses

200

OK

application/json

post

/liveness

HTTPcURLJavaScriptPython

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"
  }
}

200

OK

{
  "tguid": "text",
  "bonafideScore": 1
}

getLivenessResult

get

This method returns the liveness check result using the TGUID.

Path parameters

tguidstringRequired

Global unique ID of the transaction.

Responses

200

OK

application/json

get

/liveness/{tguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "tguid": "text",
  "biometric": {
    "source": "ORIGINAL",
    "type": "FACE",
    "format": "JPEG",
    "content": "text"
  },
  "bonafideScore": 1
}

Get liveness configuration

get

Retrieves the heuristic liveness configuration, including score thresholds and other parameters used in fraud detection.

Responses

200

OK

application/json

get

/liveness/settings

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/settings HTTP/1.1
Host: <ip>:8085
Accept: */*

200

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]"
          }
        }
      }
    }
  }
}

Set liveness configuration

post

Fully updates the heuristic liveness settings, changing thresholds and parameters used in proof-of-life evaluation.

Body

application/json

Responses

200

OK

application/json

post

/liveness/settings

HTTPcURLJavaScriptPython

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]"
          }
        }
      }
    }
  }
}

200

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]"
          }
        }
      }
    }
  }
}

Get liveness transactions

get

Lists evaluated liveness transactions, allowing filtering by period, person, device, status and quality/score thresholds, returning paginated records.

Query parameters

startstring · date-timeOptional

endstring · date-timeOptional

personKeystringOptional

deviceIdstringOptional

successbooleanOptional

minScoreinteger · int32Optional

minImageQualityinteger · int32Optional

minBonafideScoreinteger · int32Optional

minAdjustedBonafideScoreinteger · int32Optional

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

application/json

get

/liveness/heuristic/transaction

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/transaction HTTP/1.1
Host: <ip>:8085
Accept: */*

200

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
  }
]

Get specific liveness transaction

get

Retrieves the full record of a liveness transaction identified by TGUID, including scores and metadata.

Path parameters

tguidstringRequired

Responses

200

OK

application/json

get

/liveness/heuristic/transaction/{tguid}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/transaction/{tguid} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

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
}

List PPE heuristics

get

Lists the PPE heuristic parameters/inputs (mask, glasses, etc.) used by the liveness check to consider or disregard facial coverings.

Responses

200

OK

application/json

get

/liveness/heuristic/ppe

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/ppe HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

[
  {
    "personKey": "text",
    "description": "text"
  }
]

Register PPE information for an individual

post

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.

Body

application/json

personKeystringOptional

descriptionstringOptional

Responses

200

OK

application/json

post

/liveness/heuristic/ppe

HTTPcURLJavaScriptPython

POST /gbds/v2/liveness/heuristic/ppe HTTP/1.1
Host: <ip>:8085
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "personKey": "text",
  "description": "text"
}

200

OK

{
  "personKey": "text",
  "description": "text"
}

Get PPE information of a person

get

Retrieves the PPE parameters configured for the identified person, indicating which protective equipment is expected or allowed during capture.

Path parameters

personKeystringRequired

Responses

200

OK

application/json

get

/liveness/heuristic/ppe/{personKey}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/ppe/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "personKey": "text",
  "description": "text"
}

Delete PPE information of a person

delete

Removes the PPE registration for the specified person, reverting to using general proof-of-life rules for that individual.

Path parameters

personKeystringRequired

Responses

200

OK

application/json

Responseobject

delete

/liveness/heuristic/ppe/{personKey}

HTTPcURLJavaScriptPython

DELETE /gbds/v2/liveness/heuristic/ppe/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{}

List people with liveness heuristic information

get

Lists people with liveness heuristic information, allowing filtering by PPE flag, presence in watchlist or block, and controlling pagination.

Query parameters

ppebooleanOptional

watchlistbooleanOptional

blockedbooleanOptional

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

application/json

get

/liveness/heuristic/person

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/person HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

[
  {
    "personKey": "text",
    "ppe": true,
    "watchlist": true,
    "timeout": 1,
    "tries": 1,
    "devices": 1,
    "success": 1,
    "matchFails": 1,
    "livenessFails": 1
  }
]

Get liveness heuristic details of a person

get

Retrieves the liveness heuristic details of a specific person, including allowed PPE, watchlist status and block.

Path parameters

personKeystringRequired

Responses

200

OK

application/json

get

/liveness/heuristic/person/{personKey}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/person/{personKey} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "personKey": "text",
  "ppe": true,
  "watchlist": true,
  "timeout": 1,
  "tries": 1,
  "devices": 1,
  "success": 1,
  "matchFails": 1,
  "livenessFails": 1
}

Remove person from the watchlist

delete

Removes the specified person from the watchlist and ends any associated timeout, restoring their regular evaluation.

Path parameters

personKeystringRequired

Responses

200

OK

application/json

Responseobject

delete

/liveness/heuristic/person/{personKey}/watchlist

HTTPcURLJavaScriptPython

DELETE /gbds/v2/liveness/heuristic/person/{personKey}/watchlist HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{}

Get heuristic settings for person-device pair

get

Queries the heuristic settings for a person-device pair, indicating whether the device is approved or blocked for that person.

Path parameters

personKeystringRequired

deviceIdstringRequired

Responses

200

OK

application/json

get

/liveness/heuristic/person/{personKey}/device/{deviceId}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/person/{personKey}/device/{deviceId} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "personKey": "text",
  "deviceId": "text",
  "approved": true,
  "success": 1,
  "matchFails": 1,
  "livenessFails": 1
}

Set device status of a person

put

Updates the approval status of a device for a person, marking whether the device is authorized or restricted for liveness captures.

Path parameters

personKeystringRequired

deviceIdstringRequired

approvalbooleanRequired

Responses

200

OK

application/json

put

/liveness/heuristic/person/{personKey}/device/{deviceId}/approval/{approval}

HTTPcURLJavaScriptPython

PUT /gbds/v2/liveness/heuristic/person/{personKey}/device/{deviceId}/approval/{approval} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "personKey": "text",
  "deviceId": "text",
  "approved": true,
  "success": 1,
  "matchFails": 1,
  "livenessFails": 1
}

List relationships between people and devices

get

Lists the relationships between people and devices with their approval statuses, accepting filters by person key, device id and whether it is approved.

Query parameters

personKeystringOptional

deviceIdstringOptional

approvedbooleanOptional

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

application/json

get

/liveness/heuristic/person/device

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/person/device HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

[
  {
    "personKey": "text",
    "deviceId": "text",
    "approved": true,
    "success": 1,
    "matchFails": 1,
    "livenessFails": 1
  }
]

List devices registered in liveness heuristic

get

Lists devices registered in the liveness heuristic, allowing filtering by being on watchlist or blocked, and controlling pagination.

Query parameters

watchlistbooleanOptional

blockedbooleanOptional

pageIndexinteger · int32Optional

pageSizeinteger · int32Optional

Responses

200

OK

application/json

get

/liveness/heuristic/device

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/device HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

[
  {
    "deviceId": "text",
    "watchlist": true,
    "timeout": 1,
    "tries": 1,
    "personCount": 1,
    "success": 1,
    "matchFails": 1,
    "livenessFails": 1
  }
]

Get device details

get

Retrieves the liveness heuristic details of a specific device, such as watchlist or block flags.

Path parameters

deviceIdstringRequired

Responses

200

OK

application/json

get

/liveness/heuristic/device/{deviceId}

HTTPcURLJavaScriptPython

GET /gbds/v2/liveness/heuristic/device/{deviceId} HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{
  "deviceId": "text",
  "watchlist": true,
  "timeout": 1,
  "tries": 1,
  "personCount": 1,
  "success": 1,
  "matchFails": 1,
  "livenessFails": 1
}

Remove device

delete

Removes the device from the watchlist and clears related timeouts, restoring its normal use.

Path parameters

deviceIdstringRequired

Responses

200

OK

application/json

Responseobject

delete

/liveness/heuristic/device/{deviceId}/watchlist

HTTPcURLJavaScriptPython

DELETE /gbds/v2/liveness/heuristic/device/{deviceId}/watchlist HTTP/1.1
Host: <ip>:8085
Accept: */*

200

OK

{}