Update token attributes

curl --request PATCH \
  --url https://api.spirii.com/emsp/v1/tokens/{tokenId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "visual_number": "<string>",
  "issuer": "<string>",
  "language": "<string>",
  "valid_until": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'

import requests

url = "https://api.spirii.com/emsp/v1/tokens/{tokenId}"

payload = {
    "visual_number": "<string>",
    "issuer": "<string>",
    "language": "<string>",
    "valid_until": "2023-11-07T05:31:56Z",
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    visual_number: '<string>',
    issuer: '<string>',
    language: '<string>',
    valid_until: '2023-11-07T05:31:56Z',
    metadata: {}
  })
};

fetch('https://api.spirii.com/emsp/v1/tokens/{tokenId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/emsp/v1/tokens/{tokenId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'visual_number' => '<string>',
    'issuer' => '<string>',
    'language' => '<string>',
    'valid_until' => '2023-11-07T05:31:56Z',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/emsp/v1/tokens/{tokenId}"

	payload := strings.NewReader("{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.spirii.com/emsp/v1/tokens/{tokenId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/emsp/v1/tokens/{tokenId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "schema_version": "v1",
  "id": "<string>",
  "tenant_id": "<string>",
  "type": "RFID",
  "uid": "<string>",
  "contract_id": "<string>",
  "issuer": "<string>",
  "whitelist": "ALWAYS",
  "status": "PROVISIONED",
  "whitelist_distributed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z",
  "audit": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "country_code": "<string>",
  "party_id": "<string>",
  "visual_number": "<string>",
  "language": "<string>",
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z",
  "group_id": "<string>",
  "emsp_group_id": "<string>",
  "metadata": {},
  "last_authorization": "2023-11-07T05:31:56Z",
  "invalidated_at": "2023-11-07T05:31:56Z"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

Update token attributes

Partially updates a token: fields left out are unchanged. Only visual_number, issuer, language, valid_until, whitelist and metadata can be changed here. contract_id never changes after create, so sending it is a 422; any other unknown field is ignored. Send null to clear visual_number, language, valid_until or metadata. metadata replaces the stored map and is validated against the tenant TOKEN metadata schema. A tenant without a TOKEN metadata schema cannot store metadata: any non-empty map is a 422. Status changes go through the lifecycle actions.

Requires the emsp:tokens:write scope.

PATCH

emsp

tokens

{tokenId}

Update token attributes

curl --request PATCH \
  --url https://api.spirii.com/emsp/v1/tokens/{tokenId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "visual_number": "<string>",
  "issuer": "<string>",
  "language": "<string>",
  "valid_until": "2023-11-07T05:31:56Z",
  "metadata": {}
}
'

import requests

url = "https://api.spirii.com/emsp/v1/tokens/{tokenId}"

payload = {
    "visual_number": "<string>",
    "issuer": "<string>",
    "language": "<string>",
    "valid_until": "2023-11-07T05:31:56Z",
    "metadata": {}
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    visual_number: '<string>',
    issuer: '<string>',
    language: '<string>',
    valid_until: '2023-11-07T05:31:56Z',
    metadata: {}
  })
};

