API docs by Redocly

BCC Services API (2.8.7)

Download OpenAPI specification:Download

Capture Instance Status

getProfile

Retrieves a previously performed profile capture.

query Parameters
tguid
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

addCaptureData

Add biometric data to a capture.

query Parameters
tguid
string
Request Body schema: application/json
pguid
string
tguid
string
responsiblePguid
string
insertionDate
string <date-time>
transactionDate
string <date-time>
gbdsStatus
string
Enum: "NONE" "READY" "PROCESS_PENDING" "GBDS_SENDING" "GBDS_SENT" "GBDS_IN_PROGRESS" "SEARCH_MATCH" "SEARCH_NOT_MATCH" "GBDS_OK" "GBDS_ETR_ANALYSIS" "GBDS_ETR_FRAUD_SAME_BIOMETRY" "GBDS_ETR_FRAUD_DIFF_BIOMETRY" "GBDS_ETR_RECOLLECT" "GBDS_ETR_OK" "GBDS_FAILED" "GBDS_REFUSED" "ERROR" "GBDS_MIR_PENDING" "GBDS_MIR_APPROVED" "GBDS_MIR_REJECTED"
Array of objects (HistoryEvent)
currentTransaction
boolean
startDate
string <date-time>
stopDate
Array of strings <date-time>
restartDate
Array of strings <date-time>
Array of objects (Fingerprint)
Array of objects (Palm)
Array of objects (BodyImage)
object (Signature)
labels
Array of strings
Array of objects (FieldSubEntity)
externalIDName
string
externalIDValue
string
Array of objects (ExternalId)

Responses

Request samples

Content type
application/json
{
  • "pguid": "string",
  • "tguid": "string",
  • "responsiblePguid": "string",
  • "insertionDate": "2019-08-24T14:15:22Z",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "gbdsStatus": "NONE",
  • "history": [
    ],
  • "currentTransaction": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": [
    ],
  • "restartDate": [
    ],
  • "fingerprints": [
    ],
  • "palms": [
    ],
  • "bodyImages": [
    ],
  • "signature": {
    },
  • "labels": [
    ],
  • "fields": [
    ],
  • "externalIDName": "string",
  • "externalIDValue": "string",
  • "externalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

overwriteCaptureData

Overwrites all the biometric data of a capture.

query Parameters
tguid
string
Request Body schema: application/json
pguid
string
tguid
string
responsiblePguid
string
insertionDate
string <date-time>
transactionDate
string <date-time>
gbdsStatus
string
Enum: "NONE" "READY" "PROCESS_PENDING" "GBDS_SENDING" "GBDS_SENT" "GBDS_IN_PROGRESS" "SEARCH_MATCH" "SEARCH_NOT_MATCH" "GBDS_OK" "GBDS_ETR_ANALYSIS" "GBDS_ETR_FRAUD_SAME_BIOMETRY" "GBDS_ETR_FRAUD_DIFF_BIOMETRY" "GBDS_ETR_RECOLLECT" "GBDS_ETR_OK" "GBDS_FAILED" "GBDS_REFUSED" "ERROR" "GBDS_MIR_PENDING" "GBDS_MIR_APPROVED" "GBDS_MIR_REJECTED"
Array of objects (HistoryEvent)
currentTransaction
boolean
startDate
string <date-time>
stopDate
Array of strings <date-time>
restartDate
Array of strings <date-time>
Array of objects (Fingerprint)
Array of objects (Palm)
Array of objects (BodyImage)
object (Signature)
labels
Array of strings
Array of objects (FieldSubEntity)
externalIDName
string
externalIDValue
string
Array of objects (ExternalId)

Responses

Request samples

