Credit & Bureau

Composite Credit Decision

POST https://credit.farmsky.africa/v3/credit/evaluations

Run a full composite credit decision (300–850) with an explainable breakdown.

Blends identity, bureau, statement and agronomic signals into a single explainable decision. Returns the score, band, decision and a per-factor contribution breakdown.

credit:write

Headers

Authorization string required Defaults to Bearer {CLIENT_ID}:{CLIENT_SECRET}

Your API client id and secret, joined by a colon. Manage credentials in the Console.

x-api-key string optional Defaults to {API_KEY}

Alternative single-value secret key header (equivalent to X-Api-Secret). Never expose it in client-side code.

Content-Type string required Defaults to application/json

All request bodies are JSON unless the endpoint accepts multipart/form-data (file uploads).

Body Params

applicant_type string required

INDIVIDUAL_FARMER | AGRI_SME.

lender_reference string

Your own reference for reconciliation.

applicant object required

Applicant identity + consent token.

loan_application object required

Requested amount, tenor and purpose.

API Request Examples

curl --request POST \
  --url https://credit.farmsky.africa/v3/credit/evaluations \
  --header 'Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}' \
  --header 'x-api-key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{"applicant_type":"INDIVIDUAL_FARMER","lender_reference":"LN-2026-000123","applicant":{"national_id":"31234567","phone":"+254712345678","consent_token":"cst_9a…"},"farm":{"gps":{"lat":-0.2827,"lon":36.0662},"crop":"MAIZE","acreage_ha":1.4,"planting_date":"2026-03-14"},"loan_application":{"amount_kes":45000,"tenor_months":6,"purpose":"INPUTS"}}'

const res = await fetch('https://credit.farmsky.africa/v3/credit/evaluations', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {CLIENT_ID}:{CLIENT_SECRET}',
    'x-api-key': '{API_KEY}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "applicant_type": "INDIVIDUAL_FARMER",
    "lender_reference": "LN-2026-000123",
    "applicant": {
      "national_id": "31234567",
      "phone": "+254712345678",
      "consent_token": "cst_9a…"
    },
    "farm": {
      "gps": {
        "lat": -0.2827,
        "lon": 36.0662
      },
      "crop": "MAIZE",
      "acreage_ha": 1.4,
      "planting_date": "2026-03-14"
    },
    "loan_application": {
      "amount_kes": 45000,
      "tenor_months": 6,
      "purpose": "INPUTS"
    }
  }),
});
const data = await res.json();
console.log(data);

import requests

url = "https://credit.farmsky.africa/v3/credit/evaluations"
headers = {
    "Authorization": "Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key": "{API_KEY}",
    "Content-Type": "application/json",
}
payload = {
    "applicant_type": "INDIVIDUAL_FARMER",
    "lender_reference": "LN-2026-000123",
    "applicant": {
        "national_id": "31234567",
        "phone": "+254712345678",
        "consent_token": "cst_9a…"
    },
    "farm": {
        "gps": {
            "lat": -0.2827,
            "lon": 36.0662
        },
        "crop": "MAIZE",
        "acreage_ha": 1.4,
        "planting_date": "2026-03-14"
    },
    "loan_application": {
        "amount_kes": 45000,
        "tenor_months": 6,
        "purpose": "INPUTS"
    }
}
resp = requests.post(url, headers=headers, json=payload)
print(resp.json())

<?php
$ch = curl_init();
curl_setopt_array($ch, [
  CURLOPT_URL => "https://credit.farmsky.africa/v3/credit/evaluations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key: {API_KEY}",
    "Content-Type: application/json",
  ],
  CURLOPT_POSTFIELDS => json_encode([
  "applicant_type" => "INDIVIDUAL_FARMER",
  "lender_reference" => "LN-2026-000123",
  "applicant" => [
    "national_id" => "31234567",
    "phone" => "+254712345678",
    "consent_token" => "cst_9a…"
  ],
  "farm" => [
    "gps" => [
      "lat" => -0.2827,
      "lon" => 36.0662
    ],
    "crop" => "MAIZE",
    "acreage_ha" => 1.4,
    "planting_date" => "2026-03-14"
  ],
  "loan_application" => [
    "amount_kes" => 45000,
    "tenor_months" => 6,
    "purpose" => "INPUTS"
  ]
]),
]);

$response = curl_exec($ch);
curl_close($ch);
echo $response;

import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
String payload = "{\"applicant_type\":\"INDIVIDUAL_FARMER\",\"lender_reference\":\"LN-2026-000123\",\"applicant\":{\"national_id\":\"31234567\",\"phone\":\"+254712345678\",\"consent_token\":\"cst_9a…\"},\"farm\":{\"gps\":{\"lat\":-0.2827,\"lon\":36.0662},\"crop\":\"MAIZE\",\"acreage_ha\":1.4,\"planting_date\":\"2026-03-14\"},\"loan_application\":{\"amount_kes\":45000,\"tenor_months\":6,\"purpose\":\"INPUTS\"}}";
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://credit.farmsky.africa/v3/credit/evaluations"))
    .header("Authorization", "Bearer {CLIENT_ID}:{CLIENT_SECRET}")
    .header("x-api-key", "{API_KEY}")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString(payload))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{"applicant_type":"INDIVIDUAL_FARMER","lender_reference":"LN-2026-000123","applicant":{"national_id":"31234567","phone":"+254712345678","consent_token":"cst_9a…"},"farm":{"gps":{"lat":-0.2827,"lon":36.0662},"crop":"MAIZE","acreage_ha":1.4,"planting_date":"2026-03-14"},"loan_application":{"amount_kes":45000,"tenor_months":6,"purpose":"INPUTS"}}`)
	req, _ := http.NewRequest("POST", "https://credit.farmsky.africa/v3/credit/evaluations", payload)
	req.Header.Add("Authorization", "Bearer {CLIENT_ID}:{CLIENT_SECRET}")
	req.Header.Add("x-api-key", "{API_KEY}")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

RESPONSE

{
  "request_id": "req_8f2c1a9b7d3e4f60",
  "ok": true,
  "data": {
    "score": 726,
    "band": "GOOD",
    "decision": "APPROVE",
    "limit_kes": 52000,
    "breakdown": {
      "identity": 0.18,
      "bureau": 0.27,
      "cashflow": 0.31,
      "agronomy": 0.24
    }
  }
}

{
  "error": "invalid_request",
  "message": "applicant and loan_application are required"
}

{
  "error": "unauthorized",
  "message": "API credentials required. Send Authorization: Bearer <client_id>:<secret>."
}