Socrates

<p align="center"> <img src="./art/socrates.svg" alt="Socrates logo" width="480"> </p> <p align="center"> <img src="./art/carbon.svg" alt="Usage example" width="800"> </p> <p align="center"> <img alt="Badge" src="https://github.com/reducktion/socrates/actions/workflows/php.yml/badge.svg"> <img alt="Total Downloads" src="https://img.shields.io/packagist/dt/reducktion/socrates"> <img alt="Latest Version" src="https://img.shields.io/packagist/v/reducktion/socrates"> <img alt="License" src="https://img.shields.io/github/license/reducktion/socrates"> <img alt="StyleCI" src="https://github.styleci.io/repos/238900350/shield?branch=main"> <img alt="Contributors" src="https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square"> </p>

---

Introduction

I am a Citizen of the World, and my Nationality is Goodwill.

Socrates is a PHP Package that allows you to validate and retrieve personal data from National Identification Numbers. Most countries in Europe are supported as well as some North and South American ones, with the goal to support as many countries in the world as possible.

<p>Some countries also encode personal information of the citizen, such as gender or the place of birth. This package allows you to extract that information in a consistent way.</p> <p>This package can be useful for many things such as validating a user's ID for finance related applications or verifying a user's age without asking for it explicitly. We recommend you review your country's data processing and protection laws before storing any information.</p>

Ports of this package to other languages are currently in progress. Check further below for which ones are currently available.

PHP Version

<p>PHP 8.1 is the minimum required version. If you are using an older version you should pull in the 1.3.0 version of this package. We highly recommend you upgrade though!</p>

Installation

composer require reducktion/socrates

Usage

Socrates provides two methods: validateId and getCitizenDataFromId. Both receive an ID and the country code as a backed enum with the ISO 3166-2 format as the first and second parameters respectively. Simply instantiate the class and call the method you wish:

use Reducktion\Socrates\Socrates;
use Reducktion\Socrates\Constants\Country;

$socrates = new Socrates();
$socrates->validateId('14349483 0 ZV3', Country::Portugal);

validateId

This method will return true or false. In case the ID has a wrong character length an InvalidLengthException will be thrown.

if ($socrates->validateId('719102091', Country::Netherlands)) {
    echo 'Valid ID.';
} else {
    echo 'Invalid ID.';
}

getCitizenDataFromId

This method will return an instance of Citizen.<br> If the ID is invalid, an InvalidIdException will be thrown.<br> If the country does not support data extraction, an UnsupportedOperationException will be thrown.

$citizen = $socrates->getCitizenDataFromId('3860123012', Country::Estonia);

The Citizen class stores the extracted citizen data in a consistent format across all countries.<br> It exposes the getGender(), getDateOfBirth(), getAge() and getPlaceOfBirth() methods.<br><br> getGender will return an instance of the Gender enum.<br> getPlaceOfBirth will return a city or region name as a string.<br> getAge() returns the age of the citizen as an int.<br> getDateOfBirth() returns a DateTime instance.<br>

<p>Using the example above, Estonia only encodes the date of birth and gender of the citizen in their ID. So the above methods will return:</p>

echo $citizen->getGender(); // 'Gender::Male'
echo $citizen->getDateOfBirth(); // DateTime instance with the date '1986-01-23'
echo $citizen->getAge(); // (The current age as a number)
echo $citizen->getPlaceOfBirth(); // null - Estonia does not encode place of birth on its ID numbers

Supported and Unsupported Countries

Here you can see the full list of supported countries and whether they support data extraction.

Four european countries are currently unsupported: Austria 🇦🇹, Belarus 🇧🇾, Cyprus 🇨🇾 and Luxembourg 🇱🇺. A number of countries in the Americas are also unsupported. This is because we could not find a reliable source for the algorithm, if at all. Help would be appreciated to get these countries supported.

Testing

composer test

Ports

This package is also available for the following languages:

Rust<br> Java

Contributing

Did you find a problem in any of the algorithms? Do you know how to implement a country which we have missed? Are there any improvements that you think should be made to the codebase? Any help is appreciated! Take a look at our contributing guidelines.

Code of Conduct

Our CoC is based on Ruby's. Check out our code of conduct.

License

The MIT License (MIT). Please see License File for more information.

Credits

Socrates was made with 💖 by Alexandre Olival and João Cruz. We are Reducktion. We hope to make someone's life easier after all the hard work compiling, researching, reverse-engineering and agonizing over ID validation algorithms - many of which were very obscure and hard to find.

Special Thanks

A big thanks goes to these people who helped us either test with real life IDs or guide us in finding the algorithm for their countries:

• Alexandra from 🇷🇴
• Berilay from 🇹🇷
• Christian from 🇨🇭
• Domynikas from 🇱🇹
• Jeppe from 🇩🇰
• Jeremy from 🇫🇷
• Lisa from 🇬🇷
• Miguel from 🇪🇸

and Nair from 🇵🇹 for the package name.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://github.com/SLourenco"><img src="https://avatars2.githubusercontent.com/u/7704656?v=4" width="100px;" alt=""/><br />_{<b>SLourenco</b>}</a><br /><a href="https://github.com/reducktion/socrates/issues?q=author%3ASLourenco" title="Bug reports">🐛</a> <a href="https://github.com/reducktion/socrates/commits?author=SLourenco" title="Documentation">📖</a> <a href="https://github.com/reducktion/socrates/commits?author=SLourenco" title="Code">💻</a></td> <td align="center"><a href="https://www.linkedin.com/in/flavioheleno/"><img src="https://avatars0.githubusercontent.com/u/471860?v=4" width="100px;" alt=""/><br />_{<b>Flávio Heleno</b>}</a><br /><a href="https://github.com/reducktion/socrates/commits?author=flavioheleno" title="Code">💻</a> <a href="https://github.com/reducktion/socrates/commits?author=flavioheleno" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/YvesBos"><img src="https://avatars1.githubusercontent.com/u/22393924?v=4" width="100px;" alt=""/><br />_{<b>Yves Bos</b>}</a><br /><a href="https://github.com/reducktion/socrates/commits?author=YvesBos" title="Documentation">📖</a> <a href="https://github.com/reducktion/socrates/commits?author=YvesBos" title="Code">💻</a> <a href="https://github.com/reducktion/socrates/issues?q=author%3AYvesBos" title="Bug reports">🐛</a></td> <td align="center"><a href="https://github.com/bofalke"><img src="https://avatars2.githubusercontent.com/u/54977705?v=4" width="100px;" alt=""/><br />_{<b>bofalke</b>}</a><br /><a href="https://github.com/reducktion/socrates/commits?author=bofalke" title="Code">💻</a> <a href="https://github.com/reducktion/socrates/commits?author=bofalke" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/gheleri"><img src="https://avatars1.githubusercontent.com/u/1103419?v=4" width="100px;" alt=""/><br />_{<b>Rodolpho Lima</b>}</a><br /><a href="https://github.com/reducktion/socrates/commits?author=gheleri" title="Code">💻</a> <a href="https://github.com/reducktion/socrates/commits?author=gheleri" title="Documentation">📖</a></td> <td align="center"><a href="https://github.com/tiagomichaelsousa"><img src="https://avatars1.githubusercontent.com/u/28356381?v=4" width="100px;" alt=""/><br />_{<b>tiagomichaelsousa</b>}</a><br /><a href="https://github.com/reducktion/socrates/commits?author=tiagomichaelsousa" title="Code">💻</a> <a href="https://github.com/reducktion/socrates/commits?author=tiagomichaelsousa" title="Documentation">📖</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!