Docs / Resources
Changelog
New features, changes and deprecations. Backwards-compatible additions can ship at any time; breaking changes are announced here in advance and ship under a new path.
v0 — November 2026
First public release of the Partner API.
- Key + secret authentication with scopes
codes:read,codes:write,users:read,users:writeand an optional IP allowlist. GET /me/quota— live code allowance.POST /users,GET /users,GET /users/{id}— users identified by yourexternal_ref.POST /gp-codes— standard and custom codes from coordinates or an address, with inline user creation,Idempotency-Keysupport and a QR image in the response.GET /gp-codes,GET /gp-codes/{code},PATCH /gp-codes/{code},DELETE /gp-codes/{code}.- OpenAPI 3.1 specification.
Planned
Under consideration for later versions — not available yet, and subject to change:
- Webhooks for code status changes (e.g. custom code approved).
- Batch creation of codes.
- Checking a custom code's availability before creating it.
- A hosted "Enter address" page for web shops.
- Self-service partner accounts at gpcode.com/b2b: register your company, and after review create and rotate your own keys.
- Test keys in production:
gpk_test_keys create sandbox codes that never go live and are deleted after 30 days. - Code types per key: each key may create standard codes, custom codes or both;
typebecomes optional when a key allows only one. - Post-pay usage: live codes counted per period, with a usage page in the partner account.