Get Started

FAQs

What is the difference between Sandbox and Production?

Sandbox (https://sandbox.credit.farmsky.africa) returns non-billable mock results so you can build and test safely. Production (https://credit.farmsky.africa) performs live lookups and is metered. Switch by the credentials you present.

How do I authenticate?

Send Authorization: Bearer <client_id>:<secret> on every request. You can also use the x-api-client / x-api-secret pair, or the single x-api-key header. Never expose secrets in client-side code.

What are the rate limits?

Default 120 req/min per credential. Read the X-RateLimit-* headers. A 429 means you are throttled, so back off until the reset window.

Which countries are supported?

Identity, KYB and tax checks cover Kenya and the wider region. Pick a country with the country_code parameter (ISO-3166 alpha-2, e.g. KE, UG, TZ, NG, RW).

How are async results handled?

Responses with async_pending: true carry a reference. Poll GET /v3/kyc/status/:reference or subscribe to a webhook for the final result.

Does the documentation stay in sync with the API?

Yes. This reference is generated from one machine-readable spec that ships with the service. New or changed endpoints appear here on the next deploy.