# GBS SPID

## GBS SPID

SPID is an application for simplified biometric capture, with minimal use of biographical data.

Through SPID, it is possible to perform biometric capture for registration, update and search operations using only a unique identifier of the applicant as biographical data (e.g. document number).

## Installation

To install SPID, simply double-click the installer.

![SPID - Installer](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-80d066d59d11e61c46ae5bf30e64867d9bb63a8f%2Fspidinstaller.png?alt=media)

### Configuring TLS (Optional)

To configure authentication via TLS, edit, in the file `C:\Griaule\SPID\conf\GBSSpid2.properties`, the lines of the SSL Connection group below, according to the configurations required for your environment:

* **keystore.path**: Full path of the .pfx file with the CA's TLS public key.
* **keystore.password**: Encrypted keystore password.
* **truststore.path**: Full path of the cacerts file of the trust chain certificates.
* **truststore.password**: Encrypted truststore password.

{% hint style="info" %}
Directory paths must be separated by `/`.
{% endhint %}

It is also necessary to check the configuration `server.url=https://<server>:<port>/gbs-spid-server/service/cluster`, where the configured port must be 8444.

{% hint style="info" %}
The certificate subject CN needs to have the same FQDN that will be used as \<server>.
{% endhint %}

{% hint style="warning" %}
Domain resolution of the FQDN is required; using an IP address as the server will not work.
{% endhint %}

## Usage

To use SPID, the operator must be previously registered by the system administrator.

{% hint style="info" %}
See the GBS SPID Server manual for more information on how to register operators.
{% endhint %}

After registration on the SPID Server, the operator must access SPID to enter their biometrics.

{% hint style="info" %}
The insertion of the operator's biometrics to complete the registration will occur only on the first access to SPID and will be used to validate the operator's identity when submitting client registrations.
{% endhint %}

### Operator Login

When starting SPID, the operator's CPF will be requested for login. If it is the first access, the biometrics will be requested next:

![SPID - Login](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-fb6db078de11015dd1aecd3dcf6f40e5db3fd482%2Fspidlogin.png?alt=media)

After the login is completed, SPID's home page will be displayed:

![SPID - Home screen](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-e614ddb92783efa5fcfac568947914bfe67de39d%2Fspidmainpage.png?alt=media)

From SPID's home screen, it is possible to *Switch Operator*, ending the initial operator's session and returning to the operator login screen, and access synchronization reports through the *Synchronized*button, which allows viewing the statuses of transactions submitted to the server, as well as generating biometric capture reports.

### Client Biometrics Capture

By entering the client's CPF in the text field on SPID's home screen and pressing the *Enter*, or clicking the *OK*, the biometric capture window will open.

![SPID - Client biometric capture](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-7355f6186224b354157725c29859aca2145e05b9%2Fclientcapture.png?alt=media)

On this screen, the client's fingerprints and face must be collected, according to the indications.

The capture will finish as soon as all biometrics are captured. It is also possible to force the end of the capture using the *Finish*.

button. To cancel a capture, simply click the *X* in the upper right corner and confirm the action.

![SPID - Close capture window](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-867f7c140ca5d31d535372b3b7f4ff6fc5e97cb2%2Fclosecapturewindow.png?alt=media) ![SPID - Confirm capture cancellation](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-7a9d2d52d27f30bd16ef06c4787d40ce1a051051%2Fconfirmcancelcapture.png?alt=media)

#### Face Image Capture

Facial image capture is performed automatically by SPID. For this, the client must be looking directly at the camera, alone and about 50 cm away from the camera. Facial expression should be neutral and the client should not smile. If the client is wearing sunglasses, they should be removed, as well as caps and hats.

{% hint style="info" %}
In some cases, prescription glasses cause reflections and prevent automatic capture, so it is recommended that the client also remove them.
{% endhint %}

If the facial image capture does not occur automatically within 20 seconds, a *Force Capture* button will be enabled, allowing the capture to be performed manually by the operator.

![SPID - Manual face image capture](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-4cc7a0a210cf3b2800515d31d1e7d1c1f437a66c%2Fforcefacecapture.png?alt=media)

{% hint style="info" %}
It is possible to restart the face image capture by double-clicking the image, or by using the *Restart*
{% endhint %}

#### button.

Fingerprint Capture

