360 Evaluation Engine

AgSME360

POST https://credit.farmsky.africa/api/v1/agsme360/agrismes

Score an agri-SME: Combined CRB 30% · Cash Flow 35% · Audited Accounts 35% → 1000 pts.

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

business_verification object required

Registration number + business name.

directors array required

Directors with national IDs and names.

financial_data object required

Statement + audited-accounts file ids.

API Request Examples

curl --request POST \
  --url https://credit.farmsky.africa/api/v1/agsme360/agrismes \
  --header 'Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}' \
  --header 'x-api-key: {API_KEY}' \
  --header 'Content-Type: application/json' \
  --data '{"business_verification":{"business_registration_number":"PVT-XYZ12345","business_name":"Green Agri Ltd"},"directors":[{"national_id":"31234567","first_name":"Grace","last_name":"Mwangi"}],"financial_data":{"statement_type":"bank","statement_file_id":"file_abc123","audited_accounts_file_ids":["file_aud1","file_aud2"]}}'

const res = await fetch('https://credit.farmsky.africa/api/v1/agsme360/agrismes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {CLIENT_ID}:{CLIENT_SECRET}',
    'x-api-key': '{API_KEY}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "business_verification": {
      "business_registration_number": "PVT-XYZ12345",
      "business_name": "Green Agri Ltd"
    },
    "directors": [
      {
        "national_id": "31234567",
        "first_name": "Grace",
        "last_name": "Mwangi"
      }
    ],
    "financial_data": {
      "statement_type": "bank",
      "statement_file_id": "file_abc123",
      "audited_accounts_file_ids": [
        "file_aud1",
        "file_aud2"
      ]
    }
  }),
});
const data = await res.json();
console.log(data);

import requests

url = "https://credit.farmsky.africa/api/v1/agsme360/agrismes"
headers = {
    "Authorization": "Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key": "{API_KEY}",
    "Content-Type": "application/json",
}
payload = {
    "business_verification": {
        "business_registration_number": "PVT-XYZ12345",
        "business_name": "Green Agri Ltd"
    },
    "directors": [
        {
            "national_id": "31234567",
            "first_name": "Grace",
            "last_name": "Mwangi"
        }
    ],
    "financial_data": {
        "statement_type": "bank",
        "statement_file_id": "file_abc123",
        "audited_accounts_file_ids": [
            "file_aud1",
            "file_aud2"
        ]
    }
}
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/api/v1/agsme360/agrismes",
  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([
  "business_verification" => [
    "business_registration_number" => "PVT-XYZ12345",
    "business_name" => "Green Agri Ltd"
  ],
  "directors" => [
    [
      "national_id" => "31234567",
      "first_name" => "Grace",
      "last_name" => "Mwangi"
    ]
  ],
  "financial_data" => [
    "statement_type" => "bank",
    "statement_file_id" => "file_abc123",
    "audited_accounts_file_ids" => [
      "file_aud1",
      "file_aud2"
    ]
  ]
]),
]);

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

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

HttpClient client = HttpClient.newHttpClient();
String payload = "{\"business_verification\":{\"business_registration_number\":\"PVT-XYZ12345\",\"business_name\":\"Green Agri Ltd\"},\"directors\":[{\"national_id\":\"31234567\",\"first_name\":\"Grace\",\"last_name\":\"Mwangi\"}],\"financial_data\":{\"statement_type\":\"bank\",\"statement_file_id\":\"file_abc123\",\"audited_accounts_file_ids\":[\"file_aud1\",\"file_aud2\"]}}";
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://credit.farmsky.africa/api/v1/agsme360/agrismes"))
    .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(`{"business_verification":{"business_registration_number":"PVT-XYZ12345","business_name":"Green Agri Ltd"},"directors":[{"national_id":"31234567","first_name":"Grace","last_name":"Mwangi"}],"financial_data":{"statement_type":"bank","statement_file_id":"file_abc123","audited_accounts_file_ids":["file_aud1","file_aud2"]}}`)
	req, _ := http.NewRequest("POST", "https://credit.farmsky.africa/api/v1/agsme360/agrismes", 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_1000": 688,
    "band": "GOOD",
    "score_breakdown": {
      "crb": 195,
      "cash_flow": 250,
      "audited_accounts": 243
    }
  }
}

{
  "error": "VERIFICATION_FAILED",
  "message": "Business could not be verified."
}

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