Statement Analysis

Upload Statement (PDF)

POST https://credit.farmsky.africa/v3/statements/upload

Upload a PDF statement for authenticity scoring + transaction extraction.

statements: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).

Content-Type string required Defaults to multipart/form-data

This endpoint accepts a file upload, not JSON.

Body Params multipart/form-data

statementfilerequired

The statement document to analyse (PDF or CSV).

API Request Examples

curl --request POST \
  --url https://credit.farmsky.africa/v3/statements/upload \
  --header 'Authorization: Bearer {CLIENT_ID}:{CLIENT_SECRET}' \
  --header 'x-api-key: {API_KEY}' \
  --form 'statement=@/path/to/statement.pdf' \
  --form 'statement_type=mpesa'

import { readFileSync } from 'node:fs';

const form = new FormData();
form.append('statement', new Blob([readFileSync('./statement.pdf')]), 'statement.pdf');
form.append('statement_type', 'mpesa');

const res = await fetch('https://credit.farmsky.africa/v3/statements/upload', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer {CLIENT_ID}:{CLIENT_SECRET}',
    'x-api-key': '{API_KEY}',
  },
  body: form,
});
const data = await res.json();
console.log(data);

import requests

url = "https://credit.farmsky.africa/v3/statements/upload"
headers = {
    "Authorization": "Bearer {CLIENT_ID}:{CLIENT_SECRET}",
    "x-api-key": "{API_KEY}",
}
files = {"statement": open("statement.pdf", "rb")}
data = {"statement_type": "mpesa"}
resp = requests.post(url, headers=headers, files=files, data=data)
print(resp.json())

<?php
$ch = curl_init();
curl_setopt_array($ch, [
  CURLOPT_URL => "https://credit.farmsky.africa/v3/statements/upload",
  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([]),
]);

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

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

HttpClient client = HttpClient.newHttpClient();
String payload = "{}";
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://credit.farmsky.africa/v3/statements/upload"))
    .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(`{}`)
	req, _ := http.NewRequest("POST", "https://credit.farmsky.africa/v3/statements/upload", 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": {
    "authenticity_confidence": 0.98,
    "tamper_flags": [],
    "transactions_extracted": 342
  }
}

{
  "error": "invalid_request",
  "message": "file is required (multipart/form-data)"
}

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