API docs by Redocly

GBDS API (4.7.0)

Download OpenAPI specification:Download

Check the Integration Guide for further information on how to properly use this API

version

getVersion

This method return the GBDS version.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

exceptions

getException

This method returns an exception for a given person/transaction.

path Parameters
tguid
required
string

Global unique ID of the transaction.

pguid
required
string

Global unique ID of the person.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

listExceptions

This method returns a list of exceptions that match the given search criteria.

query Parameters
status
Array of strings unique
Items Enum: "ANALYSIS" "DIFFERENT_FINGERS" "SAME_FINGERS" "INCORRECT_ENROLL" "RECOLLECT" "MERGE_TRANSACTIONS" "APPROVE" "REJECT" "ERROR"

Status of the request.

startDate
integer <int64>

Minimum timestamp, in milliseconds.

endDate
integer <int64>

Maximum timestamp, in milliseconds.

user
string

ID of the user.

keys
Array of strings unique

List of key values. Only anomalies.

biographics
Array of strings unique

List of biographic values.

labels
Array of strings unique

A list of labels of the person.

exceptionFields
Array of strings
Items Enum: "NO_FIELDS" "ALL_FIELDS"

List containing the names of the fields of the Exception entity to be included in the response.

pageIndex
integer <int32>
pageSize
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

unassignException

This method removes the assignment of a user to an exception.

path Parameters
tguid
required
string

Global unique ID of the transaction.

pguid
required
string

Global unique ID of the person.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

listByTransaction

This method returns the exception list from a given exception.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

assignException

This method assigns an exception to a given user.

path Parameters
tguid
required
string

Global unique ID of the transaction.

pguid
required
string

Global unique ID of the person.

user
required
string

ID of the user.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

getTreatResult

This method returns the status of the treatment given to a specific transaction.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "treatTguid": "string",
  • "failReason": "string"
}

treatException

This method provides the treatment for a given exception.

Request Body schema: application/json
object (ExceptionTreatment)
object (Meta)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "status": "OK",
  • "treatTguid": "string",
  • "failReason": "string"
}

getExceptionByEntrantPguid

path Parameters
pguid
required
string

Global unique ID of the person.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

getExceptionByReferencePguid

path Parameters
pguid
required
string

Global unique ID of the person.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

external-keys

getExternalID

This method returns the data related to a given external ID.

path Parameters
externalID
required
string

Any external key.

Responses

Response samples

Content type
application/json
{
  • "tguid": "string"
}

operations

notify

This method forces notification of a given transaction.

Request Body schema: application/json;charset=UTF-8
required
object (JsonNotification)

Responses

Request samples

Content type
application/json;charset=UTF-8
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

ping

This method is used to check the API availability.

Responses

people

getPerson

This method returns the information of a person, given its PGUID.

path Parameters
pguid
required
string

Global unique ID of the person.

query Parameters
personFields
Array of strings
Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"

List containing the names of the fields of the Person entity.

biometricFields
Array of strings unique
Items Enum: "INDEX" "ALL_FIELDS"

List containing the names of the fields of the Biometric entity.

biographicBase
boolean

Determines if the API will try to get biographics from the Biobase Server or not.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

update

This method performs an update operation in GBDS.

path Parameters
pguid
required
string

Global unique ID of the person.

