https://github.com/jereztech/validation-br-api
Brazilian Personal Data Validation API compatible with the Java Bean Validation API.
https://github.com/jereztech/validation-br-api
bean-validation cpf-cnpj validador-cnpj validador-conta-corrente validador-cpf validador-pispasep validador-telefone validador-titulo-eleitor validation-br-api
Last synced: 11 months ago
JSON representation
Brazilian Personal Data Validation API compatible with the Java Bean Validation API.
- Host: GitHub
- URL: https://github.com/jereztech/validation-br-api
- Owner: jereztech
- License: gpl-3.0
- Created: 2018-11-06T01:10:11.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-06-04T21:57:15.000Z (over 4 years ago)
- Last Synced: 2024-07-16T17:49:37.281Z (over 1 year ago)
- Topics: bean-validation, cpf-cnpj, validador-cnpj, validador-conta-corrente, validador-cpf, validador-pispasep, validador-telefone, validador-titulo-eleitor, validation-br-api
- Language: Java
- Size: 36.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# validation-br-api
Brazilian Personal Data Validation API compatible with the Java Bean Validation API.
[](https://search.maven.org/search?q=g:%22com.jereztech%22%20AND%20a:%22validation-br-api%22)
[](https://www.gnu.org/licenses/gpl.html)
## Overview
Some identification numbers in Brazil use check digits to guarantee the document authenticity. This API helps you to validate Brazilian Personal Data according to official regulations. Most institutions use standardized masks in these documents to improve the user experience, to facilitate programming, it's possible to validate the data with or without masks. The code is based on annotations and can be used easily.
## Example
```
@CPF
private String cpf;
@CNPJ
private String cnpj;
@CPFCNPJ // CPF or CNPJ in the same field
private String cpfCnpj;
```
## Annotation Types Summary
### AgenciaBancaria
The annotated element must contain 4 numeric characters (with leading zeros as needed) plus 1 check digit (not required); Allowed formats are '9999', '9999A' or '9999-A'.
### Celular
The annotated element must be an 11-digit number, the first 2 digits being the area code (DDD), and the remaining 9 digits referring to the subscriber number; Accepts the following formats '99900000000' or '(99) 90000-0000'. Only the area codes of the Brazilian Numbering Plan defined by ANATEL are allowed.
### CNPJ
The annotated element must be a 14-digit number, with the following formats '99999999999999' or '99.999.999/9999-99', being 8 base digits, 4 digits for the serial number and 2 digits for the check digits.
### ContaCorrente
The annotated element must contain up to 20 numeric characters plus 1 check digit (not required); The allowed formats are '99999999999999999999' or '99999999999999999999-A'. In the presence of the check digit, the use of the hyphen character (‐) is mandatory.
### CPF
The annotated element must be an 11-digit number, with the following formats '99999999999' or '999.999.999-99', being 9 base digits and 2 digits for the check digits.
### CPFCNPJ
The annotated element must match [CPF](https://github.com/jereztech/validation-br-api#cpf) or [CNPJ](https://github.com/jereztech/validation-br-api#cnpj).
### CTPS
The annotated element must contain 7 numeric characters (with leading zeros as needed).
### NISPISPASEP
The annotated element must be an 11-digit number, 10 base digits, and 1 check digit with the following formats '99999999999' or '999.99999.99-9'.
### Passaporte
The annotated element must be an alphanumeric code in the following format 'AA999999'.
### Telefone
The annotated element must match [Celular](https://github.com/jereztech/validation-br-api#celular) or [TelefoneFixo](https://github.com/jereztech/validation-br-api#telefonefixo).
### TelefoneFixo
The annotated element must be a 10-digit number, the first 2 digits being the area code (DDD), and the remaining 8 digits referring to the subscriber number; Accepts the following formats '9930000000' or '(99) 3000-0000'. Only the area codes of the Brazilian Numbering Plan defined by ANATEL are allowed.
### TituloEleitoral
The annotated element must be a 12-digit number, being 8 base digits, 2 digits for the Federal State and 2 digits for the check digits.
## The ContaCorrente Case
Because it's standard by the Central Bank of Brazil, the ContaCorrente field can contain up to 20 numeric characters. To validate specific cases, it's necessary to configure some parameters of the annotation. For example, to validate a Banco do Brasil ContaCorrente's field, is mandatory the following configuration:
```
@ContaCorrente(mod11Aliases = { @Mod11Alias(alias = 'X', regexp = "[0-9]{4,11}") })
private String contaCorrente;
```
Why? Because Banco do Brasil use an X character as part of the ContaCorrente checksum, and the max length for this field is 11.
This logic is applied to AgenciaBancaria field in the same way.
## Maven
```xml
com.jereztech
validation-br-api
1.3
```
## Gradle
```
compile 'com.jereztech:validation-br-api:1.3'
```
## FAQ
### How can I validate my Value Object coming from the front-end?
The fastest way is using the @javax.validation.Valid annotation with your Value Object. The @javax.validation.Valid annotation marks a method parameter for validation cascading (applied recursively). Constraints defined on the object and its properties are be validated when the method parameter is validated. If the validation does not succeed, an HTTP 400 Bad Request error is generated. For example:
```
@PutMapping(path = "/saveDataBr")
public ResponseEntity saveDataBr(@RequestBody @Valid DataBrVO dataBrVO) {}
```
### How can I implement my Value Object to use these annotations?
Working with legacy, an excellent choice is JAXB which allows the most used formats such as XML and JSON. Jackson API is good as well in the most modern architectures. For example:
```
public class DataBrVO {
@CPF
@NotNull //you can use another annotations from the javax.validation.constraints package
private String cpf;
@Valid //validation applied recursively
private OtherDataBrVO otherDataBrVO;
}
```
## Bugs Report
If you think you have found a bug, please file an issue in the [validation-br-api Issue Tracker](https://github.com/jereztech/validation-br-api/issues)
## License
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .