Uganda National ID Boolean Match
Overview
The Uganda National ID Boolean Match Verification accepts the National ID Number, document Id, country code, given names, surname, date of birth, and verification type from the customer and returns detailed information when the details are matched with the database. This article will guide you on how to integrate to this service.
Important!
Before you proceed, ensure you review the prerequisites for integrating into our APIs for a more detailed guide.
API Endpoint
https://api.verified.africa/sfx-verify/v3/id-service/
Headers
Our service accepts headers for authentication. See below the headers to pass to the API
| Header | Type | Description |
|---|---|---|
| userid | String | This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userid |
| apiKey | String | This is your api key retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey |
Request
| Request Parameter | Description | Description | Test Data |
|---|---|---|---|
| searchParameter | Required | The NIN will be passed into this field | CA000000000SFX |
| documentId | Required | The documentId is the same as the card number will be passed into this field. | 000092564 |
| countryCode | Required | The Country code will be passed into this field. | UG |
| verificationType | Required | This field is used to identify the service being called. Ensure to use the value provided exactly as provided. | UG-ID-VERIFICATION-BOOLEAN-MATCH |
| firstNames | Optional | The given names will be passed into this field. | Mark |
| lastName | Required | The surname will be passed into this field. | Nyakana |
| Dob | Optional | The date of birth will be passed into this field. | 01/01/1993 |
{
"firstName": "Mark",
"lastName": "Nyakana",
"documentId": "000092564",
"countryCode": "UG",
"otherNames": "",
"verificationType": "UG-ID-VERIFICATION-BOOLEAN-MATCH",
"searchParameter": "CA000000000SFX",
"dob": "01/01/1993"
}
Response
| Response Parameter | Type | Description |
|---|---|---|
| responseCode | String | Please reference Response Codes page for details on all possible responses |
| description | String | This is a description of the response received. |
| verificationType | String | The same verificationType passed in request will be returned here |
| verificationStatus | String | This field lets you know if the identity verification was successful. Options are: VERIFIED: This means that the Uganda NIN is valid. NOT VERIFIED This means that the Uganda NIN is invalid PENDING This status means that the verification could not be completed. Refer to the responseCode for the specific failure reason |
| transactionStatus | String | This indicates the wallet debit status. The options are SUCCESSFUL or FAILED. |
| transactionReference | String | If you supplied a transactionReference, the same will be returned here. Else, we would generate a reference and return that to you in this field. |
| transactionDate | String | Date the transaction was done |
| searchParameter | String | Uganda NIN used for the verification |
| response | Json | This is a JSON containing all the actual response as retrieved from the service provider. |
{
"responseCode": "00",
"description": "Successful",
"verificationType": "UG-ID-VERIFICATION-BOOLEAN-MATCH",
"verificationStatus": "VERIFIED",
"transactionStatus": "SUCCESSFUL",
"transactionReference": "1630321373727-LHHIFKCD",
"transactionDate": "1683711631223",
"searchParameter": "CA000000000SFX",
"callBackUrl": null,
"livenessScore": 0.0,
"paymentRef": null,
"response": {
"matchingStatus": true
},
"faceMatch": null
}
Updated about 1 year ago
What’s Next