Zyfy API

One API key. Two products. Standard HTTP.

Authentication

All endpoints require an API key sent in the X-Api-Key header.

curl
curl https://zyfy.uk/v1/postcode/SW1A+2AA \
  -H "X-Api-Key: YOUR_API_KEY"

Your API key is shown once when you sign up and is available in your dashboard. Keys are prefixed ea_live_. Keep it secret — it has access to your quota.

Quota & rate limit headers

Every response includes headers describing your current usage.

HeaderDescription
X-Quota-LimitYour monthly request allowance
X-Quota-UsedRequests used this period
X-Quota-RemainingRequests left this month
X-Quota-Grace-LimitHard ceiling on paid plans — limit × 1.1
X-Quota-ResetsISO 8601 datetime when quota resets
Retry-AfterSeconds to wait after a 429 response, or before retrying an enrichmentPending response

Enrichment pending

For vehicle registrations not yet in our database, the first response will include enrichmentPending: true. The registration has been queued for enrichment — retry after the Retry-After header value (typically a few seconds). Postcode data is pre-loaded and never returns enrichmentPending.

Reference