| Purpose | Connect, configure, monitor, and troubleshoot the Brazil Police Report (FNRH) integration. |
| Best for | Front Desk teams and PMS Administrators at properties in Brazil. |
| Use this when | You need to connect the integration, understand when guest data syncs, monitor FNRH submissions, or resolve a validation error. |
| Requirements | FNRH API credentials, staff CPF information, and the required Marketplace access. |
| Expected result | Checked-in guest data is sent automatically to FNRH, and validation errors can be identified and corrected from Integration Sync. |
Introduction
FNRH (Ficha Nacional de Registro de Hóspedes) is the mandatory guest registration platform for the Brazilian government. The Brazil Police Report integration sends guest registration data from Cloudbeds PMS to FNRH so properties can meet the applicable reporting requirements.
This article focuses on the technical setup and day-to-day operation of the integration. For the legal requirements and broader FNRH background, see Brazil Police Report (FNRH) - Everything you need to know.
Use the sections below to prepare the required credentials, connect the app, understand the synchronization flow, and resolve failed FNRH submissions.
Table of contents
- Who this affects and how
- Before you start
- Connect the app
- Configure the app settings
- How the synchronization works
- Required guest information for FNRH synchronization
- Monitor FNRH synchronization
- Resolve FNRH validation errors
- Frequently Asked Questions
Who this affects and how
The integration involves both setup responsibilities and guest-level data entry. Use the role guidance below to focus on the parts of the workflow that apply to you.
| Role | What to know |
|---|---|
| Front Desk | Complete the required FNRH information for every guest and use Resolve FNRH validation errors when a reservation does not sync successfully. |
| PMS Administrator | Prepare API credentials and staff CPFs, connect the app, configure the integration, and review synchronization issues when needed. |
Before you start
Before connecting the Brazil Police Report app, prepare the government credentials and staff information required by FNRH. Completing these prerequisites first prevents setup from stopping midway.
-
Obtain your FNRH API credentials: Retrieve the unique access keys from the Brazilian government portal.
-
Go to the official Gov.br SSO portal and click Entrar com gov.br.
-
Log in using your CPF and password to proceed to the FNRH dashboard.
-
Once logged in, navigate to the Chave das API's module on the main dashboard.
-
Locate and copy your Usuário (Username) and Chave (Key). You will need both values when you configure the app.
-
- Gather staff CPFs: Collect the CPF (Cadastro de Pessoas Físicas) for all Cloudbeds users who perform guest check-ins. FNRH requires an individual identifier (cpf_solicitante) for every record, so each Cloudbeds user must be mapped to their CPF in the app settings.
Properties in Organizations: Organization Owners cannot download this app from the Marketplace. Use a property-level user with Marketplace permissions to connect the app.
Do not have an FNRH account yet? If your establishment is not yet registered with the Ministry of Tourism, register your property before generating API keys.
Connect the app
Connect the Brazil Police Report app from Cloudbeds Marketplace after you have the required FNRH credentials and a property-level user with the necessary Marketplace permissions.
- From the Account Menu
, click Apps & Marketplace
- Search for Brazil, using a z even if your PMS language is set to Portuguese, and click Learn More for Brazil Police Report.
Application name: In Cloudbeds Marketplace, the integration may appear as Brazil Police Report. This is the global technical name of the module and refers to submissions to the Ministry of Tourism's FNRH Digital platform under MTur Ordinance No. 41/2025.
The Marketplace search result shows the Brazil Police Report app before you open its details.
- Click Connect App.
- Click Allow Access to grant the requested permissions.
- After allowing access, you will be redirected to Connected Apps. Click App page for Brazil Police Report.
- Click Settings.
Configure the app settings
Use the Brazil Police Report settings page to enter the FNRH credentials and map Cloudbeds users to the CPF values required for FNRH submissions.
- FNRH API Credentials: Enter the Username and API Key you retrieved from the FNRH portal.
-
User Mapping:
- Requester CPF: Enter the CPF for each Cloudbeds user listed. FNRH requires the individual identifier of the person performing the check-in for every sync.
- Default CPF: Provide a fallback CPF. This value is used if a check-in is triggered by a system action or a user who has not been individually mapped.
- Click Submit to save your credentials and user mapping.
There is no success pop-up after clicking Submit. Your settings are saved immediately.
The settings page contains the FNRH credentials and user-mapping fields required to activate the integration.
You are connected. The integration will automatically sync data for checked-in guests when the required guest information is complete.
How the synchronization works
Brazil Police Report sends guest data automatically after the integration is configured. Synchronization is tied to guest stay milestones and reservation changes rather than to reservation creation alone.
- Check-in: When a guest is checked in, the reservation and all associated guest data are sent to FNRH in a single request.
- Check-out: When a guest checks out, the FNRH record is updated to finalize the stay.
- Modifications: If guest details are updated after check-in but before check-out, or if new guests are assigned to a checked-in reservation, the changes are automatically synced.
Validation rule: Required information must be complete for every guest in the reservation. If one guest is missing required information, the reservation sync fails.
Required guest information for FNRH synchronization
FNRH validates required guest information before accepting a reservation sync. Complete the required fields for every guest to prevent reservation-level validation failures.
| Guest information | Requirement |
|---|---|
| Full name | Required for each guest. |
| Date of birth | Required for each guest. The integration first uses the guest registration form data on the reservation and can fall back to the birth date stored in the guest profile. |
| Document number and document type | Both values must be present because FNRH validates them together. |
| Nationality | Required for each guest. |
| Travel reason and mode of transportation | Required and collected through the guest registration form. |
Gender, race, and disability are optional for this integration. If these fields are left blank, they default to not informed in the FNRH submission.
Monitor FNRH synchronization
Use Integration Sync in Cloudbeds PMS to confirm whether FNRH submissions completed successfully and to identify records that need attention.
- From the Account Menu
, go to Utilities
, then open Integration Sync.
- Review the Brazil Police Report records and their statuses:
- Completed: The guest data was successfully sent to FNRH.
- Open with Error: The sync has not completed. Select Show more to see the validation message and the field that needs attention.
The Integration Sync page shows the status and error details for each Brazil Police Report submission.
Resolve FNRH validation errors
A failed FNRH sync remains in Open status until the required guest information is corrected. The error details identify the field that prevented the reservation from syncing, such as a missing date of birth or document value.
- From the Account Menu
, go to Utilities
, then open Integration Sync.
- Find the failed Brazil Police Report record and select Show more to identify the missing or invalid field.
In the example below, the expanded error identifies data_nascimento, which means the guest's date of birth is missing or requires correction.
- Open the affected reservation and complete the required information for every guest. Use the required guest information table as a checklist.
- Save the updated guest or reservation information.
- Return to Integration Sync and confirm that the error clears after the integration retries the submission.
No re-check-in is required. When reservation details change after the missing information is corrected, the integration retries automatically. The property does not need to check the guest in again or contact Cloudbeds Support just to trigger another sync attempt.
Frequently Asked Questions
Expand the questions below for additional behavior and setup details that may apply to your property.
Does this integration sync reservations as soon as they are created?
No. Brazil Police Report does not sync a reservation when it is created. Synchronization begins when the guest is checked in. Confirmed or Pending reservations are not sent to FNRH until check-in occurs.
What happens if a guest does not have a CPF?
The Brazil Guest Information template supports both domestic and international guests. Brazilian citizens must provide a CPF, while international guests may provide passport details. Make sure the Brazil template is active so the correct required fields are collected based on the guest's nationality.
How do I fix an FNRH sync error?
Use Resolve FNRH validation errors to identify the missing field in Integration Sync, correct the affected guest information, and confirm the automatic retry clears the error.
How can I disconnect the Brazil Police Report app?
Disconnect Brazil Police Report the same way as other Marketplace apps. Follow Marketplace - How to disconnect an app from Cloudbeds PMS. If you reconnect the app later, you will need to enter the Brazil Police Report configuration details again.
Related articles
Now that you can connect, monitor, and troubleshoot the Brazil Police Report integration, use these resources for broader FNRH requirements and general Integration Sync guidance:
Comments
Please sign in to leave a comment.