Guides & Tutorials
Jenga API
KYC
ID Search & Validation

IMT Mobile Wallets

Test URL

POSThttps://uat.finserve.africa/v3-apis/v3.0/validate/identity

Live URL

POSThttps://api.finserve.africa/v3-apis/v3.0/validate/identity

This web service enables your application to query the various registrar of persons in the various countries in East Africa. Currently available for Kenya and Rwanda only.

200 Success Response Schema

Field NameField TypeField Description
statusstringResponse status
codenumberResponse code
messagestringResponse message
data.identityobjectidentity objec
identity.customerobjectcustomer object
customer.fullNamestringfull name
customer.firstNamestringfirst name
customer.lastNamestringlast name
customer.shortNamestringshort name
customer.birthDatestringbirth date
customer.birthCityNamestringbirth city name
customer.deathDatestringdeath date
customer.genderstringgender
customer.faceImagestringface image
customer.occupationstringoccupation
customer.nationalitystringnationality
documentTypestringidentity document type
documentNumberstringidentity document number
identity.documentSerialNumberstringidentity document serial number
documentExpirationDatestringidentity document expiration date
documentIssuingLocationstringidentity document issuing location
documentIssueDatestringidentity document issuing date
issuedBystringidentity document issuing authorit
identity.additionalIdentityDetailsarrayadditional identity documents array
additionalIdentityDetails.documentNumberstringidentity document number
additionalIdentityDetails.documentTypestringidentity document type
additionalIdentityDetails.issuedBystringidentity document issuing authority
identity.addressobjectaddress
address.provinceNamestringprovince name
address.districtNamestringdistrict name
address.locationNamestringlocation name
address.subLocationNamestringsub-location name
address.villageNamestringvillage name

Example Request

⚠️

In the example below, please remember to replace the variables enclosed within curly brackets {{ }} with the actual values.

Signature Formula
countryCode+documentNumber
Example Request
curl -X POST \
	-d '{
            "identity": {
                "documentType": "ALIENID",
                "firstName": "John",
                "lastName": "Doe",
                "dateOfBirth": "1970-01-30",
                "documentNumber": "123456",
                "countryCode": "KE"
            }
        }'  \
	-H 'Authorization: Bearer {{token}}'  \
	-H 'signature: Bearer {{signature}}'  \
	-H 'Content-Type: application/json'  \
	-L 'https://uat.finserve.africa/v3-apis/v3.0/validate/identity'

Example Response

Example Response
{
    "status": true,
    "code": 0,
    "message": "success",
    "data": {
        "identity": {
            "customer": {
                "firstName": "JOHN",
                "lastName": "DOE",
                "occupation": "",
                "gender": "M",
                "nationality": "Kenyan",
                "deathDate": "",
                "fullName": "JOHN JOHN DOE DOE",
                "middlename": "JOHN DOE",
                "ShortName": "JOHN",
                "birthCityName": "",
                "birthDate": "1985-06-20T12:00:00",
                "faceImage": ""
            },
            "documentType": "NATIONAL ID",
            "documentNumber": "555555",
            "documentSerialNumber": "55555555555",
            "documentIssueDate": "2011-12-08T12:00:00",
            "documentExpirationDate": "",
            "IssuedBy": "REPUBLIC OF KENYA",
            "additionalIdentityDetails": [
                {
                    "documentType": "",
                    "documentNumber": "",
                    "issuedBy": ""
                }
            ],
            "address": {
                "locationName": "",
                "districtName": "",
                "subLocationName": "",
                "provinceName": "",
                "villageName": ""
            }
        }
    }
}