Skip to the page
Sections

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

CallWhat it does
GET /api/v1/campaignThe campaign this key belongs to
POST /api/v1/codes/checkPre-check a code before the consumer fills anything in
POST /api/v1/submissionsSubmit a code with a phone number and consent
GET /api/v1/submissions/{id}The current state of one submission
POST /api/v1/submissions/lookupA phone's submissions: the "check my entries" page
POST /api/v1/receiptsStart a receipt: a photo to upload, or a typed code and time
POST /api/v1/receipts/{id}/upload-urlA 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/session and GET /api/v1/agent/me, and the errors session_expired and campaign_not_assigned.
  • The error ledger_unavailable is in the catalogue and reserved; no call returns it.