HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

Id Tag / Create

Create new Id Tag

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer | null

The operator ID for this resource.
Required for global admin tokens.
Optional for operator-scoped tokens (defaults to token's operator).

string
required
length ≤ 255

Token used for authorization

string | null

Visual or other label that could be associated with the ID Tag. For ID tags that are shared with roaming partners, this value is sent as the OCPI visual_number. Values longer than 64 characters are not shared.

date-time | null
string
enum
required

The status of the ID tag. Use it to disable or suspend a tag

  • enabled The tag is enabled and is accepted as authentication method
  • disabled The tag is disabled by the admin user and is not acceptable as authorization method
  • suspended The tag is suspended by the owner of the tag and is not acceptable as authorization method
Allowed:
string
enum
required
Allowed:
string
enum

The RFID card standard of the tag. Applicable to RFID tags only.

Allowed:
string | null
enum

Marks how the ID tag is used. The value only applies when the ID tag has no associated vehicle; an ID tag associated with a vehicle takes the vehicle's usage type instead and this value has no effect.

  • private_car - suppresses company reimbursement for the home charging sessions of the ID tag.
  • company_car - does not suppress company reimbursement. It never makes a session eligible for reimbursement on its own; eligibility is still decided by the existing checks.
  • null - contributes no signal. The existing reimbursement classification decides the outcome unchanged.

The reimbursement effect applies only where the home charging reimbursement feature is enabled; elsewhere the value is stored and returned but changes no reimbursement outcome.

Allowed:
boolean

Restricts the ID tag to the holder's own home charge points, including charge points shared with the holder. The tag is not authorized anywhere else.

Applicable to tags of type rfid only. Supplying this property on a create or update request for a tag of any other type is rejected with 422.

  • Read - returned for RFID tags; omitted for all other tag types.
  • Create - optional. Defaults to false when omitted.
  • Update - optional. An omitted value preserves the current setting; send false to lift the restriction. There is no null value - false is the clear value.
string | null
deprecated

Use defaultPaymentOption instead.

The payment method that will be associated with the ID Tag.

  • For credit/debit cards the paymentMethodId should be provided
  • For Corporate billing - corporate:{id}
  • For Subscription - use "subscription" to use the user's active subscription
  • For Auto selection - use "auto" (recommended) or null (deprecated)
  • The "last used" concept has been replaced with "auto" selection which cycles through available payment methods.
string

The default payment option for this ID tag. Accepted values:

  • auto - Automated fallback sequence
  • A payment card ID - Specific registered payment card
  • corporate:{id} - Corporate billing account (replace {id} with the corporate billing ID)
  • subscription - User's active post-paid subscription

At charging time, if the chosen payment option doesn't apply to the session (e.g., corporate billing not eligible for the charge point, subscription not applicable), the platform falls back to the user's other available payment methods.

integer | null

Associate the ID tag with a user account. If the user is not presented, the tag will not be authorized! It makes sense to prepare the tags in advance, in case there is another process/entity is going to later assign them!

string | null
integer

The administrator accounts of the selected Partner will be able to edit and delete the specified ID tag

integer

Associate the ID tag with a vehicle.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json