Skip to main content

Brazil

Brazil is the current real-world context behind the data generated by Mocaí today.

Although the public API is organized around entities such as Person, Address, CPF, and National ID, the concrete data currently implemented in the library is centered on Brazilian Portuguese and Brazilian documents.

Why This Page Exists​

The main documentation should remain entity-oriented because that matches how developers use the API:

  • NewPerson()
  • NewAddress()
  • NewCompany()
  • NewCPF()
  • NewNationalID()
  • NewVoteRegistration()
  • NewCertificate()
  • NewPhone()

At the same time, it is useful to have a country-level page that explains the broader context of the generated data. That is the role of this page.

Current Brazil-Specific Coverage​

At the moment, Mocaí supports Brazilian data for:

  • person names
  • gender values
  • addresses
  • phone numbers
  • companies
  • CPF
  • civil certificates
  • national identity card (RG)
  • voter registration

Locale​

The currently implemented language is:

  • ptbr

This means the project is already language-aware, but the generated content and document models are presently Brazilian.

Brazil-Oriented Entity Pages​

If you want entity-level detail, use these pages:

Important Notes About The Current Model​

  • CPF, RG, voter registration, and civil certificates are Brazil-specific documents.
  • Company currently exposes a BrazilianCompany payload.
  • NationalID currently exposes a BrazilianRG payload.
  • VoteRegistration currently exposes a BrazilianVoteRegistration payload.
  • Certificate currently exposes a Brazil payload containing Brazilian certificate variants.

These names are a good signal that the codebase is already prepared for broader geographic coverage later, even though only Brazil is currently implemented.

When A Country-First Structure Will Make More Sense​

Right now, the best primary navigation is still entity-first because the API is entity-first.

A more country-centered documentation structure will make stronger sense once the project has:

  • more than one implemented country
  • country-specific documents for each locale
  • materially different data models between locales
  • examples and workflows that differ significantly by country

Until then, the most balanced approach is:

  • entity pages as the main reference
  • country pages like this one as contextual guides

Practical Reading Path​

If you are working with Brazilian scenarios, a good path is:

  1. Get started
  2. Supported entities
  3. This Brazil page
  4. The specific entity page you need for your test scenario