Our APIs
Three core API groups — Customer Operations, Statement & Financing Evaluation, and Verification & Credit Data Operations — plus Government Identity (IPRS) and Transaction Operations. Standards-based JSON over HTTPS, API-key + optional HMAC signing, idempotency and webhooks. Compatible with Mambu, Temenos, Finacle, Flutterwave, Paystack, M-Pesa & more.
Sent as Authorization: Bearer <client_id>:<secret>. Issue your own keys in the Admin console. Full integration profile at /v3/integration.
Module A — Customer Operations
Onboarding & retrieval matching the Farmsky Customer Onboarding UI, plus plug-and-play widgets for lenders with existing websites.
/v3/applicants
API key
Onboard an applicant (farmer / business).
/v3/applicants/:id
API key
Retrieve an onboarded applicant.
/v3/applicants
API key
List recent applicants.
/v3/consents
API key
Create a granular consent record (consent ledger).
/v3/consents/:token/revoke
API key
Revoke consent (propagates within 60s).
/v3/plug-and-play/config
API key
Get drop-in onboarding widget config & embed snippet.
Module B — Statement & Financing Evaluation
Automated parsing and financial scoring of M-Pesa, Till, Paybill and Bank statements with tamper detection.
/v3/statements/mpesa
API key
Analyse an M-Pesa statement.
/v3/statements/till
API key
Analyse a Till Number statement.
/v3/statements/paybill
API key
Analyse a Paybill Number statement.
/v3/statements/bank
API key
Analyse a Bank statement (PDF/CSV).
/v3/statements/upload
API key
Upload a PDF statement → authenticity confidence + transaction extraction (multipart: file).
/v3/statements/analyse
API key
Generic analyse with statement_type in body.
Module C — Government & Identity Verification
Real-time National ID / alien card / citizen verification via IPRS.
/v3/iprs/verify
API key
IPRS national ID verification.
Module D — Verification & Credit Data Operations
KYC/KYB identity checks, biometrics, credit bureau (CRB) and the full composite credit/financing evaluation engine.
/v3/kyc
API key
KYC — IPRS + biometric liveness for a natural person.
/v3/kyb
API key
KYB — business registration + directors.
/v3/biometrics/verify
API key
Biometric liveness + face match with configurable thresholds.
/v3/crb
API key
Credit Bureau pull (individual or business).
/v3/credit/evaluations
API key
Full composite credit decision (300–850 + SHAP).
Module E — Transaction Operations
Digital invoicing and invoice-financing (factoring) eligibility evaluation.
/v3/invoices
API key
Create a digital invoice (auto VAT).
/v3/invoices/:id
API key
Retrieve an invoice.
/v3/invoice-financing/evaluate
API key
Evaluate invoice-financing / factoring eligibility.
Module F — SDK, Workflows & Embeddable Verification
Drop-in client SDK plus the Workflow Builder Console (OTP-authenticated) that lets lenders assemble verification flows and embed them in native mobile & web apps. Console endpoints (/v3/app/*) require a Bearer session token; the embeddable verify runner (/v3/verify/*) is called by the SDK using a public Workflow Client ID.
/sdk/v1/farmsky.js
API key