OpenAPI reference

Receiver Tokens

PUT/tokens/{country_code}/{party_id}/{token_uid}

New or updated Token objects are pushed from the eMSP to the CPO.

API: OCPI 2.1.1 (CPO) · Module: Tokens (CPO)
Base path: /tokens · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

PUT /tokens/{country_code}/{party_id}/{token_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}

New or updated Token objects are pushed from the eMSP to the CPO.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"100012","type":"RFID","auth_id":"FA54320","visual_number":"DF000-2001-8999","issuer":"TheNewMotion","valid":true,"whitelist":"ALWAYS","language":"en","last_updated":"2015-06-21T22:39:05Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code of the party performing this request.
`party_id`	`string`	Yes	3-char party ID of the CPO or eMSP (ISO-15118).
`token_uid`	`string`	Yes	Token.uid of the Token.

Request body

application/json · Required

Schema: Token

Field	Type	Required	Description
`uid`	`string`	Yes	Unique ID by which this Token can be identified.
`type`	`"RFID"	"OTHER"`	Yes
`auth_id`	`string`	Yes	Uniquely identifies the EV driver contract token within the eMSP.
`visual_number`	`string`	No	Visual readable number/identification printed on the Token.
`issuer`	`string`	Yes	Issuing company, usually the connected eMSP.
`valid`	`boolean`	Yes	Is this Token valid.
`whitelist`	`"ALWAYS"	"ALLOWED"	"ALLOWED_OFFLINE"
`language`	`string`	No	ISO 639-1 language code of the Token owner's preferred language.
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "uid": "100012",
3  "type": "RFID",
4  "auth_id": "FA54320",
5  "visual_number": "DF000-2001-8999",
6  "issuer": "TheNewMotion",
7  "valid": true,
8  "whitelist": "ALWAYS",
9  "language": "en",
10  "last_updated": "2015-06-21T22:39:05Z"
11}

Example 2

1{
2  "uid": "APPUSER-99",
3  "type": "OTHER",
4  "auth_id": "EMP-99001",
5  "issuer": "Example Mobility",
6  "valid": true,
7  "whitelist": "ALLOWED",
8  "last_updated": "2015-06-23T08:00:00Z"
9}

Responses

Status	Description	Schema
`200`	Successful Response	`OneTokenResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: OneTokenResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`Token`	No	`Token`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "auth_id": "DE8ACC12E46L89",
7    "issuer": "TheNewMotion",
8    "language": "en",
9    "last_updated": "2015-06-29T22:39:09Z",
10    "type": "RFID",
11    "uid": "012345678",
12    "valid": true,
13    "visual_number": "DF000-2001-8999",
14    "whitelist": "ALLOWED"
15  }
16}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"100012","type":"RFID","auth_id":"FA54320","visual_number":"DF000-2001-8999","issuer":"TheNewMotion","valid":true,"whitelist":"ALWAYS","language":"en","last_updated":"2015-06-21T22:39:05Z"}'

OpenAPI reference

Receiver Tokens

PUT/tokens/{country_code}/{party_id}/{token_uid}

New or updated Token objects are pushed from the eMSP to the CPO.

API: OCPI 2.1.1 (CPO) · Module: Tokens (CPO)
Base path: /tokens · Base URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1

Overview

PUT /tokens/{country_code}/{party_id}/{token_uid}

Absolute URL: https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/{country_code}/{party_id}/{token_uid}

New or updated Token objects are pushed from the eMSP to the CPO.

Requires authentication. Use Authorization: Token <token>. See OCPI credentials.

How to call

Quick Shell sample (set OCPI_TOKEN when auth is required). Full Python and TypeScript under Examples.

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"100012","type":"RFID","auth_id":"FA54320","visual_number":"DF000-2001-8999","issuer":"TheNewMotion","valid":true,"whitelist":"ALWAYS","language":"en","last_updated":"2015-06-21T22:39:05Z"}'

Request

Path parameters

Name	Type	Required	Description
`country_code`	`string`	Yes	ISO-3166 alpha-2 country code of the party performing this request.
`party_id`	`string`	Yes	3-char party ID of the CPO or eMSP (ISO-15118).
`token_uid`	`string`	Yes	Token.uid of the Token.

Request body

application/json · Required

Schema: Token