![When starting the client's data capture screen, one of the fingers will be indicated in yellow, according to the configured capture sequence. The client just needs to place the indicated finger on the fingerprint reader for the capture to be performed automatically. Captured fingers will be marked in green and the next finger will be indicated for capture, according to the specified sequence.](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-086da1bcbf3ebdcc7c8bcbde8ad855ddd87ccf33%2Ffingercapture.png?alt=media)

SPID - Fingerprint capture

**If the capture is not performed automatically, it may be that the quality requirements have not been met. In this case, it is recommended to take some actions regarding the following situations:**

Dry hands:

**If it is identified that the client's hands are very dry, it is recommended that the fingers be moistened and dried before a new capture attempt.**

Wet hands:

In case of wet or sweaty hands, the fingers should be dried before a new capture attempt. *It is possible to select another finger for capture by clicking on its respective drawing. This will cause the desired finger to be marked for capture. It is also possible to proceed to the next finger without capturing the first using the*.

![Next](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-a2a8b0a68b82d2bb77ee7a079973280e6b7febd0%2Fnextbutton.png?alt=media)

button. *Restart*.

![SPID - Button to capture next finger](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-a65ea952ccdfffb19b98fd527d55a786ea45c57f%2Frestartcapture.png?alt=media)

**The capture can be restarted by clicking the drawing of the desired hand, or using the**

SPID - Button to restart capture

![Unavailable Fingerprints](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-905d40bafc34f5732a85078f876eac700c4c3385%2Funavailablefingers.png?alt=media) ![By right-clicking on a finger or hand, it will be possible to mark the finger as unavailable (temporary conditions that prevent fingerprint capture, such as bandaged fingers) or absent (permanent conditions that prevent fingerprint capture, such as amputated fingers). For unavailable finger cases, a comment can be added detailing the condition.](https://118801336-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHMy9gZsTdEehR3FxRxgN%2Fuploads%2Fgit-blob-2a66f3f293503f98e79093cc16bb9dd8c7fa82f2%2Funavailablefingerscomment.png?alt=media)

#### SPID - Marking unavailable fingers

SPID - Comment about unavailable finger **Completion of Captures** After finishing a client's biometric captures, the operator must submit them to the server. When doing so, a screen will open requesting a biometric validation of an

{% hint style="info" %}
OPERATOR
{% endhint %}

### fingerprint to complete the action. The operator must place the indicated fingerprint on the reader in order to complete the submission process.

Failing three times in the operator biometric confirmation process will make the system request confirmation with another operator fingerprint.

Mode of Operation

{% hint style="warning" %}
SPID can operate both in Online mode and Offline mode. In online mode, each query or registration performed is sent to the server, which, in turn, will return a response (registration ok, update failure, among others).
{% endhint %}

### In offline mode, registrations made will not be authenticated nor sent to the server. They will be stored locally until SPID can connect to the server. Once connected, SPID will synchronize its database with the server and update the synchronization report.

It is very important that when operating in offline mode, SPID is not uninstalled because its database is stored locally. If it is uninstalled, that database will be deleted and the collections will be lost. *Querying Results*The result of the operations performed will appear in the

Synchronization Report *, which can be accessed from SPID's home page.*&#x49;n the case of offline operation, the operation status will appear only as

Not Sent

* **, for both registration transactions and update transactions. This status will only be changed when SPID operates in online mode again.**&#x49;n online operation mode, transactions may be in one of the following statuses:
* **Registration Sent**: the registration was sent to the server, but has not yet been processed;
* **Registration OK**: the registration was successfully processed by the server;
* **Registration Failure**: the registration was not processed correctly by the server;
* **Update Sent**: the query or update was sent to the server, but has not yet been processed;
* **Update OK**: the query or update was successfully processed by the server;

### Update Failure

: the query or update was not processed correctly by the server;

| Error Codes | In some cases, SPID may present error messages when an unexpected situation is encountered. Below is a table with the codes and their respective descriptions: |
| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 20          | Code *Description* The search for the                                                                                                                          |
| 21          | status *of the operator on the server returned an unexpected value* There is some problem with the                                                             |
| 22          | local operator                                                                                                                                                 |
| 23          | cache of SPID                                                                                                                                                  |
| 24          | There is an error writing data to SPID's operator cache                                                                                                        |
| 25          | There is a problem with the operator's registration on the server                                                                                              |
