Abia State Government Services Portal
Home · Developers

Changelog & versioning

The version is in the path. Within v1 changes are additive: a new field, a new reason code, a new endpoint. Anything that could break a caller gets a new path and a sunset date.

What may change under you, and what may not

Additive — expect these inside v1
  • A new endpoint.
  • A new optional request field.
  • A new field in a response object.
  • A new reason code, or a clearer message on an existing one.
  • A new webhook event.

Ignore what you do not recognise. A client that rejects an unknown field is a client that breaks on an improvement.

Breaking — never inside v1
  • Removing or renaming a field.
  • Renaming or repurposing a reason code.
  • Changing the type or the meaning of a value.
  • Making an optional field required.
  • Changing what an endpoint does.

Any of these gets a new version in the path, and v1 keeps answering until its sunset date.

Deprecation

When an endpoint is being retired you find out three ways, none of which require you to read this page:

HTTP/1.1 200 OK
Deprecation: Fri, 30 Jun 2028 23:59:59 GMT
Sunset: Sun, 31 Dec 2028 23:59:59 GMT
Link: <https://services.abiastate.gov.ng/developers/changelog>; rel="deprecation"
  • The response carries Deprecation and Sunset headers from the day the decision is taken.
  • An api.deprecation_notice webhook is sent to every client using the endpoint.
  • The integration desk writes to the contact on the client record.
  • The sunset is never less than twelve months after the notice, and never in the last quarter of a fiscal year.
v1.0.0

First published contract

2026-09-14
  • Parties: verify, validate and register.
  • Transactions: submit, read, cite a payment, re-run the gates for what is owed, issue the final document.
  • Documents: read by short number, look up by long number, evidence bundle, and unauthenticated public verification.
  • Contractors and contracts: onboarding, award request with the award gate, variations, contract read and look-up.
  • Vouchers: raise against a contract or a payment authority, validate, and read with the full deduction breakdown.
  • Payments: advise a collection against a verification id.
  • Webhooks: subscribe, list, read with delivery history, resume, redeliver, stop; thirteen events.
  • Sandbox: read the seeded identities, settle a sandbox bill, reseed.
  • Degraded mode: submissions, document requests, payment citations and advice, voucher raises and corporate registrations answer 202 QUEUED_DEGRADED while a dependency is down; GET /queue/{ref} follows them.
  • Warehouse: list the daily extracts, read a manifest, download a verified file (dw scope, live keys).

Watching for changes

  • Diff openapi.json in your build. It is generated from the same source as these pages and is byte-stable between releases, so a diff means the contract really moved.
  • Keep the reason-code catalogue in your own tests: a code you have never handled appearing in production is a change you should have seen.
  • Give the integration desk an address that outlives the person who set the integration up.