Log inTalk to us
Developer tools

Ask whether a sticker's charger moved to Ivora (public, for your own website)

get/v1/qr-lookup/{tenant_id}
No authentication

Public and read-only, for the page of your own website that your QR stickers open: it asks whether that sticker's charger moved, and sends the driver to the Ivora checkout if so. Only codes in the project's imported sticker list answer moved true; any other code answers moved false, in the same time. Nothing else about the charger or the project is returned. CORS: only the project's website_origins (QR settings) may read it from the browser; GET only, never with credentials. 30 lookups a minute per client address and 3,000 per project; answers may be cached for 10 seconds. Each lookup counts in the scan counts (website_lookup_moved, website_lookup_stay or rate_limited). Errors: 429 rate_limited. See Errors and statuses.

Path parameters

  • tenant_idintegerRequired
    Greater than 0

Query parameters

  • codestringRequired
    The sticker's code, as imported.
    1–300 characters
  • evseinteger | null
    The connector, when the sticker names none.
    Minimum 1

Returns · 200

  • movedbooleanRequired
    true: the charger moved to Ivora, send the driver to url (or let them pick from choices). false: stay on your page, also for a code Ivora does not know.
  • urlstring | nullRequired
    The Ivora checkout page of the sticker's charger and connector; null when not moved, or when the driver picks a connector from choices.
  • choicesarray of LookupChoiceRequired
    The charger's connectors when it moved, the sticker names none and the charger has several; else empty.
    Child attributes
    • evse_numberintegerRequired
    • urlstringRequired
      The Ivora checkout page of that connector.
GET /v1/qr-lookup/{tenant_id}
curl --fail-with-body "https://api.ivoracharge.com/v1/qr-lookup/1042?code=string"
Response · 200JSON
{
  "moved": false,
  "url": "https://app.example.com/ivora/webhooks",
  "choices": [
    {
      "evse_number": 1,
      "url": "https://app.example.com/ivora/webhooks"
    }
  ]
}
Requires an approved production API keyProduction access starts with a request, a short meeting with Ivora and a card on file, after which Ivora staff grant your account access. How to request access
Try itproduction · api.ivoracharge.com

This operation needs no API key.