/java-egyptian-id-info-extractor

A minimal API to extract info from Egyptian ID number.

Primary LanguageJavaApache License 2.0Apache-2.0

java-egyptian-id-info-extractor

A minimal API to extract info from Egyptian ID number.

To Run It


  1. Install Maven
  2. cd into the project direcorty. then:
 ./mvnw spring-boot:run

OR Run It Using Docker

 docker build -t info-extractor .

Then

 docker run -p 8090:8080 info-extractor

API Endpoints


Extract Info From Id

  • Extracts all Info (Birthdate, Birth Governerate, Gender, Serial, Check Digit) from a given valid national ID.

Examples


  1. The following request:
curl http://localhost:8080/api/extract-info-from-id/?egyptianIDNumber=29808060103281

should result in the following response:

{
    "Birthdate": "August 6th 1998",
    "Birth Governorate": "Cairo",
    "Gender": "Female",
    "Serial": "0328",
    "Check Digit": "1"
}

References