Content type
application/json
{
  • "pguid": "string",
  • "tguid": "string",
  • "responsiblePguid": "string",
  • "insertionDate": "2019-08-24T14:15:22Z",
  • "transactionDate": "2019-08-24T14:15:22Z",
  • "gbdsStatus": "NONE",
  • "history": [
    ],
  • "currentTransaction": true,
  • "startDate": "2019-08-24T14:15:22Z",
  • "stopDate": [
    ],
  • "restartDate": [
    ],
  • "fingerprints": [
    ],
  • "palms": [
    ],
  • "bodyImages": [
    ],
  • "signature": {
    },
  • "labels": [
    ],
  • "fields": [
    ],
  • "externalIDName": "string",
  • "externalIDValue": "string",
  • "externalIds": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

deleteProfile

Deletes a previously performed capture.

query Parameters
tguid
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

status

Returns the current status of any open capture scene.

query Parameters
tguid
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

listCaptureInstances

Lists open capture instances.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

restartBcc

Restarts BCC Service.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

openCapture

Opens an existing profile for editing.

query Parameters
tguid
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

resetCapture

Clear all profile data.

query Parameters
tguid
string

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

Biometric Capture

captureIrises

Initializes a capture scene for irises.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
type
string
Value: "IRIS"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "type": "IRIS",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

capturePalm

Initializes a capture scene for palm.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
type
string
Value: "PALM"
Array of objects (PalmSubEntity)

Array with which palms to capture.

exceptionSetType
string
Enum: "SIMPLIFIED" "TECHNICAL"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "type": "PALM",
  • "indexes": [
    ],
  • "exceptionSetType": "SIMPLIFIED",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureSignature

Initializes a capture scene for signature.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
type
string
Value: "SIGNATURE"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "type": "SIGNATURE",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureFingerprint

Initializes a capture scene for fingerprint.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
captureType
string
Enum: "ROLLED" "FLAT"
type
string
Value: "FINGERPRINT"
sequenceControlType
string
Enum: "NONE" "CTRL_221" "CTRL_442"

Type of sequence control capture. NONE if individual capture, CTRL_221 or CTRL_442

Array of objects (FingerprintSubEntity)

Array with which fingers to capture. In case of sequenceControlType CTRL_221 or CTRL_442, must have all fingers

exceptionSetType
string
Enum: "SIMPLIFIED" "TECHNICAL"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "captureType": "ROLLED",
  • "type": "FINGERPRINT",
  • "sequenceControlType": "NONE",
  • "indexes": [
    ],
  • "exceptionSetType": "SIMPLIFIED",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureBabyPalm

Initializes a capture scene for baby palms.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
isBaby
boolean
type
string
Value: "BABY_PALM"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "isBaby": true,
  • "type": "BABY_PALM",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureFace

Initializes a capture scene for face.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
type
string
Value: "FACE"
index
integer <int32>

Index for type of face capture. 10 -> Frontal, 11 -> Left mugshot, 12 -> Right mugshot

processImage
boolean

Boolean for processing face captured. If 'index' property is 11 or 12, must be 'false'

Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "type": "FACE",
  • "index": 0,
  • "processImage": true,
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureAuxiliarImage

Initializes a capture scene for auxiliary image.

query Parameters
tguid
string
Request Body schema: application/json
captureMode
string
Enum: "REGISTER" "VERIFY" "IDENTIFY"
notifyUrl
string
theme
string
Enum: "DARK" "LIGHT"
type
string
Value: "AUXILIARY_IMAGES"
Array of objects (SceneFunction) unique

Functions to appear in capture window

Responses

Request samples

Content type
application/json
{
  • "captureMode": "REGISTER",
  • "notifyUrl": "string",
  • "theme": "DARK",
  • "type": "AUXILIARY_IMAGES",
  • "functions": [
    ]
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

captureFullProfile

Starts a capture of a full profile.

query Parameters
tguid
string
Request Body schema: application/json
object (Profile)
object (Profile)
object (SceneParameters)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

BCC Service Status

version

Get GBS BCC Service version

Responses

Response samples

Content type
application/json
{
  • "status": "OK",
  • "code": 0,
  • "message": "string",
  • "getversion": "string"
}

serviceStatus

Retrieves the state of BCC Services.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

appStatus

Retrieves application status.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

deviceStatus

Checks the status of capture devices.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

finishService

Finishes BCC Services.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

openAbout

Opens the About window.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

BCC Service Config

getConfig

Retrieves the current configuration parameters for BCC.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

setConfig

Sets a configuration parameter for BCC.

Request Body schema: application/json
theme
string
Enum: "LIGHT" "DARK"
themeColor
string
Enum: "BLUE_GRAY" "GREY" "LIGHT_GREEN"
captureType
string
Enum: "NONE" "FLAT" "FLAT_TWO_FINGERS" "FLAT_TWO_THUMBS" "FLAT_FOUR_FINGERS" "ROLLED" "LEFT_INTERDIGITAL" "LEFT_THENAR" "LEFT_HYPOTHENAR" "LEFT_FULL" "LEFT_WRITER" "RIGHT_INTERDIGITAL" "RIGHT_THENAR" "RIGHT_HYPOTHENAR" "RIGHT_FULL" "RIGHT_WRITER" "LEFT_INDEX" "LEFT_LITTLE" "LEFT_MIDDLE" "LEFT_RING" "LEFT_THUMB" "RIGHT_INDEX" "RIGHT_LITTLE" "RIGHT_MIDDLE" "RIGHT_RING" "RIGHT_THUMB" "LEFT_PALM" "RIGHT_PALM"
advanceMode
string
Enum: "AUTOMATIC" "SEMI_AUTOMATIC"
matchSequence
boolean
sequenceControlType
string
Enum: "NONE" "CTRL_221" "CTRL_442"
minQuality
integer <int32>
triesToAccept
integer <int32>
minNfiq
integer <int32>
nfiqAction
string
Enum: "KEEP" "REMOVE"
nfiqAnomaly
string
Enum: "NONE" "ADACTILY" "ANKYLOSIS" "ECTRODACTYLY" "HIPERPHALANGY" "POLYDACTYLY" "MICRODACTYLY" "MACRODACTYLY" "SYNDATYLY" "DAMAGED" "BANDAGED" "IGNORED" "AMPUTATED" "LOW_QUALITY"
faceCameraType
string
Enum: "WEBCAM_OPENCV" "WEBCAM_DS" "CANON_EOS" "CANON_POWERSHOT"
webcamResolution
string
Enum: "QVGA" "VGA" "SVGA" "HD_NON_WIDE" "HD" "XGA" "WXGA" "WXGA_PLUS" "UXGA" "UWXGA_PLUS" "FULL_HD_NON_WIDE" "FULL_HD" "FULL_HD_ULTRA_WIDE"
faceWebcamDevice
integer <int32>
faceFlashMode
string
Enum: "ON" "OFF"
faceAutoCapture
boolean
faceAutoCaptureDelay
integer <int32>
faceCameraRotation
integer <int32>
faceAdjustNumber
number <double>
bodyCameraType
string
Enum: "WEBCAM_OPENCV" "WEBCAM_DS" "CANON_EOS" "CANON_POWERSHOT"
bodyWebcamDevice
integer <int32>
bodyFlashMode
string
Enum: "ON" "OFF"
bodyCameraRotation
integer <int32>
signatureType
string
Enum: "SignatureGem1X5" "SignatureGem4X5" "SignatureGemLCD" "SignatureGemLCD4X3New" "SignatureGemLCD4X5" "ClipGem" "ClipGemLGL"
signatureDevice
string
Enum: "TOPAZ" "WACOM" "MSP" "SIGNOTEC"
irisDevice
string
Enum: "CROSSMATCH" "IRITECH" "HUMMINGBIRD"
Array of objects (FingerprintCaptureStep)
Array of objects (FingerprintCaptureStep)
Array of objects (FingerprintCaptureStep)
Array of objects (PalmCaptureStep)
Array of objects (PalmCaptureStep)
modules
Array of strings
Items Enum: "FINGERPRINT" "FACE" "SIGNATURE" "PALM" "AUXILIARY_IMAGES" "IRISES" "SEQUENCE_CONTROL"
minBiometrics
integer <int32>
minFingers
integer <int32>
minFaces
integer <int32>
maxAnomalies
integer <int32>
captureSignature
boolean
whiteBalanceMode
string
Enum: "AUTO" "CUSTOM"
whiteBalanceShiftBlueAmber
integer <int32>
whiteBalanceShiftGreenMagenta
integer <int32>
processLiveView
boolean
littleFingerVerifyThreshold
integer <int32>
ringFingerVerifyThreshold
integer <int32>
middleFingerVerifyThreshold
integer <int32>
indexFingerVerifyThreshold
integer <int32>
thumbFingerVerifyThreshold
integer <int32>
defaultFingerVerifyThreshold
integer <int32>
defaultFaceVerifyThreshold
integer <int32>
bodyImageShapes
string
Enum: "SIMPLIFIED" "FULL"
minutiaOrientation
string
Enum: "DEFAULT" "ISO"
signatureImageType
string
Enum: "TIFF" "JPEG" "PNG"
signatureBitDepth
string
Enum: "GREYSCALE" "COLOR"
cropImages
boolean
jpegQuality
integer <int32>
faceCaptureCriticals
Array of strings
Items Enum: "NO_EYES_AND_MOUTH" "NO_CROP" "NOT_SATURATED" "FACE_TURNED_DOWN" "FACE_TURNED_UP" "FACE_TURNED_LEFT" "FACE_TURNED_RIGHT" "LOOKING_DOWN" "LOOKING_UP" "LOOKING_LEFT" "LOOKING_RIGHT" "USING_HEAVY_GLASSES" "EYE_OBSTRUCTION" "FACE_CORRECT_POSITION" "NUMBER_OF_FACES" "SHOULDER_CORRECT_POSITION" "SHOULDER_TURNED_LEFT" "SHOULDER_TURNED_RIGHT" "TOO_CLOSED_EYES" "TOO_OPENED_EYES" "OPENED_MOUTH" "SHOWING_TEETH" "SMILING" "RED_EYE" "BLURRED_PICTURE" "BUSY_BACKGROUND" "CROP_OUT_OF_ORIGINAL_PICTURE"
faceCaptureErrors
Array of strings
Items Enum: "NO_EYES_AND_MOUTH" "NO_CROP" "NOT_SATURATED" "FACE_TURNED_DOWN" "FACE_TURNED_UP" "FACE_TURNED_LEFT" "FACE_TURNED_RIGHT" "LOOKING_DOWN" "LOOKING_UP" "LOOKING_LEFT" "LOOKING_RIGHT" "USING_HEAVY_GLASSES" "EYE_OBSTRUCTION" "FACE_CORRECT_POSITION" "NUMBER_OF_FACES" "SHOULDER_CORRECT_POSITION" "SHOULDER_TURNED_LEFT" "SHOULDER_TURNED_RIGHT" "TOO_CLOSED_EYES" "TOO_OPENED_EYES" "OPENED_MOUTH" "SHOWING_TEETH" "SMILING" "RED_EYE" "BLURRED_PICTURE" "BUSY_BACKGROUND" "CROP_OUT_OF_ORIGINAL_PICTURE"
faceCaptureWarnings
Array of strings
Items Enum: "NO_EYES_AND_MOUTH" "NO_CROP" "NOT_SATURATED" "FACE_TURNED_DOWN" "FACE_TURNED_UP" "FACE_TURNED_LEFT" "FACE_TURNED_RIGHT" "LOOKING_DOWN" "LOOKING_UP" "LOOKING_LEFT" "LOOKING_RIGHT" "USING_HEAVY_GLASSES" "EYE_OBSTRUCTION" "FACE_CORRECT_POSITION" "NUMBER_OF_FACES" "SHOULDER_CORRECT_POSITION" "SHOULDER_TURNED_LEFT" "SHOULDER_TURNED_RIGHT" "TOO_CLOSED_EYES" "TOO_OPENED_EYES" "OPENED_MOUTH" "SHOWING_TEETH" "SMILING" "RED_EYE" "BLURRED_PICTURE" "BUSY_BACKGROUND" "CROP_OUT_OF_ORIGINAL_PICTURE"
qtdeMinFaceCaptureErrors
integer <int32>
faceCaptureMask
boolean
faceCaptureMaskHorizontalFactor
number <double>
faceCaptureMaskVerticalFactor
number <double>
anomalySetType
string
Enum: "SIMPLIFIED" "TECHNICAL"
object
babyCaptureAutomaticAdvance
boolean
rejectFutureDates
boolean
babyFaceRequired
boolean
babyPalmsRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "theme": "LIGHT",
  • "themeColor": "BLUE_GRAY",
  • "captureType": "NONE",
  • "advanceMode": "AUTOMATIC",
  • "matchSequence": true,
  • "sequenceControlType": "NONE",
  • "minQuality": 0,
  • "triesToAccept": 0,
  • "minNfiq": 0,
  • "nfiqAction": "KEEP",
  • "nfiqAnomaly": "NONE",
  • "faceCameraType": "WEBCAM_OPENCV",
  • "webcamResolution": "QVGA",
  • "faceWebcamDevice": 0,
  • "faceFlashMode": "ON",
  • "faceAutoCapture": true,
  • "faceAutoCaptureDelay": 0,
  • "faceCameraRotation": 0,
  • "faceAdjustNumber": 0,
  • "bodyCameraType": "WEBCAM_OPENCV",
  • "bodyWebcamDevice": 0,
  • "bodyFlashMode": "ON",
  • "bodyCameraRotation": 0,
  • "signatureType": "SignatureGem1X5",
  • "signatureDevice": "TOPAZ",
  • "irisDevice": "CROSSMATCH",
  • "sequence221": [
    ],
  • "sequence442": [
    ],
  • "sequenceMain": [
    ],
  • "sequencePalm": [
    ],
  • "babySequencePalm": [
    ],
  • "modules": [
    ],
  • "minBiometrics": 0,
  • "minFingers": 0,
  • "minFaces": 0,
  • "maxAnomalies": 0,
  • "captureSignature": true,
  • "whiteBalanceMode": "AUTO",
  • "whiteBalanceShiftBlueAmber": 0,
  • "whiteBalanceShiftGreenMagenta": 0,
  • "processLiveView": true,
  • "littleFingerVerifyThreshold": 0,
  • "ringFingerVerifyThreshold": 0,
  • "middleFingerVerifyThreshold": 0,
  • "indexFingerVerifyThreshold": 0,
  • "thumbFingerVerifyThreshold": 0,
  • "defaultFingerVerifyThreshold": 0,
  • "defaultFaceVerifyThreshold": 0,
  • "bodyImageShapes": "SIMPLIFIED",
  • "minutiaOrientation": "DEFAULT",
  • "signatureImageType": "TIFF",
  • "signatureBitDepth": "GREYSCALE",
  • "cropImages": true,
  • "jpegQuality": 0,
  • "faceCaptureCriticals": [
    ],
  • "faceCaptureErrors": [
    ],
  • "faceCaptureWarnings": [
    ],
  • "qtdeMinFaceCaptureErrors": 0,
  • "faceCaptureMask": true,
  • "faceCaptureMaskHorizontalFactor": 0,
  • "faceCaptureMaskVerticalFactor": 0,
  • "anomalySetType": "SIMPLIFIED",
  • "windowsInfo": {
    },
  • "babyCaptureAutomaticAdvance": true,
  • "rejectFutureDates": true,
  • "babyFaceRequired": true,
  • "babyPalmsRequired": true
}

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}

openConfig

Opens the configurations window.

Responses

Response samples

Content type
application/json
{
  • "result": "OK",
  • "serverState": "IDLE",
  • "tguid": "string",
  • "type": "PROFILE",
  • "message": { },
  • "status": "NONE",
  • "operation": "NONE",
  • "command": "NONE",
  • "name": "string",
  • "sequenceControlType": "NONE",
  • "count": 0,
  • "instances": [
    ],
  • "verifyResult": {
    },
  • "validValues": [
    ],
  • "wsq": "string",
  • "registration": "string",
  • "profile": {
    },
  • "babyProfile": {
    },
  • "profileMetadata": {
    },
  • "babyProfileMetadata": {
    },
  • "windowInfo": {
    },
  • "layout": {
    },
  • "anomalies": [
    ],
  • "extraButton": "string",
  • "layoutConfig": {
    },
  • "babyPalms": [
    ]
}