National ID Verification API (NIV) ​

Introduction ​

This API provides a simple interface for developers to verify Ugandan National IDs. It communicates with the National Identification and Registration Authority (NIRA) API, influencing the endpoints and request/response times.

To process as many ID verification requests as possible, we use a queuing system. Upon receiving a request, an immediate response is generated with a unique identifier for the request, which can be used later to check the status of the request.

1. Send a request to the ID Verification endpoint to receive a unique identifier for the request.
2. Use the unique identifier to get the status of the request details by calling the ‘Get request status’ endpoint.

Versions ​

API Version	Description
1	Performs verifications of Uganda National IDs
2	Enhancement to facilitate multiple given name checks and perform validations

Version Summary ​

Changes added to API Version 2

• otherNames field must be added to the Request body

Sequence diagram ​

Business use case ​