POST
/id-decision
This path returns the information relating to customer and active loans
Field Description Mandatory/Optional
  • name1
  • name2
  • name3
  • name4
Customer Names
Optional
  • nationalID
  • passportNo
  • serviceID
  • alienID
  • taxID
Identification Documents, National Id, Passport, Military Id, Alien Registration Card, KRA PIN
Minimum of one identity document is required
requestReference
The alphanumeric[A-Z][a-z][0-9] reference generated by the merchant to identify the transaction
Mandatory
vid
The vendor ID of the merchant, ie merchant who will be using this API
Mandatory
hash
The hash of the posted data, to verify that this is from the vendor.
Mandatory
reportReason
Reason Request is being made
Code Description
i- Account Opening
2- Loan Application
3- Monitoring Credit
4- Verification
5- Overdraft
6- Credit Cards
7- Business Working Capital Loans
8- Business Expansion Loans
9- Mortgage Loans
10- Asset Finance Loans
11- Trade Finance Facilities
12- Mobile Banking Loan
Mandatory
postalTown
Postal Town
Optional
postalCountry
Postal Country
Optional
telephoneWork
Office Telephone
Optional
telephoneHome
Home Telephone
Optional
telephoneMobile
Mobile Phone
Optional
physicalAddress
Physical Address
Optional
physicalTown
Physical Town
Optional
physicalTown
Physical Town
Optional
physicalCountry
Postal Country
Optional

On successful posting the API should return the following response

                    {
                        "header_status": 200,
                        "text": "Product request processed successfully",
                        "requestReference": "TC01120200628",
                        "profile": {
                            "crn": "11000969",
                            "dateOfBirth": "1977-09-18T00:00:00+03:00",
                            "fullName": "DOE JOHN BARUA",
                            "gender": "M",
                            "nationalID": "30959390",
                            "nationality": "KENYA",
                            "otherNames": "JOHN BARUA",
                            "salutation": "MR",
                            "surname": "DOE"
                        },
                        "summary": {
                            "creditActive": "true"
                        }
                    }				 
                    
POST
/generic-score
This path returns the information relating to customer and active loans
Field Description Mandatory/Optional
  • name1
  • name2
  • name3
  • name4
Customer Names
Minimum of two names is required
  • nationalID
  • passportNo
  • serviceID
  • alienID
  • taxID
Identification Documents, National Id, Passport, Military Id, Alien Registration Card, KRA PIN
Minimum of one identity document is required
requestReference
The alphanumeric[A-Z][a-z][0-9] reference generated by the merchant to identify the transaction
Mandatory
vid
The vendor ID of the merchant, ie merchant who will be using this API
Mandatory
hash
The hash of the posted data, to verify that this is from the vendor.
Mandatory
reportSector
Sector of reporting
Code Description
i- My Sector
2- All Sectors
Mandatory
reportReason
Reason Request is being made
Code Description
i- Account Opening
2- Loan Application
3- Monitoring Credit
4- Verification
5- Overdraft
6- Credit Cards
7- Business Working Capital Loans
8- Business Expansion Loans
9- Mortgage Loans
10- Asset Finance Loans
11- Trade Finance Facilities
12- Mobile Banking Loan
Mandatory
postalTown
Postal Town
Optional
postalCountry
Postal Country
Optional
telephoneWork
Office Telephone
Optional
telephoneHome
Home Telephone
Optional
telephoneMobile
Mobile Phone
Optional
physicalAddress
Physical Address
Optional
physicalTown
Physical Town
Optional
physicalTown
Physical Town
Optional
physicalCountry
Postal Country
Optional

