Skip to content

Create Keycard​

POST
/keycards

Create a keycard, an already used hardware code will result in a 400 response

Authorizations​

bearerAuth

Generate an API token here

Type
HTTP (bearer)

Parameters​

Header Parameters

compatibility-date*

API compatibility date in YYYY-MM-DD format. Must be a date after 2025-11-01.

Type
string
Required
Example"2025-11-02"
Pattern
^\d{4}-\d{2}-\d{2}$
organization-id*

Routes the request to the organization named by this ID. The bearer token must be authorized for that organization.

Type
string
Required
Example"3b241101-e2bb-4255-8caf-4136c566a962"
Min Length
1
Max Length
40

Request Body​

application/json

Unique hardware ID embedded in the keycard; presented to chargers as the OCPP idTag and used in keycard path parameters.

Max Length20

Human-readable identifier for the keycard; keycards created from a template carry the friendly ID printed on the card.

Restricts where the keycard can be used; the bound entity must belong to the keycard organization.

Binding Effect
chargerId The keycard can only be used at this charger.
locationId The keycard can only be used at chargers installed at this location.
organizationId The keycard can only be used at chargers of this organization.

Group the keycard belongs to; organization settings can allow same-group keycards to stop a session started with this keycard.

Responses​

success.keycard.create

application/json

Playground​

Authorization
Headers
Body

Samples​