Zimbabwe Credit Check

Run a credit check for a Zimbabwean consumer. Returns credit report and score for lending and risk decisions.

Request

[GET]

{{baseURL}}/api/v1/zw/kyc/fcb

Header

Header	Type	Description
AppId	string	Create an app to get your app ID on dashboard here
Authorization	string	Private/secret key. Use <key> not Bearer <key>

Query parameter

Parameter	Type	Description	Required
id_number *	string	Zimbabwian National ID	required
dob *	string	date of birth	required
name *	string		required
surname *	string		required
gender*	string	M or F	required
marital_status*	string	M or S	required
mobile_number*	string		required

Sample response

uxzz

Response

{
    "entity": {
        "dob": "1901-01-01",
        "full_name": "JOHN DOE",
        "score": 288,
        "status": "GOOD",
        "gender": "F",
        "id_number": "12345678A90"
    }
}

Response Fields

Field	Type	Description
entity	object	Contains the credit check response data
entity.dob	string	Date of birth in YYYY-MM-DD format
entity.full_name	string	Full name of the individual
entity.score	number	Credit score value
entity.status	string	Credit status (e.g., GOOD, POOR)
entity.gender	string	Gender of the individual (M or F)
entity.id_number	string	Zimbabwean National ID Number