Skip to navigation

Provision a token

Creates the token as PROVISIONED; with auto_activate it is pushed to roaming partners and stored ACTIVE. If the push to roaming partners fails the call answers 502 and the token is left as it was; retry with the same Idempotency-Key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

Idempotency-KeystringRequired1-255 characters
A unique key you choose for this call, e.g. a UUID. Retrying with the same key returns the first result instead of acting twice.

Request

This endpoint expects an object.
uidstringRequired1-36 characters
typeenumRequired
Allowed values:
contract_idstringRequired1-36 characters
issuerstringRequired1-64 characters
visual_numberstring or nullOptional<=64 characters
group_idstring or nullOptional<=36 characters
whitelistenum or nullOptionalDefaults to ALLOWED
Allowed values:
languagestring or nullOptionalformat: "^[a-z]{2}$"
valid_fromdatetime or nullOptional
valid_untildatetime or nullOptional
country_codestring or nullOptionalformat: "^[A-Z]{2}$"
party_idstring or nullOptionalformat: "^[A-Z0-9]{3}$"
ocpi_versionenum or nullOptionalDefaults to 221
Allowed values:
metadatamap from strings to any or nullOptional
auto_activateboolean or nullOptionalDefaults to false

Response

The token; ACTIVE when auto_activate was set, else PROVISIONED.

idinteger
organization_idstring
uidstring
typeenum or any
contract_idstring
issuerstring
country_codestring
party_idstring
whitelistenum or any
ocpi_versionstring
statusenum or any
created_atdatetime
last_updateddatetime
visual_numberstring or nullOptional
group_idstring or nullOptional
languagestring or nullOptional
valid_fromdatetime or nullOptional
valid_untildatetime or nullOptional
metadatamap from strings to any or nullOptional
status_reasonstring or nullOptional
invalidated_atdatetime or nullOptional

Errors

400
Bad Request Error
401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
502
Bad Gateway Error
504
Gateway Timeout Error