On successful posting the API should return the following response

                    {
                        "header_status": 200,
                        "text": "Product request processed successfully",
                        "requestReference": "TC00720200614",
                        "profile": {
                            "crn": "11000969",
                            "dateOfBirth": "1977-09-18T00:00:00+03:00",
                            "fullName": "DOE JOHN BARUA",
                            "nationalID": "30959390",
                            "otherNames": "JOHN BARUA",
                            "salutation": "MR",
                            "surname": "DOE"
                        },
                        "summary": {
                            "creditHistory": {
                                "mySector": "0",
                                "otherSectors": "68"
                            },
                            "npaAccounts": {
                                "mySector": "0",
                                "otherSectors": "1"
                            },
                            "paAccounts": {
                                "mySector": "0",
                                "otherSectors": "4"
                            },
                            "paAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paClosedAccounts": {
                                "mySector": "0",
                                "otherSectors": "1"
                            },
                            "paClosedAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paOpenAccounts": {
                                "mySector": "0",
                                "otherSectors": "3"
                            },
                            "paOpenAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            }
                        },
                        "account_list": [
                            {
                                "accountStatus": "DEFAULT",
                                "arrearAmount": "470831.9"
                            },
                            {
                                "accountStatus": "ACTIVE",
                                "arrearAmount": "0.0"
                            },
                            {
                                "accountStatus": "CLOSED",
                                "arrearAmount": "0.0"
                            },
                            {
                                "accountStatus": "ACTIVE",
                                "arrearAmount": "0.0"
                            },
                            {
                                "accountStatus": "ACTIVE",
                                "arrearAmount": "0.0"
                            }
                        ],
                        "phone_list": [
                            {
                                "phoneNo": "254721596565",
                                "phoneType": "HOME"
                            },
                            {
                                "phoneNo": "254722605410",
                                "phoneType": "MOBILE"
                            },
                            {
                                "phoneNo": "254722764242",
                                "phoneType": "MOBILE"
                            },
                            {
                                "phoneNo": "254721922783",
                                "phoneType": "MOBILE"
                            }
                        ],
                        "score": {
                            "grade": "CC",
                            "positiveScore": "679",
                            "probability": "7.76",
                            "reasonCodeAARC1": "Borrowed a lot on loans other than secured loans, those with regular payments or those where balances do not have to be paid every month",
                            "reasonCodeAARC2": "Many loan applications in the recent past (for non mobile loans)",
                            "reasonCodeAARC3": "High number of open, longterm  loans where the balance does not have to be paid every month compared  to other loans",
                            "reasonCodeAARC4": "Many unpaid installments or no loans that have regular monthly installments"
                        }
                    }
                    
POST
/mobile-loan-score
This path returns the information relating to customer and active loans
Field Description Mandatory/Optional
  • name1
  • name2
  • name3
  • name4
Customer Names
Minimum of two names is required
  • nationalID
  • passportNo
  • serviceID
  • alienID
  • taxID
Identification Documents, National Id, Passport, Military Id, Alien Registration Card, KRA PIN
Minimum of one identity document is required
requestReference
The alphanumeric[A-Z][a-z][0-9] reference generated by the merchant to identify the transaction
Mandatory
vid
The vendor ID of the merchant, ie merchant who will be using this API
Mandatory
hash
The hash of the posted data, to verify that this is from the vendor.
Mandatory
reportSector
Sector of reporting
Code Description
i- My Sector
2- All Sectors
Mandatory
reportReason
Reason Request is being made
Code Description
i- Account Opening
2- Loan Application
3- Monitoring Credit
4- Verification
5- Overdraft
6- Credit Cards
7- Business Working Capital Loans
8- Business Expansion Loans
9- Mortgage Loans
10- Asset Finance Loans
11- Trade Finance Facilities
12- Mobile Banking Loan
Mandatory
postalTown
Postal Town
Optional
postalCountry
Postal Country
Optional
telephoneWork
Office Telephone
Optional
telephoneHome
Home Telephone
Optional
telephoneMobile
Mobile Phone
Optional
physicalAddress
Physical Address
Optional
physicalTown
Physical Town
Optional
physicalTown
Physical Town
Optional
physicalCountry
Postal Country
Optional

