👤Basic Identity - Uganda

The API allows to verify Ugandan users NIN and Card Number against NIRA datasource.

POST <server>/api/uga_verify_nin

The request must include at least one of the optional fields - date of birth or surname or given_names or other_names

Headers

Name	Type	Description
Authorization*	String	Bearer <token>

Request Body

Name	Type	Description
document_id*	String	NIN Card number
national_id*	String	NIN number
dob	String	Date of Birth in DD/MM/YYYY
surname	String
given_names	String
other_names	String

200: OK A valid NIN card with all matching details

// Some code
{
    "status":"ok",
    "verification":{
      "matching_status":true,
      "card_staus":"valid"
    }    
}

200: OK A card with matching details but Not Valid card

{
    "status":"ok",
    "verification":{
      "matching_status":true,
      "card_staus":"Not valid"
    }    
}

200: OK Details queried doesn't match

{
    "status":"ok",
    "verification":{
      "matching_status":false,
    }    
}

200: OK NIN not found

{
    "status":"error",
    "error":{
      "message":"Person not found, NIN: <NIN number>"
    }    
}