Skip to main content
The Pruva API is a small REST API. There are four endpoints: one to run a check, two to read checks back, and a health probe. Everything shares the same base URL, authentication, and response envelope.

​
Base URL

All endpoints are versioned under /v1. The environment (test or live) comes from your API key, not the URL.

​
Authentication

Send your key in the X-Pruva-Key header on every request except the health check.
See Authentication for key formats and safety.

​
Request format

Requests that take a body send JSON, with Content-Type: application/json. When you run a check, the body is that scope’s inputs directly, with no wrapper:

​
Response envelope

Every response uses the same envelope, so you can parse success and failure the same way every time. Success:
data holds the result. meta is present on list responses for paging, and absent otherwise. Error:
code mirrors the HTTP status. message is a human readable explanation. Some errors add an error.details object with extra fields, for example a reference and balanceKobo on an insufficient funds error.
Check the top level status boolean first, then read data or error accordingly. The HTTP status code and error.code always agree.

​
Endpoints

​
Amounts

Every monetary value is in kobo, the minor unit of the naira. 5000 is ₦50.00. See Wallet and billing.

​
Timestamps

Timestamps are ISO 8601 with the West Africa offset, for example 2026-07-27T08:50:00+01:00.