On successful posting the API should return the following response

                    {
                        "header_status": 200,
                        "text": "Product request processed successfully",
                        "requestReference": "TC00920200625",
                        "profile": {
                            "crn": "11000969",
                            "dateOfBirth": "1977-09-18T00:00:00+03:00",
                            "fullName": "DOE JOHN BARUA",
                            "nationalID": "30959390",
                            "otherNames": "JOHN BARUA",
                            "salutation": "MR",
                            "surname": "DOE"
                        },
                        "summary": {
                            "avgMobiLoanPrincipalAmount": {
                                "mySector": "0.0",
                                "otherSectors": "11000.0"
                            },
                            "creditHistory": {
                                "mySector": "0",
                                "otherSectors": "69"
                            },
                            "lastMobiLoanPrincipalAmount": {
                                "mySector": "0.0",
                                "otherSectors": "11000.0"
                            },
                            "lastMobileLoanListingDate": {
                                "otherSectors": "2018-03-14T00:31:39+03:00"
                            },
                            "maxMobiLoanPrincipalAmount": {
                                "mySector": "0.0",
                                "otherSectors": "11000.0"
                            },
                            "minMobiLoanPrincipalAmount": {
                                "mySector": "0.0",
                                "otherSectors": "11000.0"
                            },
                            "mobiLoanAccounts": {
                                "mySector": "1",
                                "otherSectors": "0"
                            },
                            "npaAccounts": {
                                "mySector": "0",
                                "otherSectors": "1"
                            },
                            "npaClosedAccounts": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "npaClosedMobiLoanAccounts": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "npaOpenAccounts": {
                                "mySector": "0",
                                "otherSectors": "1"
                            },
                            "npaOpenMobiLoanAccounts": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paAccounts": {
                                "mySector": "0",
                                "otherSectors": "4"
                            },
                            "paAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paClosedAccounts": {
                                "mySector": "0",
                                "otherSectors": "1"
                            },
                            "paClosedAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paClosedMobiLoanAccounts": {
                                "mySector": "1",
                                "otherSectors": "0"
                            },
                            "paClosedMobiLoanAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paOpenAccounts": {
                                "mySector": "0",
                                "otherSectors": "3"
                            },
                            "paOpenAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paOpenMobiLoanAccounts": {
                                "mySector": "0",
                                "otherSectors": "0"
                            },
                            "paOpenMobiLoanAccountsWithDh": {
                                "mySector": "0",
                                "otherSectors": "0"
                            }
                        },
                        "account_list": [
                            {
                                "accountStatus": "ACTIVE"
                            },
                            {
                                "accountStatus": "DEFAULT"
                            },
                            {
                                "accountStatus": "ACTIVE"
                            },
                            {
                                "accountStatus": "CLOSED"
                            },
                            {
                                "accountStatus": "ACTIVE"
                            }
                        ],
                        "phone_list": [
                            {
                                "createDate": "2019-09-15T10:54:00+03:00",
                                "phoneNo": "254721596565",
                                "phoneType": "HOME"
                            },
                            {
                                "createDate": "2019-09-15T10:54:00+03:00",
                                "phoneNo": "254722605410",
                                "phoneType": "MOBILE"
                            },
                            {
                                "createDate": "2018-03-14T00:32:00+03:00",
                                "phoneNo": "254722764242",
                                "phoneType": "MOBILE"
                            },
                            {
                                "createDate": "2017-03-17T02:43:00+03:00",
                                "phoneNo": "254721922783",
                                "phoneType": "MOBILE"
                            }
                        ],
                        "score": {
                            "grade": "BB",
                            "mobiLoansScore": "663",
                            "probability": "13.54",
                            "reasonCodeAARC1": "Low number of payments recently",
                            "reasonCodeAARC2": "Satisfactory accounts are relatively old",
                            "reasonCodeAARC3": "Recent delinquency on accounts",
                            "reasonCodeAARC4": "Average credit limit of Revolving accounts are relatively low"
                        }
                    }