Card Scan
Introduction
The GBS CardScan is a web application for capturing identification forms with biometric data such as fingerprints, palm prints, facial photos, signatures and textual biographical data. The application captures the form data and registers them in the GBS biometric database. It employs flexible and configurable field extraction, allowing it to operate with multiple form templates.
This manual is updated for CardScan version 1.6.2.
Access and Authentication
You must access CardScan with a browser and we recommend Google Chrome. The access URL is specific to each environment.
If necessary, contact the Griaule support team to obtain the correct URL.
Authentication is required to access the application. The credentials required by CardScan are username and password.
At the bottom of the screen there is an option to change the language to the desired one. This option is also available in settings after login.
Two-Factor Authentication (2FA)
When two-factor authentication (2FA) is enabled, the first time you log in, after entering your username and password, a QR Code will be shown that must be registered in Google Authenticator.
After successfully registering the QR Code in Google Authenticator, enter the six-digit code generated and click Submit.
You will only need to register the QR Code once. However, on each subsequent login, you will need to enter the six-digit code generated by Google Authenticator.
There is a limited number of unsuccessful login attempts that a user can make. Whenever an incorrect code is entered, an error message will be displayed:
If you reach the maximum number of unsuccessful login attempts, your account will be automatically locked.
If your account is locked, contact the system administrator.
Simultaneous Logins and Browser Registration
Only one session per user is allowed. It is not possible to log in simultaneously with the same profile more than once in the application. If a user is already connected and another access occurs using the same username and password, the user with the older session will be notified and disconnected on the next action.
Additionally, only one browser can be used at a time. When attempting to log in using a different browser, the user will be informed that it is necessary to authenticate the new browser. Authenticating a new browser will revoke access from the previous browser.
To authenticate a new browser, click Authenticate and then enter the verification code that will be sent to the email associated with the user's account.
If authentication is successful, a notification will appear in the upper right corner of the screen after login.
Reset Password
You can reset your password if you forget it.
To reset your password, on the login screen, click Forgot your password?:
Then enter the profile username and click Submit.
An email containing a verification code will be sent to the email address associated with that profile. Enter the verification code and click Submit code.
If the code is correct, you will be able to create a new password. Enter the new password twice. Make sure to meet the password requirements, they are listed below the new password field and will turn green when met. Finally, to confirm the reset, click Reset password.
User Interface
Main Screen
The main screen displays the application's main features:
The features are distributed in 3 groups: Request, List and Edit. These features can also be accessed via the navigation bar at the top of the page.
Request
This group of features is used to capture and register forms with biographical and biometric data. This operation can be performed in 3 ways: Single form, Multiple forms in a file, and Multiple forms on server.
Single Form
This operation is used to process a single.
A single form request requires 4 parameters:
Process name
An identifier (free form) for the operation.
Resolution
Scanning resolution of the image(s). For best results, the form should be scanned at the same resolution as the selected layout.
Layout
The form layout used to interpret the image. A thumbnail of the selected layout will be displayed.
Files
One or more image files containing the scanned form. If the form has multiple pages, or has front/back content, multiple images must be uploaded (one per page).
After filling in the parameters and uploading the images, the user can reorder the uploaded images to match the layout order by dragging the icons on the left side of the screen. Images can be removed by clicking the icon X:
Click Submit to send the request for processing on the server.
To check the progress of the operation, select List > Processes in the navigation bar at the top of the screen.
Multiple forms in a file
This type of operation is used to process a package containing multiple scanned forms. The package must be a single Zip file containing all scanned images.
The CardScan will process the files following the lexicographical order of their names. It is recommended to start file names with numbers to ensure a predictable processing order.
Multiple forms on server
This operation is used to process a list of files located on the server that runs the CardScan service. It will process the files following the lexicographical order of their names. It is recommended to start file names with numbers to ensure a predictable processing order. This operation is suitable for large-scale data migration, and may require administrative credentials on the server.
List
This group of features allows the user to list the profiles generated for registration when processing requests; To list submitted requests and inspect their status; And to inspect logs of operation.
Profiles
This section displays a list of existing profiles created by the system. It is possible to filter the list by process ID, profile ID, key, biographic data and/or status, allowing the location of specific profiles.
Clicking on a line in the profile listing displays its details, such as original form images and biometric images extracted from the form (fingerprints, palm prints, facial photo, signature, etc.).
On this page it is also possible to edit textual fields obtained by OCR (Optical Character Recognition), remove the profile, refresh the listing and reprocess the profile data.
Editing OCR fields:
On the profile details page the user can edit textual fields such as biographic data, keys and labels (labels). To do this, click Edit:
After clicking Edit, the profile fields can be edited manually by the user. The fields can be Keys, Biographics and Labels. When OCR is unable to extract Biographics, Keys or Labels information from the scanned image, they must be entered manually using this option.
The displayed fields are those configured by the system administrator. If you have the necessary permissions, you will be able to view and modify these fields in the GBS BCC application. For more information, consult the Fields section in the GBS BCC manual.
After editing the fields, click Save changes to confirm the changes. If the user wants to cancel the changes, click Cancel. To clear the fields, click Clear fields.
Some fields may be mandatory, indicated by the message "This field is required". If a mandatory field is left blank, the user will not be able to submit the profile to GBDS.
Manual review:
When using the request type Multiple forms on server, depending on your environment configuration, profiles may require manual review if the ID number read by OCR is not included in a range indicated in the server folder name.
For example, if the folder name is cartoes_1000_2000 and this feature is enabled in your environment, the system will check whether the ID number read by OCR is between 1000 and 2000. Those that are not within this range will receive the status Pending manual review and will await manual review.
When opening a profile that requires manual review, the user will see the profile screen with the fields in an editable state. The user must then review the scanned document, edit or enter the necessary information and click Save.
Some information, such as identification keys, can be checked against the ABIS database to ensure they are unique. If the key is already in the database, it will be displayed as invalid.
Sending the profile to GBDS:
If the form was processed without errors, the button Send to GBDS will be enabled, allowing the user to send the profile for registration in the GBS biometric database.
Some biographic fields may be mandatory. If a mandatory field is left blank, the user will not be able to send the profile to GBDS. To proceed, click Edit and fill in the mandatory fields.
Once sent to GBDS, the OCR fields can no longer be changed.
Profile Status:
All profiles have a status indicating their current situation. The profile status is normally associated with the process status.
When a process has the status Processing, the profiles associated with it may have the following statuses:
Generated
Profile created.
Segmenting
Segmentation in progress.
Validation
Validation in progress.
Segmentation Error
Error in the segmentation process.
Segmentation OK
Segmentation was successfully performed, waiting for the user to send the profile to GBDS.
When processing is completed, the profile status may take other values:
Pending manual review
The ID read by OCR is not in the expected range. Manual review is required.
Manual review done
Manual review completed, waiting for the user to send the profile to GBDS.
Deleted
Profile deleted before being sent to GBDS.
Reprocessed
The profile layout was edited and the profile was reprocessed with the new layout.
Validation
Validation in progress.
Segmentation Error
Error in the segmentation process.
Ready for GBDS
Ready to be sent to GBDS.
Sending to GBDS
Sending to GBDS.
Sent to GBDS
Sending to GBDS completed.
OK in GBDS
Registration successfully completed in GBDS, can transition to OK.
OK
Registration completed in GBDS and profile flow completed in CardScan - this is a final state.
Error
Error processing the profile.
GBDS Failure
Failure in registration in GBDS.
Rejected in GBDS
Profile was rejected by GBDS.
Under review (MIR)
Waiting manual quality review in the GBS MIR.
Approved (MIR)
Approved in quality review in the GBS MIR, can transition to OK.
Rejected (MIR)
Rejected in quality review in the GBS MIR.
Under review (ETR)
Registration generated an exception, awaiting resolution in the GBS ETR.
Same biometrics (ETR)
Resolution in GBS ETR: same biometrics found (fraud in registration operation).
Different biometrics (ETR)
Resolution in GBS ETR: different biometrics (fraud in update operation).
Recollect (ETR)
Resolution in GBS ETR: recollection required.
Approved (ETR)
Resolution in GBS ETR: approved, can transition to OK.
Processes
The processes section displays a list of existing processes and their details. The list can be filtered by date, username, process ID and/or status.
Clicking on a line in the process list opens a page with process details and options to reload information, view associated profiles and process logs:
Process Status:
Every process has a status indicating its current situation, which may take the following values:
Received
Process received and created.
Validating
The process is being validated.
Detecting layout
Detecting the layout automatically.
Layout not detected
Error: system could not detect the layout.
Layout detected
Layout detection completed successfully.
Ready for segmentation
Ready to be segmented. Waiting user validation.
Processing
Processing profiles.
Profiles generated
Profiles successfully generated, user can send them to GBDS.
Processed
Processing completed.
Error
Process error.
Operation Logs
The operation logs section displays a list of existing logs and their details.
This list does not offer a detailed view of each log entry, unlike the other lists.
Edit
This group of features allows the user to edit application settings, as well as layouts.
Settings
This section allows the user to change general application settings:
It is possible to change the application theme from dark to light, the language, the date/time format and the search type. These settings only affect the user interface, not the form processing operations.
Layouts
This section displays a list of existing layouts and allows the user to edit, clone and/or remove them. Note that a layout can only be edited or removed if there are no processes associated with it.
Clicking on a layout in the list will open a page showing the layout with its fields highlighted:
Layouts
A layout is a representation of a specific biometric form model. Each distinct form model must have a corresponding layout in the system.
In the following example we can see the fingerprints (blurred in this manual for anonymization) and a person's biographic data:
To create a corresponding layout, the user needs to specify the regions of the image where biometric and biographic data are present.
Creating a new layout
To create a new layout, click New Layout:
The layout creation screen will be displayed:
Import file or Acquire Image
The first step in creating the layout is to import an image file to serve as a base:
Resolution
An important step is specifying the resolution of the imported image (given in dots per inch, dpi abbreviated). The resolution can be indicated manually in the right sidebar:
The user can also click Adjust resolution in the toolbar on the left:
Choose the desired unit of measurement and inform the distance that will be marked on the image:
In this example, the first step (1) indicates 5 cm as the distance that will be marked on the image. The second step (2) is marking the distance on the image. After steps 1 and 2, the application will report the calculated resolution (3). In this example, 354 dpi.
The minimum allowed resolution is 300 dpi.
The following information can be added to the layout:
Name
An identifier (free form) for the layout.
Description
Layout description (e.g.: "forms from the state of Roraima, 1985-1993")
Language
The language in which the form data are written.
Create region
Next, the user must specify one or more regions of the image that contain biometric or biographic data.
In the toolbar, click Extract region:
Click and drag the mouse over the image to define a rectangle, and then use the right sidebar to fill in its details:
It is possible to adjust the region's position and size. On this screen, the user can also change the following settings:
Angle:
No rotation: no change to the created region
Rotate 90° clockwise: rotates the region by this angle
Rotate 90° counterclockwise: rotates the region by this angle
Flip: 180° rotation
Type:
Fingerprint: fingerprint
Palmar: palm print
Signature: signature
Key: for fields that will be keys (values that cannot repeat for different people). Keys will be stored in the GBS database.
Biographic: for fields with a person's biographic data. This information will be stored in the GBS database.
Label: for fields that will be treated as labels. Labels will be stored in the GBS database.
Subtype for Fingerprints:
Single Fingerprint: for regions with a single fingerprint.
Two Thumbs: for regions with two thumbs.
Two Fingerprints: for regions with two fingerprints.
Four Fingerprints: for regions with four fingerprints.
Fingerprints:
This option depends on the subtype above, and indicates which finger or fingers are present in the region.
Subtype for Palms:
Left interdigital
Left thenar
Left hypothenar
Right interdigital
Right thenar
Right hypothenar
Left full
Left writing
Right full
Right writing
Subtype for Face:
Frontal face
Left mugshot
Right mugshot
Subtype for Key:
OCR Key: The field will be interpreted by OCR (optical character recognition).
Barcode Key: The field will be interpreted as a barcode.
Fields for Keys:
Lists the fields registered on the GBS server for the
Key:
Key fields Examples of key fields: passport number, driver's license number, voter registration number.
Subtype for Biographic:
Biographic OCR: The field will be interpreted by OCR (optical character recognition).
Biographic Barcode: The field will be interpreted as a barcode.
Biographic fields:
Lists the fields registered on the GBS server for the
Biographic:
Biographic fields Examples of biographic fields: name, date of birth, mother's name, father's name.
Subtype for Label:
Label OCR: The field will be interpreted by OCR (optical character recognition).
Label Barcode: The field will be interpreted as a barcode.
Label Fields:
Lists the fields registered on the GBS server for the
Label:
Label fields Labels can be used to group and filter people in GBS search operations.
When the region creation is completed, the image will have the associated regions as in the image below:
To adjust any created region, click on it. Its details will be highlighted in the sidebar and the options list will be displayed:
Last updated
Was this helpful?