Credit Reference Bureau

Kenya · KE / Credit bureau

ke.credit.consumer

Look up an individual’s credit information in Kenya.

Endpoint

POSThttps://api.funturntish.com/v1/verifications/ke.credit.consumer

This API supports asynchronous calls. ?execution_mode=async · Integration guide

Request fields

Use JSON strings for the field values in the table; keep the quotation marks.

Field	Meaning and format	Required	Example
`first_name`string	The person’s given name, excluding the surname. Match the identity document.	Required	`"john"`
`last_name`string	The person’s surname. Match the identity document.	Required	`"doe"`
`national_id`string	The person’s Kenyan national identity card number. Digit string with a value from 1 to 2147483647.	Required	`"12345678"`
`purpose`string	The business purpose of this personal-data query. Non-empty text, at most 256 UTF-8 bytes.	Required	`"identity verification"`
`consent_reference`string	A reference to the person’s consent record. Non-empty string, at most 256 UTF-8 bytes; obtain consent first.	Required	`"CONSENT-001"`

Obtain valid consent before querying personal data.

Comparison parameters

Provide at least one match_fields value; all values matching returns match, otherwise not_match.

Field Meaning and format Required Example

Field	Meaning and format	Required	Example
`match_fields.date_of_birth`string	Date of birth to compare. YYYY-MM-DD	Optional	`"2000-01-01"`
`match_fields.full_name`string	Full name to compare. Comparison ignores case and collapses consecutive whitespace.	Optional	`"EXAMPLE NAME"`

match_fields.date_of_birthstring

Date of birth to compare.

YYYY-MM-DD

Optional

"2000-01-01"

match_fields.full_namestring

Full name to compare.

Comparison ignores case and collapses consecutive whitespace.

Optional

"EXAMPLE NAME"

Response & status

code describes the request; result describes the business outcome. HTTP 202 or status=pending means processing is not complete.

Response fields	Meaning and format
`code`integer	0: request accepted or completed; other values: error codes.
`status`string	pending / reserved: processing; completed: finished; failed: execution failed.
`request_id`string	Unique business ID of the accepted verification; use it to locate console records, logs and reconciliation.

Response fields	Meaning and format
`result`string	match: all submitted information agrees; not_match: a difference or no record was found.

Successful responses use HTTP 200; HTTP 202 means processing is pending, and asynchronous results are returned only by callback.

Error codes

Code example

Programming language

Core call snippet; copy the complete signing code to run it.

Complete signing code

JSON

Request examples

Request data (JSON)

{
  "consent_reference": "TEST-CONSENT",
  "first_name": "john",
  "last_name": "doe",
  "match_fields": {
    "date_of_birth": "2000-01-01"
  },
  "national_id": "12345678",
  "purpose": "integration test"
}

Update code

HTTP 200

Response example

{
  "code": 0,
  "request_id": "REQ_EXAMPLE",
  "result": "match",
  "status": "completed"
}

API reference