Query IPRS for details of a kenyan citizen

Query IPRS for details of a kenyan citizen

Request
header Parameters
x-app-id
required
string

pass the project id

x-api-key
required
string

api-key

Request Body schema: application/json

IPRS Query Request

idNumber
required
string
transactionType
required
string
timestamp
required
string
Responses
200

search results matching criteria

400

bad input parameter

post/iprs
Request samples
application/json
{
  • "idNumber": "1829732019321",
  • "transactionType": "IPRS",
  • "timestamp": "2021-01-29T00:54:08+03:00"
}
Response samples
application/json
{
  • "responseCode": "00",
  • "responseMessage": "Request processed successfully",
  • "transactionReference": "FT120GY1KKB2",
  • "referenceNumber": "20GY1KKB2CSWL",
  • "transactionValueDate": "2021-01-29",
  • "transactionDate": "2021-01-29",
  • "dateOfBirth": "00",
  • "dateOfDeath": "00",
  • "dateOfIssue": "00",
  • "ethnicGroup": "00",
  • "family": "00",
  • "fingerprint": "00",
  • "firstName": "00",
  • "gender": "00",
  • "iDNumber": "00",
  • "occupation": "00",
  • "otherName": "00",
  • "photo": "00",
  • "pin": "00",
  • "placeOfBirth": "00",
  • "placeOfDeath": "00",
  • "placeOfLive": "00",
  • "regOffice": "00",
  • "serialNumber": "00",
  • "signature": "00",
  • "surname": "00"
}