Request Body schema: application/json
required
object (PersonRequest)
object (UpdateBiometricValidation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

deletePerson

This method deletes the information of a person, given its PGUID.

path Parameters
pguid
required
string

Global unique ID of the person.

query Parameters
priority
string
Enum: "GOD_PRIORITY" "HIGHEST_PRIORITY" "HIGHER_PRIORITY" "HIGH_PRIORITY" "DEFAULT_PRIORITY" "LOW_PRIORITY" "LOWER_PRIORITY" "LOWEST_PRIORITY"

Priority of the operation. Default is GOD_PRIORITY.

timeout
integer

Timeout of the operation. Default is 0.

If the timeout is -1, the operation will be executed synchronously.
If the timeout is 0, the operation will be executed asynchronously.
If the timeout is >0 (greater than 0), the operation will be executed synchronously after the timeout.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

enroll

This method submits a new enrollment operation to GBDS.

Request Body schema: application/json
required
object (PersonRequest)
object (BiometricValidation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listPeople

This method returns a list of people who match the given search criteria.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

deleteBiometric

This method delete a specific biometric in a person's register, given the person's PGUID and biometric index.

path Parameters
pguid
required
string

Global unique ID of the person.

biometricIndex
required
integer <int32>

Finger index to be excluded.

Responses

getPguidUsingKeys

This method returns the PGUID of a person, given its search keys.

query Parameters
key_id
required
string

ID of the key to be used to identify the reference person.

key_value
required
string

Value of the key to be used to identify the reference person.

Responses

Response samples

Content type
application/json
{
  • "data": "string"
}

disablePeopleTransaction

This method deletes a transaction from a person, given its TGUID and the person's PGUID.

path Parameters
pguid
required
string

Global unique ID of the person.

tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

trustedEnroll

This method performs an enrollment operation without comparing biometrics.

Request Body schema: application/json
required
object (PersonRequest)
object (TrustedEnrollMeta)

Contains extra information about the API call.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

trustedUpdate

This method performs an update operation without comparing biometrics.

path Parameters
pguid
required
string

Global unique ID of the person.

Request Body schema: application/json
required
object (PersonRequest)
object (TrustedEnrollMeta)

Contains extra information about the API call.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

trustedAddKeys

Adds new keys to a person.

path Parameters
pguid
required
string

Global unique ID of the person.

Request Body schema: application/json
required
Array of objects (Key)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

updateBiographicsOnBiobaseUsingPGUID

This endpoint creates or updates biographics on the Biographic Base Server using BioBase configuration on API.

It uses any key provided to find a person/identity on the server. If it does, it updates it with all biographics provided, keeping the existing ones.
If it does not find any person/identity with the keys provided, it creates a person/identity on the server with the keys and biographics provided.
It calls all servers until one responds with a 2xx http code. If none respond successfully, it returns the last server response call code.

Always send PGUID as key.

path Parameters
pguid
required
string

Global unique ID of the person.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

updateBiographicsOnBiobaseUsingPGUIDAndTGUID

This endpoint creates or updates biographics on the Biographic Base Server using BioBase configuration on API.

It uses any key provided to find a person/identity on the server. If it does, it updates it with all biographics provided, keeping the existing ones.
If it does not find any person/identity with the keys provided, it creates a person/identity on the server with the keys and biographics provided.
It calls all servers until one responds with a 2xx http code. If none respond successfully, it returns the last server response call code.

Always send PGUID and TGUID as keys.

path Parameters
pguid
required
string

Global unique ID of the person.

tguid
required
string

Global unique ID of the transaction.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

quality

qualityAnalysis

This method provides the quality analysis result for a given transaction.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Request Body schema: application/json
required
object
object (UpdateQualityAnalysisMeta)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

unassignPendingEnroll

This method removes the assignment of a user to quality analysis.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

assignPendingEnroll

This method assigns a quality analysis operation to a given user.

path Parameters
tguid
required
string

Global unique ID of the transaction.

userName
required
string

ID of the user.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

searches

getSearchResult

This method returns the result of a search operation, given its TGUID.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

search

This method performs a biometric search a returns the people that match the search criteria.

Request Body schema: application/json
required
object (SearchSpec)
object (SearchMeta)

Contains extra information about the API call.

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

transaction

getTransaction

This method returns the data of a transaction, given its TGUID.

path Parameters
tguid
required
string

Global unique ID of the transaction.

query Parameters
enrollFields
Array of strings
Items Enum: "BASIC_FIELDS" "EXCEPTIONS" "QUALITY" "PERSON" "EXCEPTION_ISSUES" "EXTERNAL_IDS" "ALL_FIELDS" "NO_FIELDS"

List containing the names of the fields of the Enroll entity.

personFields
Array of strings
Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"

List containing the names of the fields of the Person entity.

biometricFields
Array of strings unique
Items Enum: "INDEX" "ALL_FIELDS"

List containing the names of the fields of the Biometric entity.

biographicBase
boolean

Determines if the API will try to get biographics from the Biobase Server or not.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

listTransactions

This method returns a list of enrollment and updates transactions that match the search criteria.

query Parameters
enrollStatus
string
Enum: "ENQUEUED" "PROCESSING" "ENROLLED" "EXCEPTION" "FAILED" "REFUSED" "PENDING" "RESENT_ENROLL"

Select only enrolls with a specific status, e.g., ENROLLED.

This parameter can be a list. To do so, pass it multiple times with the desired values.

NOTE: At least one of the parameters enrollStatus or qualityStatus is required.

qualityStatus
string
Enum: "PENDING" "APPROVED" "REJECTED" "OK" "ERROR" "PENDING_DUPLICITIES"

Filter with specific quality status.

This parameter can be a list. To do so, pass it multiple times with the desired values.

NOTE: At least one of the parameters enrollStatus or qualityStatus is required.

startDate
integer <int64>

Minimum timestamp, in milliseconds.

endDate
integer <int64>

Maximum timestamp, in milliseconds.

keys
Array of strings

Array keys that uniquely identify the person. This field can be an expression.

biographics
Array of strings

Biographic data of the person. This field can be an expression.

labels
string

A list of labels that may be empty. This field can be an expression. For transactions with no labels, use "labels=".

pageSize
integer <int32>

Size of the request.

pageIndex
integer <int32>

Defines which page will be returned.

enrollFields
Array of strings
Items Enum: "BASIC_FIELDS" "EXCEPTIONS" "QUALITY" "PERSON" "EXCEPTION_ISSUES" "EXTERNAL_IDS" "ALL_FIELDS" "NO_FIELDS"

List containing the names of the fields of the Enroll entity.

personFields
Array of strings
Items Enum: "BIOMETRIC" "AUXILIARIES" "KEYS" "BIOGRAPHICS" "LABELS" "METADATA" "BASIC_FIELDS" "NO_FIELDS" "ALL_FIELDS"

List containing the names of the fields of the Person entity.

biometricFields
Array of strings unique
Items Enum: "INDEX" "ALL_FIELDS"

List containing the names of the fields of the Biometric entity.

manuallyReviewed
boolean

List transactions for MIR with parameter manuallyReviewed. Transactions are now manually reviewed if they once have the status PENDING (caught by quality control) and they were approved or rejected.

biographicBase
boolean

Determines if the API will try to get biographics from the Biobase Server or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    },
  • "meta": {
    }
}

