Pierflow
Get started

API

API overview

The Pierflow API is a JSON, HTTPS-only, REST surface — one canonical interface across every HMO, provider, and partner in the network.

Base URLs#

EnvironmentBase URL
Sandboxhttps://sandbox.api.pierflow.com/v1/
Productionhttps://api.pierflow.com/v1/

Conventions#

A handful of platform-wide rules apply to every endpoint. Internalise these once and the rest of the API behaves predictably.

  • All requests and responses are JSON.
  • Timestamps are ISO-8601 in UTC (e.g. 2026-06-01T09:30:00Z).
  • Money is in minor units of the currency (kobo for NGN).
  • Writes are idempotent — set Idempotency-Key on every POST.
  • AI fields (e.g. fraud_score) are stable across versions.
  • Errors return a structured body with type, code, and request_id.

Example request#

Authenticate with a bearer token and call any endpoint.

bash
bash
curl https://sandbox.api.pierflow.com/v1/plans?budget_ngn=120000 \
  -H "Authorization: Bearer $PIERFLOW_KEY"