1
0
Fork 0
tincheck/README.md

66 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2025-02-13 19:30:59 +00:00
# Tax identifier Generator and Validator (tin-validator.eu)
This project provides a TIN validation and generation tool hosted at https://tin-validator.eu.
## Screenshots
![tin-validator.eu](docs/tin-validator.eu.png)
## Features
- Tax identifier generation for most European countries
- Tax identifier validation for most European countries
## API Reference
#### Validate TIN identifier
```http
POST /validate
```
| Parameter | Type | Description |
| :-------- | :------- | :------------------------- |
| `country` | `string` | **Required**. The ISO country code |
| `value` | `string` | **Required**. The identifier |
#### Generate TIN identifier
```http
POST /generate
```
| Parameter | Type | Description |
| :-------- | :------- | :-------------------------------- |
| `country` | `string` | **Required**. The ISO country code |
| `dateOfBirth` | `string` | **Required**. Date of birth formatted as *yyyy-mm-dd* |
| `gender` | `string` | **Required**. The gender (m/f) |
## Run Locally
Clone the project
```bash
git clone https://code.devsoap.com/john/tin-validator
```
Go to the project directory
```bash
cd tin-validator
```
Start the server
```bash
./gradlew run
```
The server will be running on http://localhost:8080
## License
[CC BY-ND 4.0.](https://creativecommons.org/licenses/by-nd/4.0/)