Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seisigmasrl/dgii-rnc-validator
A simple package to check a given RNC with the official Tax Authority, Dirección General de Impuestos Internos (DGII), in the Dominican Republic.
https://github.com/seisigmasrl/dgii-rnc-validator
php rnc validator
Last synced: 17 days ago
JSON representation
A simple package to check a given RNC with the official Tax Authority, Dirección General de Impuestos Internos (DGII), in the Dominican Republic.
- Host: GitHub
- URL: https://github.com/seisigmasrl/dgii-rnc-validator
- Owner: seisigmasrl
- License: mit
- Created: 2023-01-20T01:49:09.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T13:44:39.000Z (8 months ago)
- Last Synced: 2024-05-01T15:40:44.421Z (8 months ago)
- Topics: php, rnc, validator
- Language: PHP
- Homepage:
- Size: 77.1 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Validate any RNC with the DGII
[](https://packagist.org/packages/seisigmasrl/dgii-rnc-validator)
[](https://github.com/seisigmasrl/dgii-rnc-validator/actions/workflows/run-tests.yml)
[](https://packagist.org/packages/seisigmasrl/dgii-rnc-validator)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fseisigmasrl%2Fdgii-rnc-validator?ref=badge_shield)
A simple package to check a given RNC with the official Tax Authority, Dirección General de Impuestos Internos (DGII), in the Dominican Republic and few more options.
## Installation
You can install the package via composer:
```bash
composer require seisigmasrl/dgii-rnc-validator
```
## Usage
This package aims to bring you a simple way to check and validate if a given RNC is valid and its current status with the tax authorities.
Most existing solutions are based on parsing a monthly shared file with all the existing RNC by the Dirección General de Impuestos Internos (DGII), the official Tax Authority in the Dominican Republic.
This approach is excellent for improving performance, but It's not optimal for services requiring life, trusted information. For this reason, the current package provides a simple API to:
- Validate RNC's
- Verify if the Given RNC it's valid.
But how? There's 'somewhere' 😅, a "real" public non-documented endpoint used by the Tax Authorities that provide a set of tools to validate information with the DGII. This endpoint provides several options, but we will only use the RNC Validation for the scope of this package.
Here's the list of the provided methods by this package:
### Check
Validate if a given RNC is valid and returns the details of the Taxpayer but false if not valid.
__How to use it:__
```php
require Seisigma\DgiiRncValidator\DgiiRncValidator;
...
// 132620951 is a valid RNC
$validatedRnc = DgiiRncValidator::check("132620951");
var_dump($validatedRnc);
// array(4) {
// ["rnc"]=> string(9) "132620951"
// ["name"]=> string(29) "KOI CORPORATION BY SAIKOV SRL"
// ["commercial_name"]=> string(25) "KOI CORPORATION BY SAIKOV"
// ["status"]=> string(6) "Active"
// }
// 123456789 is an invalid RNC
$validatedRnc = DgiiRncValidator::check("123456789");
var_dump($validatedRnc); // bool(false)
```
### validateRNC
Validate if a given string is a valid RNC.
__How to use it:__
```php
require Seisigma\DgiiRncValidator\DgiiRncValidator;
...
// 132620951 is a valid RNC
$validatedRnc = DgiiRncValidator::validateRNC("132620951");
var_dump($validatedRnc); // bool(true)
// 123456789 is an invalid RNC
$validatedRnc = DgiiRncValidator::validateRNC("123456789");
var_dump($validatedRnc); // bool(false)
```
### rncType
Validate if a given string is a valid RNC.
__How to use it:__
```php
require Seisigma\DgiiRncValidator\DgiiRncValidator;
...
// 132620951 is a valid RNC
$rncType = DgiiRncValidator::rncType("132620951");
var_dump($rncType); // enum(Types::RNC)
// 123456789 is an invalid RNC
$rncType = DgiiRncValidator::rncType("04800009577");
var_dump($rncType); // enum(Types::CEDULA)
```
The Type enum includes two functions:
- `toString`: Return the string value from the returned enum.
Ex:
```php
var_dump(Types::RNC->toString()) // string(RNC)
```
- `toCode`: Return the DGII type code value from the returned enum.
Ex:
```php
var_dump(Types::RNC->toCode()) // string(01)
```
## Helper Functions
Just in case you need a few extra tools, here's a list of utility functions:
### getNumbers
This function returns all numbers from any provided string.
__How to use it:__
```php
require Seisigma\DgiiRncValidator\helpers\Utils;
...
$results = Utils::getNumbers("abc123456");
var_dump($results); // string(6) "123456"
$results = Utils::getNumbers("asdfasdfs");
var_dump($results); // bool(false)
```
### luhnAlgorithmValidation
This function validates if the given sequence of digits has a valid key (checksum).
__How to use it:__
```php
require Seisigma\DgiiRncValidator\helpers\Utils;
...
$result = Utils::luhnAlgorithmValidation("79927398713");
var_dump($result); // bool(true)
$result = Utils::luhnAlgorithmValidation("79927398715");
var_dump($result); // bool(false)
```
### validateDominicanCitizenId
This function validates if the given sequence of digits is a valid Dominican Citizen Id.
__How to use it:__
```php
require Seisigma\DgiiRncValidator\helpers\Utils;
...
$result = Utils::validateDominicanCitizenId("04800009575");
var_dump($result); // bool(true)
$result = Utils::validateDominicanCitizenId("04800009577");
var_dump($result); // bool(false)
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Ricardo A. Vargas R.](https://github.com/ricardov03)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fseisigmasrl%2Fdgii-rnc-validator?ref=badge_large)