Liberado App Integration (Background Checks)
The Liberado App integration connects ACCELERO to the Liberado App service, a verification platform that queries a person's criminal background and court proceedings based on the CPF. With the plugin active, the query is performed directly in the person record and in the quick visit service, without needing to access the external Liberado App portal.
This integration is provided as a plugin (liberadoapp) and must be installed and enabled by IONGRADE's technical team. Contact support to check compatibility with your version of ACCELERO.
Current plugin version: 1.0.0 — compatible with ACCELERO 2.16.9 or higher.
What the integration does
With the plugin active, ACCELERO gains a Query CPF button on the person record and quick visit service screens. When clicked, the system queries the Liberado App service and displays the result in a window, with the proceedings and warrants found for that CPF.
| Feature | What happens in ACCELERO |
|---|---|
| Background query by CPF | When clicking Query CPF, ACCELERO sends the CPF to Liberado App and receives back the linked court proceedings and arrest warrants |
| Name filling | When the query returns the person's name, the Name field of the record is automatically filled with the received data |
| Storage in the record | The query result is recorded in the person's metadata, allowing later reuse (cache) |
| Query cache | Results can be reused for a configurable number of days, avoiding querying the same CPF repeatedly |
| Monthly request limit | A monthly query limit can be defined to control the service consumption |
| Log recording | Each query generates a record in the person's access log, indicating whether the data came from the service or the cache |
Allows checking background at the moment of registration or visitor entry, without leaving ACCELERO and without manually accessing the Liberado App portal.
Configuration
Navigation path: Settings > Plugins - Liberado App
The configuration screen has a single tab (General) with the connection data and the service consumption controls.
Configuration screen Plugins - Liberado App (General tab), showing the API endpoint, API Key, Monthly Request Limit, and Days to keep in cache fields.
| Field | Description |
|---|---|
| API endpoint | URL of the Liberado App service. Default value: https://integration.liberadoapp.com |
| API Key | Authentication key for the Liberado App API, obtained in the service's administrative panel |
| Monthly Request Limit | Maximum number of queries allowed per month. Use 0 for unlimited |
| Days to keep in cache | Number of days to keep the results in cache before allowing a new query of the same CPF. Use 0 to disable the cache |
The API Key is provided by the Liberado App service. Without the endpoint and the key configured correctly, the queries fail.
Screen buttons
| Button | Function |
|---|---|
| Save | Persists the configuration |
| Back | Returns to the settings list without saving |
Query button in the record
The plugin adds the Query CPF button on two screens, provided that the operator has the appropriate permission (see Permissions):
- Person Record (
People > Edit) — next to the person's general data. - Quick visit service (
eveEditQuick) — in the visitor data area.
Person record with the Query CPF button added by the plugin, next to the general data.
Quick visit service screen with the Query CPF button added by the plugin in the visitor data area.
How to use
- Fill in the CPF in the person's/visitor's document field.
- Click on Query CPF.
- The system validates the CPF (it must have 11 digits) and queries Liberado App.
- The result is displayed in the Liberado App Verification window.
The query requires a valid CPF with 11 digits. If the CPF field is empty or invalid, the system displays an error message and does not perform the query.
Results window
After the query, the Liberado App Verification window opens with the findings organized in blocks. Each block indicates the situation and, when the service provides it, a button to Download PDF of the corresponding document.
Liberado App Verification window displaying blocks of Arrest Warrants and Court Proceedings, each with the situation and (when available) the Download PDF button.
| Block | Content |
|---|---|
| Arrest Warrants | Arrest warrants linked to the queried CPF |
| Court Proceedings | Court proceedings linked to the queried CPF |
When the query does not return any item, the window displays the message "No verification available".
If the query response includes the person's name, the Name field of the record is filled with this value.
Query cache
When Days to keep in cache is greater than zero, ACCELERO reuses the last result stored for the CPF, instead of making a new call to the service.
- The query uses the cache while the number of days since the last search is less than the configured value.
- With 0 days, the cache is disabled: every query goes to the service.
- Queries served by the cache do not count against the monthly request limit and are marked in the log as originating from the cache.
A larger cache reduces request consumption but may show an older result. Adjust the days according to the criticality of the verification in your segment.
Monthly request limit
The Monthly Request Limit field controls how many queries can be made to the service in a month.
- With limit 0, queries are unlimited and consumption is not counted.
- With a limit greater than zero, each query sent to the service increments the counter for the current month.
- When the limit is reached, new queries are blocked and the system reports "Monthly request limit reached".
- The counter is reset on the first day of the following month.
Only the queries that actually go to the Liberado App service consume the limit. Results returned from the cache are not counted.
Permissions
The plugin creates the Perform LiberadoAPP searches (liberadoAppManage) permission.
- The Query CPF button only appears for operators whose profile has this permission.
- Configure the permission in the access profile of the operators who should be able to query background.
Operator profile with the Perform LiberadoAPP searches permission checked.
Use cases
Checking background when registering a person
- In
People > Edit, fill in the person's CPF. - Click on Query CPF.
- Analyze the warrants and proceedings displayed in the Liberado App Verification window.
- When available, use Download PDF to keep the query record.
Checking background at a visitor's entry
- In the quick visit service, enter the visitor's CPF.
- Click on Query CPF and assess the result before allowing entry.
Controlling service consumption
- In
Settings > Plugins - Liberado App, set the Monthly Request Limit. - Adjust Days to keep in cache to reuse recent queries of the same CPF.
Best practices
- Restrict the permission: grant Perform LiberadoAPP searches only to the operators who need to query background — the data is sensitive.
- Use cache for recurring CPFs: in environments with a lot of re-entry, a cache of a few days reduces costs and speeds up verification.
- Define a monthly limit: avoid consumption overruns by configuring the Monthly Request Limit according to the contract with the service.
- Fill in the CPF before querying: the query depends on a valid 11-digit CPF in the record.
Troubleshooting
The "Query CPF" button does not appear
Possible causes:
- The operator does not have the Perform LiberadoAPP searches permission.
- The plugin is not enabled.
Solution:
- Confirm that the operator's profile has the
liberadoAppManagepermission. - Check with IONGRADE whether the plugin is installed and active.
The query returns an error
Possible causes:
- Incorrect API endpoint or API Key.
- Liberado App service unavailable or no connectivity from the ACCELERO server.
Solution:
- Review the API endpoint and API Key fields in
Settings > Plugins - Liberado App. - Test the connectivity from the ACCELERO server to the configured endpoint.
- The service error message is displayed on the query screen itself — use it as a reference.
"Monthly request limit reached"
Cause: the number of queries for the month has reached the Monthly Request Limit value.
Solution:
- Wait for the turn of the month (the counter resets on the first day of the following month).
- If necessary, increase the limit or set 0 (unlimited) in the configuration.
Result seems outdated
Cause: the query was served by the cache, within the Days to keep in cache period.
Solution: reduce the number of cache days (or use 0 to disable it) so that new queries always go to the service.
Integration with other modules
People
The query acts on the People record: it uses the informed CPF, records the result in the person's metadata, and can fill in the Name field automatically. If the queried CPF does not yet exist as a person, the record is created with the data returned by the query.
Events (Visits)
The query button is also added to the quick service of Events, allowing you to check the visitor's background before granting access.
Logs and Monitoring
Each query generates a record in the person's access log, identifying the search action and whether the data came from the service or the cache.
Next Steps
- People — Understand the record on which the query acts
- Events — See where the query button appears in the visit service
- Logs and Monitoring — Track the record of the queries performed
- Plugins — Learn more about ACCELERO's plugin system