IPRS - Kenya

# Introduction

This is a modern, integrated population registration database in Kenya. From the database, you can be able to verify the following:

Identity Details (ID Number, Names, etc)
KRA Pin
Phone Number
NHIF Number
NSSF Number
Driving License etc

The capabilities are still in development but what's available right now is:

Identity Verification
KRA Pin Verification

# Request Parameters

The following parameters are expected:

Field	Description	Type
search_type	The IPRS Search type you want to do. Examples: `identity`, `kra`, `identity-kra`	String
identifier	This is the search parameter. E.g. ID Number	String

Please find sample implementation on the left

# Response Parameters

Below is a sample response

# Identity Search

'search_type' is identity and identifier is the client's ID Number

Search details on a customer's identity using their ID Number. As sample response is as follows:

{
  "code": "200.001",
  "data": {
    "signature": null, //If available, the image is formatted in bytes
    "fingerprint": null, //If available, the image is formatted in bytes
    "photo": null, //If available, the image is formatted in bytes
    "id_number": "12345678",
    "surname": "Surname",
    "first_name": "FirstName",
    "other_name": "OtherName   ",
    "gender": "F",
    "date_of_birth": "1990-01-29T00:00:00",
    "citizenship": "Kenyan",
    "clan": "",
    "ethnic_group": "",
    "family": "",
    "serial_number": "123456789",
    "place_of_birth": "Nairobi",
    "place_of_live": "SOME PRIMARY SCHOOL"
  }
}

Identity Check Fields

Field	Description	Type
code	response field	String
message	Description for the call results especially during a failure	String
data	Object with the call results	String
data.photo	Client's photo	Bytes
data.signature	Client's signature	Bytes
data.fingerprint	Client's fingerprint	Bytes
data.id_number	Client's ID number	String
data.surname	Client's surname	String
data.first_name	Client's first name	String
data.other_name	Client's other name	String
data.gender	Client's gender	String
data.date_of_birth	Client's date of birth	String
data.citizenship	Client's citizenship e.g. Kenyan	String
data.clan	Client's tribal clan	String
data.ethnic_group	Client's ethnic group	String
data.family	Client's family name	String
data.serial_number	Client's ID dard serial number	String
data.place_of_birth	Client's place of birth	String
data.place_of_live	Client's place of residence	String

Table on Fields

# KRA Pin Verification

'search_type' is kra and identifier is the client's KRA PIN

Verify a customer's KRA Pin Number. A sample response is as follows:

{
  "id_number": "17302047",
  "krapin": "A003922990S"
}

KRA Pin Verification Fields

Field	Description	Type
code	response field	String
message	Description for the call results especially during a failure	String
data	Object with the call results	String
data.id_number	Client's ID Number	String
data.krapin	Client's KRA Pin	String

# Identity and KRA Pin Consolidated

'search_type' is conso and identifier is the client's ID Number

Search details on a customer's identity using their ID Number and have the KRA PIN included

A sample response is as follows:

{
  "signature": null, //If available, the image is formatted in bytes
  "fingerprint": null, //If available, the image is formatted in bytes
  "photo": null, //If available, the image is formatted in bytes
  "id_number": "12345678",
  "surname": "Surname",
  "first_name": "FirstName",
  "other_name": "OtherName   ",
  "gender": "F",
  "date_of_birth": "1990-01-29T00:00:00",
  "citizenship": "Kenyan",
  "clan": "",
  "ethnic_group": "",
  "family": "",
  "serial_number": "123456789",
  "place_of_birth": "Nairobi",
  "place_of_live": "SOME PRIMARY SCHOOL",
  "krapin": "A001744194D"
}

Identity and KRA Pin Consolidated Fields

Field	Description	Type
code	response field	String
message	Description for the call results especially during a failure	String
data	Object with the call results	String
data.photo	Client's photo	Bytes
data.signature	Client's signature	Bytes
data.fingerprint	Client's fingerprint	Bytes
data.id_number	Client's ID Number	String
data.surname	Client's surname	String
data.first_name	Client's first name	String
data.other_name	Client's other name	String
data.gender	Client's gender	String
data.date_of_birth	Client's date of birth	String
data.citizenship	Client's citizenship e.g. Kenyan	String
data.clan	Client's tribal clan	String
data.ethnic_group	Client's ethnic group	String
data.family	Client's family name	String
data.serial_number	Client's ID Card serial number	String
data.place_of_birth	Client's place of birth	String
data.place_of_live	Client's place of residence	String
data.krapin	Client's KRA Pin	String

← Authorization Metropol →