API

Field formats

The shape and types you can rely on across every endpoint.

String formats#

Field family	Format
Identifiers	pf_<resource>_<ulid>, e.g. pf_plan_01HX7K…
Names	UTF-8, trimmed of leading/trailing whitespace
Phone	E.164 (e.g. +2348012345678)
Email	RFC 5322 with case-insensitive local-part comparison

All times are UTC ISO-8601. Local-time fields use an explicit timezone offset.

json

{
  "effective_date": "2026-06-01",
  "created_at": "2026-05-30T12:14:09Z",
  "appointment_at": "2026-06-12T10:00:00+01:00"
}

Money is always in minor units. 1500000 NGN means ₦15,000.00.

Enum values are SCREAMING_SNAKE_CASE. New values may be added without a major version bump — treat unknown values defensively.