For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Registers an RFID / authorization token (idTag) that chargers can authorize. A card created with card_state Unused is refused until it is activated. 409 if the token already exists for this organization.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
id_tokenstringRequired1-36 characters
RFID UID or idTag.
id_token_typestring or nullOptional
statusstringOptional1-50 charactersDefaults to Accepted
cache_expiry_date_timedatetime or nullOptional
parent_id_tagstring or nullOptional
prepaid_balancedouble or string or nullOptional
real_time_authbooleanOptionalDefaults to false
provider_idinteger or nullOptional
descriptionstring or nullOptional
card_numberstring or nullOptional1-64 characters
Printed card number, distinct from the chip’s id_token.
card_stateenumOptionalDefaults to Active
Unused = printed, not handed out yet (Authorize answers Invalid).
Allowed values:
valid_untildatetime or nullOptional
Card validity; past it Authorize answers Expired.
allow_simultaneous_chargingbooleanOptionalDefaults to true
False: Authorize answers ConcurrentTx while the card charges elsewhere.
Response
Successful Response
idinteger
Token id on the gateway.
id_tokenstring
RFID UID or idTag the charger sends.
statusstring
Authorization status, e.g. Accepted or Blocked.
id_token_typestring or nullOptional
OCPP 2.x IdTokenType, e.g. ISO14443.
cache_expiry_date_timedatetime or nullOptional
When chargers must stop trusting a cached authorization.
parent_id_tagstring or nullOptional
OCPP parentIdTag: the token group the token belongs to.
prepaid_balancestring or nullOptional
Remaining prepaid balance, as a decimal string.
real_time_authbooleanOptionalDefaults to false
True when every use must be authorized online.
provider_idinteger or nullOptional
Issuing provider id on the gateway.
descriptionstring or nullOptional
Free-text notes.
deleted_atdatetime or nullOptional
When the token was soft-deleted.
card_numberstring or nullOptional
Number printed on the card.
card_stateenumOptionalDefaults to Active
Card issuance state; Unused cards are refused by Authorize.
Allowed values:
valid_untildatetime or nullOptional
Card validity; past it Authorize answers Expired.
allow_simultaneous_chargingbooleanOptionalDefaults to true
Whether this card may authorize another charge while it has an active transaction.
status_reasonstring or nullOptional
Why the status last changed, e.g. a block reason.
status_changed_atdatetime or nullOptional
When the status last changed.
revisionintegerOptionalDefaults to 1
Increases on every change; pass as expected_revision to guard writes.