fetch('https://api.spirii.com/emsp/v1/tokens/{tokenId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.spirii.com/emsp/v1/tokens/{tokenId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'visual_number' => '<string>',
    'issuer' => '<string>',
    'language' => '<string>',
    'valid_until' => '2023-11-07T05:31:56Z',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.spirii.com/emsp/v1/tokens/{tokenId}"

	payload := strings.NewReader("{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.spirii.com/emsp/v1/tokens/{tokenId}")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.spirii.com/emsp/v1/tokens/{tokenId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"visual_number\": \"<string>\",\n  \"issuer\": \"<string>\",\n  \"language\": \"<string>\",\n  \"valid_until\": \"2023-11-07T05:31:56Z\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "schema_version": "v1",
  "id": "<string>",
  "tenant_id": "<string>",
  "type": "RFID",
  "uid": "<string>",
  "contract_id": "<string>",
  "issuer": "<string>",
  "whitelist": "ALWAYS",
  "status": "PROVISIONED",
  "whitelist_distributed": true,
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated": "2023-11-07T05:31:56Z",
  "audit": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": "<string>"
  },
  "country_code": "<string>",
  "party_id": "<string>",
  "visual_number": "<string>",
  "language": "<string>",
  "valid_from": "2023-11-07T05:31:56Z",
  "valid_until": "2023-11-07T05:31:56Z",
  "group_id": "<string>",
  "emsp_group_id": "<string>",
  "metadata": {},
  "last_authorization": "2023-11-07T05:31:56Z",
  "invalidated_at": "2023-11-07T05:31:56Z"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

{
  "message": "<string>"
}

{
  "type": "/errors/validation-failed",
  "title": "Validation Failed",
  "status": 422,
  "detail": "<string>",
  "error_code": "RESOURCE_NOT_FOUND",
  "correlation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "retryable": true,
  "retry_after_seconds": 2,
  "errors": [
    {
      "field": "body.tokens[3].uid",
      "code": "INVALID_ENUM",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key

string<uuid>

required

Client-generated unique key per operation intent (UUID). Same key + identical body replays the original response; same key + different body returns 409.

Path Parameters

tokenId

string<uuid>

required

The token id

Body

application/json

visual_number

string | null

Send null to clear it

Required string length: 1 - 64

issuer

string

Cannot be cleared

Required string length: 1 - 100

language

string | null

Preferred language, e.g. en or da. Send null to clear it

Required string length: 2 - 10

valid_until

string<date-time> | null

Send null to remove the expiry

whitelist

enum<string>

Cannot be cleared

Available options:

ALWAYS,

ALLOWED,

ALLOWED_OFFLINE,

NEVER

metadata

object | null

Replaces the stored map rather than merging into it, and is validated against the tenant's active TOKEN metadata schema. A tenant without a TOKEN metadata schema cannot store metadata: any non-empty map is a 422. Send null to clear it

Response

The updated token

schema_version

enum<string>

required

Canonical schema version

Available options:

v1

string

required

Stable internal token id, commonly a UUIDv7

Maximum string length: 64

tenant_id

string

required

Owning tenant, set by the platform

type

enum<string>

required

Available options:

RFID,

APP_USER,

AD_HOC_USER,

EMAID,

OTHER

uid

string

required

Primary credential identifier, unique across every tenant on the platform

Maximum string length: 50

contract_id

string

required

Contract or credential identity, e.g. an eMAID

Maximum string length: 50

issuer

string

required

Issuer name associated with the credential

Maximum string length: 100

whitelist

enum<string>

required

OCPI whitelist policy

Available options:

ALWAYS,

ALLOWED,

ALLOWED_OFFLINE,

NEVER

status

enum<string>

required

Available options:

PROVISIONED,

ACTIVE,

SUSPENDED,

EXPIRED,

REVOKED

whitelist_distributed

boolean

required

Whether the token has been distributed to whitelist-capable CPO networks

created_at

string<date-time>

required

When the token was created in the platform registry

last_updated

string<date-time>

required

Canonical publication timestamp propagated to roaming partners

audit

object

required

Show child attributes

country_code

string | null

Derived from the EMSP identity that issues the token. Null when the registry does not carry it

Required string length: 2

party_id

string | null

Derived from the EMSP identity that issues the token. Null when the registry does not carry it

Required string length: 3

visual_number

string | null

Maximum string length: 64

language

string | null

Preferred language of the token owner

valid_from

string<date-time> | null

valid_until

string<date-time> | null

group_id

string | null

OCPI token group id used in roaming payloads. Unrelated to Spirii EMSP token groups

Maximum string length: 50

emsp_group_id

string | null

Primary Spirii EMSP token group. A convenience only: membership is many-to-many and is managed through POST /emsp/v1/token-groups/{groupId}/tokens. Null when the registry names no primary group

Maximum string length: 50

metadata

object | null

Name/value pairs validated against the tenant's active TOKEN metadata schema

last_authorization

string<date-time> | null

invalidated_at

string<date-time> | null

Get started

Spirii API (v2, CPO)

EMSP API (BETA)

Billing API

Energy Management API

Legacy API

Update token attributes

Authorizations

Headers

Path Parameters

Body

Response