API registry
The platform's services, their versions and operations. Insurers, bureaux and national systems integrate through these APIs with an API key.
Authenticate with the header x-api-key, or a bearer token from your session. Public operations need neither.
Identity serviceVersion 1.0.0
Organisations, users, roles and permission codes, two-factor sign-in, sessions, API clients, service tokens, JWKS, country parameters and policyholder accounts opened from a certificate. · 23 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/identity/auth/token | Public |
| GET | /api/identity/auth/jwks | Public |
| GET | /api/identity/me | Signed in |
| PATCH | /api/identity/me | Signed in |
| GET | /api/identity/orgs | org.read |
| POST | /api/identity/orgs | Signed in |
| GET | /api/identity/orgs/{id} | org.read |
| PATCH | /api/identity/orgs/{id} | org.update |
| POST | /api/identity/orgs/{id}/standing | org.suspend |
| GET | /api/identity/orgs/{orgId}/users | user.read |
| POST | /api/identity/orgs/{orgId}/users | user.create |
| PATCH | /api/identity/users/{id} | user.update |
| GET | /api/identity/countries | Public |
| GET | /api/identity/countries/{code} | Public |
| PATCH | /api/identity/countries/{code} | country.configure |
| GET | /api/identity/api-clients | apiclient.manage |
| POST | /api/identity/api-clients | apiclient.manage |
| GET | /api/identity/api-clients/permissions | apiclient.manage |
| DELETE | /api/identity/api-clients/{id} | apiclient.manage |
| GET | /api/identity/directory/insurers | Public |
| GET | /api/identity/directory/bureaux | Public |
| POST | /api/identity/holder-accounts/start | Public |
| POST | /api/identity/holder-accounts/complete | Public |
Registry serviceVersion 1.0.0
Attestation management: vehicles, policyholders, policies, certificates, signing keys, signed QR, PDF, hidden mark, paper serials and stock credit balances. · 31 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/registry/certificates | certificate.read |
| POST | /api/registry/certificates | certificate.issue |
| POST | /api/registry/certificates/suspend-batch | certificate.suspend |
| POST | /api/registry/certificates/reinstate-batch | certificate.reinstate |
| GET | /api/registry/certificates/batches/{id} | certificate.read |
| GET | /api/registry/certificates/by-token/{token} | Public |
| GET | /api/registry/certificates/by-token/{token}/pdf | Public |
| GET | /api/registry/certificates/by-token/{token}/card.png | Public |
| GET | /api/registry/certificates/public/{ref}/card.png | Public |
| GET | /api/registry/certificates/authority/{ref}/card.png | verify.authority |
| GET | /api/registry/certificates/{id} | certificate.read |
| GET | /api/registry/certificates/{id}/pdf | certificate.read |
| GET | /api/registry/certificates/{id}/card.png | certificate.read |
| GET | /api/registry/certificates/{id}/image.png | certificate.read |
| POST | /api/registry/certificates/{id}/renew | certificate.renew |
| POST | /api/registry/certificates/{id}/cancel | certificate.cancel |
| POST | /api/registry/certificates/{id}/suspend | certificate.suspend |
| POST | /api/registry/certificates/{id}/reinstate | certificate.reinstate |
| POST | /api/registry/certificates/{id}/duplicate | certificate.duplicate |
| GET | /api/registry/trust-list | Public |
| GET | /api/registry/stock | stock.read |
| PUT | /api/registry/stock/threshold | stock.threshold.manage |
| POST | /api/registry/paper-serials | certificate.paper.register |
| GET | /api/registry/paper-serials | certificate.read |
| POST | /api/registry/requests | Public |
| GET | /api/registry/requests | request.read |
| GET | /api/registry/requests/{id} | request.read |
| POST | /api/registry/requests/{id}/take | request.handle |
| POST | /api/registry/requests/{id}/decline | request.handle |
| GET | /api/registry/me/certificates | certificate.read |
| POST | /api/registry/me/certificates/link | certificate.read |
Integration serviceVersion 1.0.0
National motor-database feeds, bulk files and API batches with per-row results, and the regional API registry. · 10 operations
| Method | Path | Access |
|---|---|---|
| POST | /api/integration/batches | Signed in |
| GET | /api/integration/batches | batch.read |
| GET | /api/integration/batches/{id} | batch.read |
| POST | /api/integration/batches/{id}/rows/{rowNo}/correct | feed.correct |
| POST | /api/integration/batches/{id}/retry | feed.correct |
| POST | /api/integration/api/batches | batch.submit |
| GET | /api/integration/api/batches/{id} | batch.read |
| GET | /api/integration/feeds | batch.read |
| PATCH | /api/integration/feeds/{id} | feed.manage |
| GET | /api/integration/templates/insurer.csv | Public |
Finance serviceVersion 1.0.0
Stock orders, payment declaration and confirmation (PAPSS via Ecobank), statement matching, tiers and pricing, the distribution key, settlement ledger and security deposits. · 34 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/finance/orders | order.read |
| POST | /api/finance/orders | order.create |
| GET | /api/finance/orders/preview | order.create |
| GET | /api/finance/orders/{id} | order.read |
| POST | /api/finance/orders/{id}/declare-payment | order.declare_payment |
| POST | /api/finance/orders/{id}/pay-online | order.declare_payment |
| POST | /api/finance/orders/{id}/confirm-payment | order.confirm_payment |
| POST | /api/finance/orders/{id}/release | order.release |
| POST | /api/finance/orders/{id}/cancel | order.cancel |
| POST | /api/finance/callbacks/{rail} | Public |
| GET | /api/finance/payments/exceptions | order.confirm_payment |
| POST | /api/finance/statements | statement.import |
| GET | /api/finance/statements | statement.import |
| GET | /api/finance/statements/lines | statement.import |
| GET | /api/finance/statements/open-orders | statement.import |
| GET | /api/finance/statements/{id} | statement.import |
| POST | /api/finance/statements/lines/{lineId}/match | statement.import |
| POST | /api/finance/statements/lines/{lineId}/unmatch | statement.import |
| GET | /api/finance/settlements | settlement.read |
| GET | /api/finance/settlements/{id} | settlement.read |
| POST | /api/finance/settlements/{id}/entries/{entryId}/confirm | settlement.confirm_transfer |
| GET | /api/finance/pricing/tier-schedules | pricing.read |
| POST | /api/finance/pricing/tier-schedules | pricing.manage |
| GET | /api/finance/pricing/country-tiers | pricing.read |
| PUT | /api/finance/pricing/country-tiers/{country}/{year} | pricing.manage |
| GET | /api/finance/pricing/proposals | pricing.read |
| POST | /api/finance/pricing/proposals/{country}/approve | pricing.manage |
| GET | /api/finance/pricing/price-lists | pricing.read |
| POST | /api/finance/pricing/price-lists | pricing.manage |
| GET | /api/finance/pricing/distribution-keys | pricing.read |
| POST | /api/finance/pricing/distribution-keys | pricing.manage |
| GET | /api/finance/deposits | deposit.read |
| POST | /api/finance/deposits | deposit.manage |
| POST | /api/finance/deposits/{id}/payments | deposit.manage |
Claims serviceVersion 1.0.0
Cross-border claims under the Harmonised Convention: intake, cover lookup, assessment, offers, notices, demands and arbitration. · 30 operations
| Method | Path | Access |
|---|---|---|
| POST | /api/claims/claims/public | Public |
| POST | /api/claims/claims/track/start | Public |
| POST | /api/claims/claims/track/verify | Public |
| GET | /api/claims/claims | claim.read |
| POST | /api/claims/claims | claim.open |
| GET | /api/claims/claims/mine | claim.read |
| POST | /api/claims/claims/mine | claim.report |
| POST | /api/claims/claims/cover-lookup | claim.open |
| GET | /api/claims/claims/{id} | claim.read |
| POST | /api/claims/claims/{id}/cover | claim.open |
| POST | /api/claims/claims/{id}/acknowledge | claim.open |
| POST | /api/claims/claims/{id}/decline | claim.open |
| POST | /api/claims/claims/{id}/withdraw | Signed in |
| POST | /api/claims/claims/{id}/facts | claim.assess |
| POST | /api/claims/claims/{id}/assessments | claim.assess |
| POST | /api/claims/claims/{id}/offers | claim.offer |
| POST | /api/claims/claims/{id}/offers/{offerId}/response | claim.offer |
| POST | /api/claims/claims/{id}/payments | claim.settle |
| POST | /api/claims/claims/{id}/notices | claim.notice.send |
| POST | /api/claims/claims/{id}/notices/{noticeId}/answer | claim.notice.answer |
| POST | /api/claims/claims/{id}/demands | claim.demand.raise |
| POST | /api/claims/claims/{id}/demands/{demandId}/answer | claim.demand.answer |
| POST | /api/claims/claims/{id}/demands/{demandId}/payment | claim.demand.answer |
| POST | /api/claims/claims/{id}/demands/{demandId}/confirm | claim.demand.raise |
| POST | /api/claims/claims/{id}/arbitrations | claim.arbitration.manage |
| POST | /api/claims/claims/{id}/arbitrations/{arbitrationId}/decision | claim.arbitration.manage |
| POST | /api/claims/claims/{id}/close | claim.settle |
| POST | /api/claims/claims/{id}/documents | document.upload |
| GET | /api/claims/ua-rates | uarate.read |
| POST | /api/claims/ua-rates | uarate.manage |
Verification serviceVersion 1.0.0
Verification read model, public and authority checks, scan log, trust list and the USSD channel. · 7 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/verify/check | Public |
| GET | /api/verify/token/{jws} | Public |
| POST | /api/verify/file | Public |
| GET | /api/verify/trust-list | Public |
| POST | /api/verify/scans/offline | verify.authority |
| GET | /api/verify/history | verify.history.read |
| POST | /api/verify/ussd | Public |
Ledger serviceVersion 1.0.0
Hash-chained integrity ledger, signed Merkle anchors and witnesses, the audit and access register and the event trail. · 13 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/ledger/anchors | Public |
| POST | /api/ledger/anchors | ledger.verify |
| GET | /api/ledger/anchors/{id} | Public |
| POST | /api/ledger/anchors/{id}/acknowledge | Signed in |
| GET | /api/ledger/keys | Public |
| GET | /api/ledger/proof | Public |
| GET | /api/ledger/proof/lookup | Public |
| POST | /api/ledger/verify | ledger.verify |
| GET | /api/ledger/status | ledger.read |
| GET | /api/ledger/entries | Signed in |
| GET | /api/ledger/entries/{seq} | Signed in |
| POST | /api/ledger/training/tamper | ledger.verify |
| POST | /api/ledger/training/restore | ledger.verify |
Insights serviceVersion 1.0.0
Reporting read model, dashboards, the monthly transparency report, quarterly reconciliation and rule-based risk signals. · 11 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/insights/dashboards/pgs | report.read |
| GET | /api/insights/dashboards/bureau | report.read |
| GET | /api/insights/dashboards/bureau/export | report.read |
| GET | /api/insights/dashboards/insurer | report.read |
| GET | /api/insights/dashboards/operator | system.status.read |
| GET | /api/insights/dashboards/partner | settlement.read |
| GET | /api/insights/reports/monthly | report.read |
| GET | /api/insights/reports/quarterly | report.read |
| GET | /api/insights/risk | risk.read |
| GET | /api/insights/risk/{id} | risk.read |
| POST | /api/insights/risk/{id}/review | risk.review |
Documents serviceVersion 1.0.0
Electronic document management: upload, versions, classification, search and access log. · 8 operations
| Method | Path | Access |
|---|---|---|
| POST | /api/documents/documents/public | Public |
| POST | /api/documents/documents | document.upload |
| GET | /api/documents/documents | document.read |
| GET | /api/documents/documents/{id} | document.read |
| GET | /api/documents/documents/{id}/content | document.read |
| GET | /api/documents/documents/{id}/versions | document.read |
| POST | /api/documents/documents/{id}/versions | document.upload |
| GET | /api/documents/documents/{id}/access-log | audit.read |
Communications serviceVersion 1.0.0
Notifications by email, SMS and in-app inbox, and the helpdesk ticket portal. · 10 operations
| Method | Path | Access |
|---|---|---|
| GET | /api/comms/notifications | notification.read |
| POST | /api/comms/notifications/read-all | notification.read |
| POST | /api/comms/notifications/{id}/read | notification.read |
| POST | /api/comms/tickets | ticket.create |
| GET | /api/comms/tickets | ticket.read |
| GET | /api/comms/tickets/assignees | ticket.handle |
| GET | /api/comms/tickets/{id} | ticket.read |
| POST | /api/comms/tickets/{id}/messages | ticket.read |
| POST | /api/comms/tickets/{id}/assign | ticket.handle |
| POST | /api/comms/tickets/{id}/status | ticket.read |