linkEnroll

This method links an approved transaction to its refused transaction tguid.

path Parameters
tguid
required
string

Refused Transaction Tguid.

newTguid
required
string

Approved transaction Tguid.

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

transactionReport

Returns information about transactions that match the search criteria. The transactions will be grouped by operation and API instance (optional).

query Parameters
start
string

Start date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers one month from the request timestamp.

end
string

End date to filter the transactions. Format "yyyy-MM-dd HH:mm:ss". If absent, API considers the request timestamp.

byApiId
boolean

Flag to group results by API ID or not.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ul

listULs

This method returns a list of Unsolved Latent that match the search criteria.

query Parameters
pageSize
integer <int32>

Size of the request.

pageIndex
integer <int32>

Defines which page will be returned.

status
string
Enum: "UNSOLVED" "SOLVED"

Status of the request.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

createUL

This method submit a new Unsolved Latent to GBDS.

Request Body schema: application/json
required
object (Fragment)
object (ULValidation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

listULCandidates

This method returns a list of UL candidates that match the search criteria.

query Parameters
pageIndex
integer <int32>

Defines which page will be returned.

pageSize
integer <int32>

Size of the request.

iniDate
integer <int64>

Return candidates that were found after this date.

endDate
integer <int64>

Maximum timestamp, in milliseconds.

iniScore
integer <int32>

Return candidates that had a score greater than this.

endScore
integer <int32>

Return candidates that had a score lower than this.

caseId
string

ID of the case associated with the request.

fragmentId
string

Fragment ID of the UL.

user
string

ID of the user.

sortField
string
Enum: "SCORE" "STATUS" "CREATION_TIME" "CASE_ID" "FRAGMENT_ID" "USER"

Field chosen to sort the list order.

sortOrder
string
Enum: "ASCENDING" "DESCENDING"

Order that the list will be sorted.

status
string
Enum: "UNSOLVED" "SOLVED"

Status of the request.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

linkULs

This method links 2 different ULs, given both UGUIDs.

path Parameters
referenceUguid
required
string

Globally unique ID of the reference UL.

targetUguid
required
string

Globally unique ID of the target UL.

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

updateUL

This method updates an UL.

path Parameters
uguid
required
string

a

Request Body schema: application/json
object (Fragment)
object (ULValidation)

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

getUL

This method returns a UL, given its UGUID.

path Parameters
uguid
required
string

Globally unique ID of the UL.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

deleteCandidate

This method deletes a given candidate from the UL's candidates list.

path Parameters
uguid
required
string

Globally unique ID of the UL.

tguid
required
string

Global unique ID of the transaction.

index
required
integer <int32>

Index of the target candidate.

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

solveUL

This method associates the UL to a given reference person and then marks the UL as SOLVED.

path Parameters
uguid
required
string

Globally unique ID of the UL.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

unlinkULs

This method removes any existing links from a UL.

path Parameters
uguid
required
string

Globally unique ID of the UL.

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

deleteListOfCandidates

This method deletes a list of specific candidates for a given UL.

path Parameters
uguid
required
string

Globally unique ID of the UL.

Request Body schema: application/json
required
object (DeleteULCandidatesSpec)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

deleteAllCandidates

This method deletes all candidates for a given UL.

path Parameters
uguid
required
string

Globally unique ID of the UL.

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

tokens

createToken

This method provides the required authentication token to perform GBDS operations.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

email

groupEmailNotify

This method creates a new email group or updates details of an existing one.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    }
}

getGroupEmail

This method retrieves the group and its e-mail list.

path Parameters
group
required
string

Group name to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

userEmailNotify

This method inserts a user and update their groups.

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    }
}

getUserEmail

This method retrieves a user and its email groups.

path Parameters
user
required
string

User to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

transparency

peopleTransparency