Field	Type	Required	Description
`uid`	`string`	Yes	Unique ID by which this Token can be identified.
`type`	`"RFID"	"OTHER"`	Yes
`auth_id`	`string`	Yes	Uniquely identifies the EV driver contract token within the eMSP.
`visual_number`	`string`	No	Visual readable number/identification printed on the Token.
`issuer`	`string`	Yes	Issuing company, usually the connected eMSP.
`valid`	`boolean`	Yes	Is this Token valid.
`whitelist`	`"ALWAYS"	"ALLOWED"	"ALLOWED_OFFLINE"
`language`	`string`	No	ISO 639-1 language code of the Token owner's preferred language.
`last_updated`	`string (date-time)`	Yes	—

Request examples

Example 1

1{
2  "uid": "100012",
3  "type": "RFID",
4  "auth_id": "FA54320",
5  "visual_number": "DF000-2001-8999",
6  "issuer": "TheNewMotion",
7  "valid": true,
8  "whitelist": "ALWAYS",
9  "language": "en",
10  "last_updated": "2015-06-21T22:39:05Z"
11}

Example 2

1{
2  "uid": "APPUSER-99",
3  "type": "OTHER",
4  "auth_id": "EMP-99001",
5  "issuer": "Example Mobility",
6  "valid": true,
7  "whitelist": "ALLOWED",
8  "last_updated": "2015-06-23T08:00:00Z"
9}

Responses

Status	Description	Schema
`200`	Successful Response	`OneTokenResponse`
`400`	Invalid or missing parameters (HTTP 200, OCPI envelope)	`—`
`401`	Unauthorized	`—`
`404`	Not Found	`—`
`422`	Validation Error	`HTTPValidationError`

`200` — successful response

application/json

Schema: OneTokenResponse

Field	Type	Required	Description
`status_code`	`integer`	No	Default: `1000`
`status_message`	`string`	No	—
`timestamp`	`string (date-time)`	No	—
`data`	`Token`	No	`Token`

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "auth_id": "DE8ACC12E46L89",
7    "issuer": "TheNewMotion",
8    "language": "en",
9    "last_updated": "2015-06-29T22:39:09Z",
10    "type": "RFID",
11    "uid": "012345678",
12    "valid": true,
13    "visual_number": "DF000-2001-8999",
14    "whitelist": "ALLOWED"
15  }
16}

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

application/json

Response example

1{
2  "status_code": 2001,
3  "status_message": "Invalid or missing parameters",
4  "timestamp": "2025-01-01T00:00:00Z",
5  "doc_url": "https://github.com/ocpplab/ocpi-gateway/blob/main/docs/errors.md#2001-invalid-parameters",
6  "errors": [
7    {
8      "field": "country_code",
9      "message": "expected 'NL' to match Token A identity",
10      "type": "value_error.identity_mismatch"
11    }
12  ]
13}

`401` — unauthorized

application/json

Response example

1{
2  "status_code": 2000,
3  "status_message": "Unauthorized",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`404` — not found

application/json

Response example

1{
2  "status_code": 2004,
3  "status_message": "Resource not found",
4  "timestamp": "2025-01-01T00:00:00Z"
5}

`422` — validation error

application/json

Schema: HTTPValidationError

Field	Type	Required	Description
`detail`	`ValidationError[]`	No	`Detail`

Response example

1{
2  "detail": [
3    {
4      "loc": [],
5      "msg": "string",
6      "type": "string",
7      "input": {
8        "_type": "Input"
9      },
10      "ctx": {
11        "_type": "Context"
12      }
13    }
14  ]
15}

Examples

Shell, Python, and TypeScript (set OCPI_TOKEN when auth is required).

1curl -sS -X PUT 'https://ocpi-api.gridos.co/ocpi/cpo/2.1.1/tokens/NL/ABC/TOKEN123' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"uid":"100012","type":"RFID","auth_id":"FA54320","visual_number":"DF000-2001-8999","issuer":"TheNewMotion","valid":true,"whitelist":"ALWAYS","language":"en","last_updated":"2015-06-21T22:39:05Z"}'

Receiver Tokens

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Receiver Tokens

Overview

How to call

Request

Path parameters

Request body

Request examples

Responses

`200` — successful response

`400` — invalid or missing parameters (HTTP 200, OCPI envelope)

`401` — unauthorized

`404` — not found

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page