Decitizen

Goal

A way to validate a Kenyan using ID, First Name, and Year of birth.

Requirements

• Node or Bun

The Server

When make requests they must all be POST requests with the header:

"Content-Type: application/json"

And the payload must have the json structure as bellow:

{
"id": "12345678"
"name": "Brian"
"year": "2024"
}

• id field is ID number of the person
• name field is the persons first name
• year field is the persons year of birth
• All fields are strings

Possible Replies from the server are in the form:

{
success: boolean
message: string
}

• The message field is optional, and is not included when the request contains data of user verified.
• The message section when not empty includes information about why the info supplied might not have been valid, normally either because the json given as input was badly formated, or the user info actually isn't valid so couldn't be validated.

NOTE: Currently we get false, even if the user actually has valid info, but hasn't registered on ecitizen, as I did not get any test data from a user with an ID but hasn't yet registered on ecitizen, if this can be supplied, it could probably lead to solving this issue, but this a rare age case as in Kenya most people immediately after getting an ID register on ecitizen.

Building

• Clone This repo
• Enter the directory you cloned into

cd Decitizen

• Install the libraries

npm i

• Run (Currently server not implemented yet)

npm run server

Testing

• Make a copy of the .env.copy file and rename it to .env
• Run npm install to install the dependencies
• Inside the .env file you created you will notice 4 set group of values separated by white space.
  • The first one should be replaced with real life values that are correct.
  • Second one should have the Name(first value) with a wrong one.
    • Please note, there is a bug on ecitizen, as it checks if the real name associated with the id, and passes, eg: If you give a fake name "Brianss", but your real name is "Brian" it would pass, they might fix this bug later on.
  • Third One should have the year(date of birth) field wrong
  • Last one should have ID wrong
  • NOTE: The .env.copy file contains fake data, please replace it accordingly with the advice above.
• Run npm run test and tests should all pass.
• NOTE: Since I had no real data of any user who hasn't yet registered to eCitizen, some fails should be taken as the user hasn't created an ecitizen account as we do not yet check for that case.

Contributions.

Contributions are open and encouraged, spot any bug send an issue or just create a pull request, have any questions? You can also just post that on the issue tracker.

License

MIT License

Author

Me.