BCC Services Integration
Introduction
BCC Services is a software component used for biometric capture. BCC Services is used to collect biometric images, but does not automatically send them to the server. You can see how to send a capture to GBDS in the section Registration in GBDS.
BCC Services does not save the collected biometric data and only keeps it in RAM while it is active. Restarting or shutting down the computer or closing BCC Services will result in loss of the collections.
This manual describes the standard biometric capture workflow and troubleshooting for BCC Services. See the BCC Services API specification for more information about the API calls.
This manual is up to date for BCC Services version 2.8.8.
Capture Flow
This section will describe the capture flow and the biometric capture options you can perform with BCC Services. An example of endpoint calls and responses can be seen in the Capture Flow Example
To start a capture, you need to call one of the biometric capture endpoints. These are:
These captures may return one of two responses:
200, for OK
400, for ERROR
The status 200 will have a field tguid that you must save. Each Biometric Capture call will have its unique ID, regardless of how many captures are performed in the same call. that is, you can perform the call Fingerprint Capture to collect all ten fingers, generating one tguid for all captures, or using the same endpoint ten times, generating one tguid for each fingerprint.
The biometric capture opens a capture window. To get the capture status, execute the status call. This endpoint will return the capture status, the sensor information and partial information of which biometrics are captured.
You must perform the status call until the value of the field status is captured. This will indicate that the capture has been completed. Other statuses can be seen if the capture is incomplete, such as capturing if the capture window is still open or closed if the capture window has been closed without completing the capture.
When obtaining the capturedstatus, you need to perform the call getProfile. The response of this call contains the images .wsq and .jpeg. These are in the field buffer and converted-buffer, respectively, as bytearrays in base64 format.
After the completion of a capture, we recommend saving the images in a local database until sending them to the server.
BCC Services saves the capture in RAM. Exiting BCC Services, shutting down or restarting the computer without persisting the transaction data will result in data loss.
After all required captures have been made, restart the BCC services using the restartBcc.
Restarting BCC Services will clear all transaction data in RAM. Ensure your data is saved before restarting BCC Services.
The call restartBcc will stop BCC Services and reopen it automatically. To ensure the software is running after restart, perform the serviceStatus call and verify that the value of the field serverState is running.
Reopen incomplete capture window
If the user closed the capture window without finishing the capture, the status call will return the value of the status as closed. You can continue an interrupted capture with the openCapture call passing the tguid provided by the biometric capture call. This will keep the capture progress.
Retrieving TGUID
If you lost a TGUID for any reason, you can recover the TGUID using the listCaptureInstancescall. Within the array of instances, you can find all biometric captures performed while BCC Services was active (if the transaction history has not been cleared). It will list them in execution order, the first will be the first Biometric Capture called and the last will be the last Biometric Capture called. An example response is shown below.
Troubleshooting
BCC Services has some troubleshooting calls that you can make to ensure things are working correctly. Such as whether your equipment is being identified and whether the software version is known by you and the support team that can help you with your issue. These calls are presented below.
Version
Checking the software version is essential for troubleshooting scenarios. To check the BCC Services version, execute the version call.
Running
To check if the program is running, use the serviceStatus call and observe the value of the field serverState.
Devices
BCC Services offers an option to show all devices that are connected to it. To display the list of devices, execute the deviceStatus.
call
Shutdown To shut down BCC Services, call
Capture Flow Example
finishService
In this example, we will describe how to perform the calls for a registration of a rolled capture of all fingers of the left hand. First, perform the Fingerprint Capture Call
with the following query: The field captureMode
"type": "IMPORT",
"tguid": "F1F14ADA-6A00-4A67-B887-F574764ECC77" statusCopy this TGUID and start calling captured.
. until you receive the status closedRemember that other statuses, such as
, may also be returned if the operator does not complete the capture.
"state": "NORMAL" status If some fingers were captured but the capture was not finalized, the
"contrast": 66, status After the end of the capture, the field of captured will change to status and the
call will respond with: The values BYTEARRAY
"width": 1000.0, .jpeg.
After a complete transaction, the status call responds with the images getProfileNow it is time to perform the .wsq and .jpeg. This call will respond with the images in images buffer . The field .wsq contains the images while the field . The field .jpeg.
"buffer": "BYTEARRAY",
Registration in GBDS
After capture, you can send the images to the server. To understand how to register the captured biometrics in GBDS, go to the next section. Call the enroll endpoint
if you want to register the previously captured images in GBDS. In the payload you need to insert the key information (keys), and biographics (biographics). Within the arraybiometric , you will need to insert the data from the BCC Services getCapture
endpoint. buffer The value of the field BCC Services needs to be placed in the value of the field content
in the JSON payload for GBDS.
For more information about operations in GBDS, consult the GBDS Integration Manual.
"index": 4,
Annotation of anomaly in capture fingerprintsFor an anomaly in the fingerprint capture to be recorded, the transaction metadata must include the object
. This object must contain the finger indexes and their respective anomalies.:
"anomaly": "AMPUTATED"
The indexes are ENUMs:LEFT_LITTLELEFT_RINGLEFT_MIDDLELEFT_INDEXLEFT_THUMBRIGHT_THUMBRIGHT_INDEXRIGHT_MIDDLERIGHT_RING
RIGHT_LITTLE
The types of anomalies are:DAMAGEDBANDAGEDIGNORED
The AMPUTATED metadata enroll needs to be added to the
with the following query: "metadata", represented in base64 in the example above, corresponds to the following JSON:
The JSON must contain at least the field “fingerprints” and within each item at minimum the fields "index" and "anomaly".
Last updated
Was this helpful?