OpenAPI reference

Real-time authorization (eMSP Sender)

POST/tokens/{token_uid}/authorize

Real-time authorization request from a CPO. Per OCPI 2.1.1 §2.2.2 the CPO calls the eMSP's `/tokens/{token_uid}/authorize` to validate a token presented at a Charge Point.

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

Overview

POST /tokens/{token_uid}/authorize

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/{token_uid}/authorize

Real-time authorization request from a CPO. Per OCPI 2.1.1 §2.2.2 the CPO calls the eMSP's /tokens/{token_uid}/authorize to validate a token presented at a Charge Point.

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 POST 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"connector_ids":["1"],"evse_uids":["EVSE-CPO-211-001"],"location_id":"CPO-LOC-211-001"}'

Request

Path parameters

Name	Type	Required	Description
`token_uid`	`string`	Yes	Token.uid of the Token.

Query parameters

Name	Type	Required	Description
`type`	`TokenType`	No	Token.type of the Token, defaults to RFID if not provided.

Request body

application/json · Optional

Schema: LocationReferences

Field	Type	Required	Description
`location_id`	`string`	Yes	Unique identifier for the Location.
`evse_uids`	`string[]`	No	Unique identifiers for the EVSEs within the given Location.
`connector_ids`	`string[]`	No	Unique identifiers for the Connectors within the given Location.

Request example

1{
2  "connector_ids": [
3    "1"
4  ],
5  "evse_uids": [
6    "EVSE-CPO-211-001"
7  ],
8  "location_id": "CPO-LOC-211-001"
9}

Responses

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

`200` — successful response

application/json

Schema: AuthorizationInfoResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "allowed": "ALLOWED",
7    "location": {
8      "evse_uids": [
9        "EVSE-CPO-211-001"
10      ],
11      "location_id": "CPO-LOC-211-001"
12    }
13  }
14}

`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}

`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 POST 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"connector_ids":["1"],"evse_uids":["EVSE-CPO-211-001"],"location_id":"CPO-LOC-211-001"}'

OpenAPI reference

Real-time authorization (eMSP Sender)

POST/tokens/{token_uid}/authorize

Real-time authorization request from a CPO. Per OCPI 2.1.1 §2.2.2 the CPO calls the eMSP's `/tokens/{token_uid}/authorize` to validate a token presented at a Charge Point.

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

Overview

POST /tokens/{token_uid}/authorize

Absolute URL: https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/{token_uid}/authorize

Real-time authorization request from a CPO. Per OCPI 2.1.1 §2.2.2 the CPO calls the eMSP's /tokens/{token_uid}/authorize to validate a token presented at a Charge Point.

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 POST 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"connector_ids":["1"],"evse_uids":["EVSE-CPO-211-001"],"location_id":"CPO-LOC-211-001"}'

Request

Path parameters

Name	Type	Required	Description
`token_uid`	`string`	Yes	Token.uid of the Token.

Query parameters

Name	Type	Required	Description
`type`	`TokenType`	No	Token.type of the Token, defaults to RFID if not provided.

Request body

application/json · Optional

Schema: LocationReferences

Field	Type	Required	Description
`location_id`	`string`	Yes	Unique identifier for the Location.
`evse_uids`	`string[]`	No	Unique identifiers for the EVSEs within the given Location.
`connector_ids`	`string[]`	No	Unique identifiers for the Connectors within the given Location.

Request example

1{
2  "connector_ids": [
3    "1"
4  ],
5  "evse_uids": [
6    "EVSE-CPO-211-001"
7  ],
8  "location_id": "CPO-LOC-211-001"
9}

Responses

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

`200` — successful response

application/json

Schema: AuthorizationInfoResponse

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

Response example

1{
2  "status_code": 1000,
3  "status_message": "Success",
4  "timestamp": "2015-06-29T22:39:09Z",
5  "data": {
6    "allowed": "ALLOWED",
7    "location": {
8      "evse_uids": [
9        "EVSE-CPO-211-001"
10      ],
11      "location_id": "CPO-LOC-211-001"
12    }
13  }
14}

`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}

`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 POST 'https://ocpi-api.gridos.co/ocpi/emsp/2.1.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"connector_ids":["1"],"evse_uids":["EVSE-CPO-211-001"],"location_id":"CPO-LOC-211-001"}'

Real-time authorization (eMSP Sender)

Overview

How to call

Request

Path parameters

Query parameters

Request body

Request example

Responses

`200` — successful response

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

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page

Real-time authorization (eMSP Sender)

Overview

How to call

Request

Path parameters

Query parameters

Request body

Request example

Responses

`200` — successful response

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

`401` — unauthorized

`422` — validation error

Examples

Is this helpful?

AI Tools

On this page