Farmsky APIs: Credit Scoring, KYC/KYB, CRB, Statement Analysis & Lending API

KYC / Identity

Real-time identity verification — National ID, Driver’s Licence and Passport — across Kenya and the wider region. Country is selected with country_code.

POST /v3/kyc/national-id National ID Verify a national identity number against the government registry. POST /v3/kyc/drivers-license Driver’s Licence Verify a driver’s licence number. POST /v3/kyc/passport Passport Verify a passport number. GET /v3/kyc/status/:reference Verification Status Poll the status of an asynchronous verification job.

KYB / Business

Business registration and ownership checks across East Africa (KE, UG, TZ) with a global company-registry fallback.

POST /v3/kyb/enterprise-search Enterprise Search Look up a business by its registration number and return company + director details. POST /v3/kyb/company-search Company Name Search Search the registry by company name.

Fraud Scan

Fraud and risk signals for physical addresses, phone numbers and composite identity risk.

POST /v3/fraud/address Address Verification Verify a physical address and return a match/risk signal. POST /v3/fraud/phone Phone Number Verify and enrich a phone number (carrier, line type, risk). POST /v3/fraud/identity-risk Identity Risk Scan Composite fraud / identity-risk scan from a flexible payload. POST /v3/fraud/face-scan Face Scan Upload a face image and scan it against fraud-bank records and multiple-ID matches. Sent as multipart/form-data with an image file part. POST /v3/fraud/id-scan ID Scan Scan an identity number for fraud signals. POST /v3/fraud/reports Submit Fraud Report Report a fraud incident to the shared fraud database. GET /v3/fraud/reports List Fraud Reports List submitted fraud reports (filterable, paginated). GET /v3/fraud/reports/:report_id Get Fraud Report Detail Retrieve a single fraud report by id. POST /v3/fraud/bulk-scan/upload Fraud Bulk Scan Upload Kick off a bulk fraud scan job. GET /v3/fraud/bulk-scan List Bulk Scans List bulk fraud scan jobs. GET /v3/fraud/bulk-scan/:bulk_id Get Bulk Scan Detail Retrieve the status and results of a bulk fraud scan.

AML Screening

AML / PEP / sanctions / watchlist screening for individuals and businesses in any territory.

POST /v3/screening/aml AML Screening Screen a subject against sanctions, PEP and adverse-media watchlists. POST /v3/screening/individual PEP Screening (Individual) PEP / sanctions screening for a natural person. POST /v3/screening/business PEP Screening (Business) Sanctions / watchlist screening for a business entity. POST /v3/screening/pep PEP Screening Screen an individual against global Politically Exposed Persons (PEP) databases. POST /v3/screening/sanction Sanctions Screening Screen an individual or entity against global and local sanctions lists. POST /v3/screening/pep-and-sanction PEP + Sanctions Screening Combined PEP and sanctions screening in a single call. POST /v3/screening/aml-with-id AML Screening with ID Verify an identity document then screen the extracted profile against AML watchlists. GET /v3/screening/channels Available Channels List the ID-verification channels available for AML Screening with ID.

Background Check

Background Check Management: create and track candidate requests, manage system & custom packages, and look up supported countries and check types.

POST /v3/background/candidates Create Candidate Request Create a background-check request for one or more candidates. GET /v3/background/candidates List Candidate Requests List background-check candidate requests. GET /v3/background/candidates/:reference Get Candidate Request Detail Retrieve a single candidate request by its reference. POST /v3/background/candidates/:reference/reinitiate Reinitiate Candidate Request Re-run a candidate request that stalled or expired. GET /v3/background/system-packages List System Packages List the platform-provided system background-check packages. GET /v3/background/system-packages/:id Get System Package Detail Retrieve a single system package by id. GET /v3/background/packages List Custom Packages List your organization-defined custom packages. POST /v3/background/packages Create Custom Package Create a custom background-check package. GET /v3/background/packages/:id Get Custom Package Detail Retrieve a single custom package by id. PUT /v3/background/packages/:id Update Custom Package Update a custom background-check package. DELETE /v3/background/packages/:id Delete Custom Package Delete a custom background-check package. GET /v3/background/countries Supported Countries List the countries supported for background checks. GET /v3/background/check-types Check Types List check types. Pass ?country_code=XX for a country, or omit for all system check types.

Tax (KRA)

Kenya Revenue Authority checks — PIN validation, Tax Compliance Certificate (TCC) and Withholding Tax (WHT).

POST /v3/tax/pin KRA PIN Checker Validate a KRA PIN and return the registered taxpayer name. POST /v3/tax/tcc TCC Checker Verify a Tax Compliance Certificate. POST /v3/tax/wht WHT Checker Verify a Withholding Tax certificate/number.

Vehicle

Vehicle identity checks by VIN / chassis / registration (logbook).

POST /v3/vehicle/vin VIN / Chassis Verify a vehicle by VIN, chassis or registration number.

Document Verification

Document authenticity + optional face-match (liveness). Images are base64 and must be under 1 MB.

POST /v3/document/verify Document Verification Verify an identity document and optionally match it to a selfie.

Credit & Bureau

Credit Reference Bureau pulls and the full composite credit-decision engine (300–850 with explainability).

POST /v3/crb Credit Reference Bureau Pull a credit-bureau report for an individual or a business. POST /v3/credit/evaluations Composite Credit Decision Run a full composite credit decision (300–850) with an explainable breakdown.

Statement Analysis

Automated parsing and financial scoring of M-Pesa, Till, Paybill and Bank statements, with tamper / authenticity detection.

POST /v3/statements/analyze Analyse Statement Analyse a statement and return cash-flow metrics + affordability signals. POST /v3/statements/upload Upload Statement (PDF) Upload a PDF statement for authenticity scoring + transaction extraction.

360 Evaluation Engine

AI-driven, explainable composite scoring on a 1000-point scale. Farmer360 (crop / livestock) and AgSME360 return a full score_breakdown, an AI explanation and a step-by-step analysis_trace.

POST /api/v1/farmer360/crop Farmer360 — Crop Score a crop farmer: CRB 25% · Agro-Ecological 25% · Cash Flow 25% · Market 25% → 1000 pts. POST /api/v1/farmer360/livestock Farmer360 — Livestock Score a livestock farmer: CRB + NDVI/Weather + Cash Flow + Market → 1000 pts. POST /api/v1/agsme360/agrismes AgSME360 Score an agri-SME: Combined CRB 30% · Cash Flow 35% · Audited Accounts 35% → 1000 pts.

Our APIs