Request to create or update transparency actions related to a pguid

Request Body schema: application/json
object (TransparencyPeopleRequest)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "data": {
    }
}

getPeopleTransparency

Request to get people transparency information by pguid.

path Parameters
pguid
required
string

Global unique ID of the person.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

getTransparencyList

Get people transparency list.

query Parameters
pageIndex
integer <int32>

Defines which page will be returned.

pageSize
integer <int32>

Size of the request.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

deletePeopleTransparency

this method deletes a given pguid from people transparency.

path Parameters
pguid
required
string

Global unique ID of the person.

query Parameters
action
string

transparency action

Responses

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

configuration

controlPanelConfig

This method is used to change the configuration GBDS RDB.

Request Body schema: application/json
application
string
Enum: "GBDS_API" "GBDS_DRIVER" "GBDS_API_AND_DRIVER"

Configuration mode for the application.

configurations
object

Dictionary of configuration parameters and default values. It can contain multiple unique parameters as Strings.

Responses

Request samples

Content type
application/json
{
  • "application": "GBDS_API",
  • "configurations": {
    }
}

Response samples

Content type
application/json
{
  • "type": "VALIDATION_ERROR",
  • "code": "MISSING_PGUID",
  • "message": "string",
  • "meta": { }
}

status

matcherStatus

This method return the complete information of the cluster and its nodes.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

gbdsStatus

This method return the GBDS status, number of matchers, and nodes from GBDS and all nodes.

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

logging

log

This method is used to get the loglevel of the API, GBDS.

Responses

Response samples

Content type
application/json
{
  • "type": "INTERNAL_ERROR",
  • "code": "DRIVER_OFFLINE",
  • "message": "string",
  • "meta": { }
}

changeLogLevel

This method is used to change the loglevel of the API, GBDS.

Request Body schema: application/json
required
Array of objects (ChangeLogLevel)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "INTERNAL_ERROR",
  • "code": "DRIVER_OFFLINE",
  • "message": "string",
  • "meta": { }
}

extraction-microservice

changeExtractorStatus

This method is used to change the status of an extraction microservice.

path Parameters
id
required
integer <int32>
enabled
required
string
Enum: "ENABLE" "DISABLE" "RESTART"

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

removeExtractor

This method is used to remove an extraction microservice.

Request Body schema: application/json
required
library
string
Enum: "GINGER" "FACE" "GIRL"
count
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "library": "GINGER",
  • "count": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

listExtractors

This method is used to list all extraction microservice.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

addExtractors

This method is used to add a new extraction microservice.

Request Body schema: application/json
required
library
string
Enum: "GINGER" "FACE" "GIRL"
count
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "library": "GINGER",
  • "count": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

quality-extraction

listQualityExtractors

This method lists all quality extraction services configured on API.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

addQualityExtractors

This method is used to add a new instance of the quality extraction service.

Request Body schema: application/json
library
string
Enum: "FINGER" "FACE"
count
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "library": "FINGER",
  • "count": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

changeQualityExtractorStatus

This method is used to change the status of an instance of the quality extraction service.

path Parameters
quality-extraction-service-id
required
integer <int32>

Id for a quality extraction service, as returned by the list endpoint.

operation
required
string
Enum: "ENABLE" "DISABLE" "RESTART"

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

removeQualityExtractor

This method is used to remove an instance of the quality extraction service.

Request Body schema: application/json
required
library
string
Enum: "FINGER" "FACE"
count
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "library": "FINGER",
  • "count": 0
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

apis

listAPIs

This method is used to list all the APIs configured in the cluster.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

createAPI

This method is used to create or update an API instance within the cluster. If the API type is LEADER, but another LEADER is already set, the older one becomes a RUNNER type.

Request Body schema: application/json
object (API)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "status": "CREATED",
  • "data": {
    }
}

deleteAPI

This method is used to remove an API instance from the cluster.

path Parameters
apiId
required
string

Unique ID of the desired API.

Responses

Response samples

Content type
application/json
{
  • "type": "PROCESSING_ERROR",
  • "code": "ENTITY_DOES_NOT_EXIST",
  • "message": "string",
  • "meta": { }
}

shutdown

gbdsShutdown

This method safe shutdown for API and GBDS

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": "INTERNAL_ERROR",
  • "code": "DRIVER_OFFLINE",
  • "message": "string",
  • "meta": { }
}

liveness

livenessCheck

This method submits a biometric sample for liveness check.

Request Body schema: application/json
required
object (LivenessCheckBiometric)

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "tguid": "string",
  • "bonafideScore": 0
}

getLivenessResult

This method returns the liveness check result using the TGUID.

path Parameters
tguid
required
string

Global unique ID of the transaction.

Responses

Response samples

Content type
application/json
{
  • "tguid": "string",
  • "biometric": {
    },
  • "bonafideScore": 0
}