BrDocuments 1.0.1

dotnet add package BrDocuments --version 1.0.1
                    
NuGet\Install-Package BrDocuments -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BrDocuments" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BrDocuments" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="BrDocuments" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add BrDocuments --version 1.0.1
                    
#r "nuget: BrDocuments, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package BrDocuments@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=BrDocuments&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=BrDocuments&version=1.0.1
                    
Install as a Cake Tool

BrDocuments

CI NuGet License: MIT

BrDocuments is a fast, zero-dependency .NET library for validating, formatting, and generating Brazilian documents — CPF, CNPJ (including the new alphanumeric format), CEP, PIS/PASEP, CNH, Título de Eleitor, RENAVAM, and Inscrição Estadual.

It targets .NET 10 and .NET Standard 2.0, so it runs on modern .NET as well as older .NET Framework and Xamarin/Unity projects.

Why BrDocuments?

  • Zero dependencies — nothing else gets pulled into your app.
  • 🔤 Alphanumeric CNPJ ready — supports the new format issued from July 2026 (Nota Técnica COCAD/SUARA/RFB nº 49/2024), which most libraries still don't.
  • 🧱 Tiny, consistent API — every document is a static class with the same four methods.
  • 🧪 Well tested & benchmarked — xUnit test suite plus BenchmarkDotNet benchmarks.
  • 🛡️ Safe by defaultIsValid never throws; it returns false for null, empty, or malformed input.

Installation

dotnet add package BrDocuments

Quick start

using BrDocuments;

// Validation accepts formatted or unformatted input
Cpf.IsValid("529.982.247-25");   // true
Cpf.IsValid("52998224725");      // true

// Formatting and stripping
Cpf.Format("52998224725");       // "529.982.247-25"
Cpf.Unformat("529.982.247-25");  // "52998224725"

// Generation (valid, random, unformatted)
string cpf = Cpf.Generate();     // e.g. "97987556343"

// The new alphanumeric CNPJ just works
Cnpj.IsValid("12.ABC.345/01DE-35");   // true
Cnpj.Format("12ABC34501DE35");        // "12.ABC.345/01DE-35"

// Inscrição Estadual is validated per state (UF)
InscricaoEstadual.IsValid("314611116426", "SP");

API

Every document (except InscricaoEstadual) exposes the same static surface:

bool   IsValid(string? value);   // accepts formatted or unformatted; never throws
string Format(string value);     // applies the canonical mask
string Unformat(string value);   // strips formatting
string Generate();               // returns a valid, random, unformatted document

InscricaoEstadual is state-specific and exposes:

bool IsValid(string? value, string? state);          // state = "SP", "RJ", ...
IReadOnlyCollection<string> SupportedStates;          // implemented UFs

Supported documents

Document Class Format Generate Notes
CPF Cpf XXX.XXX.XXX-DD Módulo 11, two check digits
CNPJ Cnpj XX.XXX.XXX/XXXX-DD Numeric + new alphanumeric format
CEP Cep XXXXX-DDD Structural validation (no check digit)
PIS/PASEP Pis XXX.XXXXX.XX-D Módulo 11
CNH Cnh XXXXXXXXXXX Two-step Módulo 11
Título de Eleitor TituloEleitor XXXX XXXX XXXX State-aware check digits (UF 01–28)
RENAVAM Renavam XXXXXXXXXXX Accepts 9 digits (zero-padded to 11)
Inscrição Estadual InscricaoEstadual per state SP, RJ, MG, RS, PR, SC, BA, PE, CE, GO

Alphanumeric CNPJ

From July 2026 the Receita Federal issues CNPJs whose 12-character body may contain letters A–Z in addition to digits; the two trailing check digits remain numeric. BrDocuments validates both the legacy numeric format and the new alphanumeric one with the same Cnpj.IsValid call:

Cnpj.IsValid("04.252.011/0001-10");   // legacy numeric  -> true
Cnpj.IsValid("12.ABC.345/01DE-35");   // alphanumeric    -> true

Cnpj.Generate() produces numeric CNPJs only.

Inscrição Estadual coverage

Version 1.0 implements the ten most commonly required states: SP, RJ, MG, RS, PR, SC, BA, PE, CE, GO. Any other UF currently returns false (see InscricaoEstadual.SupportedStates). Contributions adding the remaining states are very welcome.

Targets

  • net10.0
  • netstandard2.0

Building & testing

dotnet build -c Release
dotnet test -c Release
dotnet run -c Release --project benchmarks/BrDocuments.Benchmarks

Contributing

Issues and pull requests are welcome — especially additional Inscrição Estadual state algorithms (each one should ship with tests). Please keep the library dependency-free and make sure dotnet build is warning-free and dotnet test is green before opening a PR.

License

MIT

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.
  • net10.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.1 121 6/30/2026
1.0.0 115 6/30/2026