Changelog
What changed in the API, newest first. v1 changes are additive only.
v1 ·
The first version: submissions for campaigns on our own codes and on Seebait codes, with or without a receipt, and the consumer's lookup.
OpenAPI document version 1.0.0: 8 calls, 26 message keys, 26 error codes.
Calls
| Call | What it does |
|---|---|
GET /api/v1/campaign | The campaign this key belongs to |
POST /api/v1/codes/check | Pre-check a code before the consumer fills anything in |
POST /api/v1/submissions | Submit a code with a phone number and consent |
GET /api/v1/submissions/{id} | The current state of one submission |
POST /api/v1/submissions/lookup | A phone's submissions: the "check my entries" page |
POST /api/v1/receipts | Start a receipt: a photo to upload, or a typed code and time |
POST /api/v1/receipts/{id}/upload-url | A fresh upload URL when the first one expired |
GET /api/v1/receipts/{id} | Whether the receipt's file has arrived |
Not yet available
- BA sessions:
POST /api/v1/agent/sessionandGET /api/v1/agent/me, and the errorssession_expiredandcampaign_not_assigned. - The error
ledger_unavailableis in the catalogue and reserved; no call returns it.