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 Name	Field Type	Field Description
`status`	`string`	Response status
`code`	`number`	Response code
`message`	`string`	Response message
`data.identity`	`object`	identity objec
`identity.customer`	`object`	customer object
`customer.fullName`	`string`	full name
`customer.firstName`	`string`	first name
`customer.lastName`	`string`	last name
`customer.shortName`	`string`	short name
`customer.birthDate`	`string`	birth date
`customer.birthCityName`	`string`	birth city name
`customer.deathDate`	`string`	death date
`customer.gender`	`string`	gender
`customer.faceImage`	`string`	face image
`customer.occupation`	`string`	occupation
`customer.nationality`	`string`	nationality
`documentType`	`string`	identity document type
`documentNumber`	`string`	identity document number
`identity.documentSerialNumber`	`string`	identity document serial number
`documentExpirationDate`	`string`	identity document expiration date
`documentIssuingLocation`	`string`	identity document issuing location
`documentIssueDate`	`string`	identity document issuing date
`issuedBy`	`string`	identity document issuing authorit
`identity.additionalIdentityDetails`	`array`	additional identity documents array
`additionalIdentityDetails.documentNumber`	`string`	identity document number
`additionalIdentityDetails.documentType`	`string`	identity document type
`additionalIdentityDetails.issuedBy`	`string`	identity document issuing authority
`identity.address`	`object`	address
`address.provinceName`	`string`	province name
`address.districtName`	`string`	district name
`address.locationName`	`string`	location name
`address.subLocationName`	`string`	sub-location name
`address.villageName`	`string`	village 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

{
    "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": ""
            }
        }
    }
}

Get Forex Rates Validate Payment