Documentation

MSP · Tokens

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

ROADRoad deviations in this section

Road enables these for your connection on request.

  • Additional fields
    Adds fields OCPI 2.1.1 does not define: the owning party (country_code and party_id) on every object, and extra location data such as a publish flag, charging accessibility, parking places and the details needed for national access point reporting. Sessions and CDRs also carry VAT-inclusive totals.
    When not enabled: Objects carry only the fields the OCPI specification defines.
  • eMI3 contract id as auth_id
    auth_id carries the token's eMI3 contract identifier.
    When not enabled: auth_id carries the token's own authorisation id.
GET/emsp/2.1.1/tokens

List tokens

Returns the MSP's tokens for the CPO to pull.

ROADAdditional fieldsROADeMI3 contract id as auth_id
Responses
200OCPI response envelope application/json
dataobject[]
uidstring
typestring
auth_idstringROAD

The token's eMI3 contract identifier.

visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestringROAD

ISO 3166-1 alpha-2 country code of the party that owns the object.

party_idstringROAD

OCPI party id of the party that owns the object.

status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/emsp/2.1.1/tokens/{token_uid}/authorize

Authorize a token

Real-time authorization of a token for a charging session. The optional body carries location references to scope the authorization.

Request
Path parameters1
token_uidstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
allowedstring
tokenobject
uidstring
typestring
auth_idstring
visual_numberstring
issuerstring
validboolean
whiteliststring
languagestring
last_updatedobject
country_codestring
party_idstring
locationobject
location_idstring
evse_uidsstring[]
connector_idsstring[]
authorizationReferencestring
authorization_idstring
infoobject
languagestring
textstring
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.