Create NIRA Identity Retrieval Request ​

Creates a request to query the NIRA database using a NIN to provide an official confirmation of the customer's identity records. This is an asynchronous operation — submit the request, then poll the Get Result endpoint until requestStatus is Completed or Failed.

Retrieved Information:

• Surname
• Given Names
• Date of Birth
• Living Status
• Gender

Endpoints ​

Request ​

Request Type: POST ​

Authorization ​

All requests must be authenticated using OAuth 2.0 Client Credentials. Follow the steps in the Authentication section to obtain an access token.

Request Body ​

Example Request ​

curl --request POST \
  --url 'https://api.streamline.laboremus.ug/idv/api/records?v=2.0' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "nin": "CM83046701HJKL",
    "externalReference": "my-ref-12345"
  }'

curl --request POST \
  --url 'https://api.streamline.laboremus.ug/idv/api/records?v=2.0' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "nin": "CM83046701HJKL",
    "externalReference": "my-ref-12345"
  }'

Example Request Body ​

{
  "nin": "CM930121003EGE",
  "externalReference": "my-ref-12345"
}

{
  "nin": "CM930121003EGE",
  "externalReference": "my-ref-12345"
}

Response ​

A successful request returns a 202 Accepted status. The request is queued for processing.

Response Fields ​

Example Response ​

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestUri": "/api/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "Pending"
}

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "requestUri": "/api/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "Pending"
}

Error Response ​

errors ​

Error ​

Error ​

Error ​

Error ​