Query CRB for details of a kenyan citizen

Query CRB 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

CRB Request

idNumber
required
string
firstName
required
string
secondName
required
string
transactionType
required
string
reference_number
string
timestamp
required
string
Responses
200

search results matching criteria

400

bad input parameter

post/crb
Request samples
application/json
{
  • "idNumber": "1829732019321",
  • "firstName": "John",
  • "secondName": "Doe",
  • "transactionType": "CRB",
  • "reference_number": "20GY1KKB2CSC",
  • "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",
  • "CRBData": {
    },
  • "transactionDate": "2021-01-29"
}