OpenAPI reference

Sender authorize

POST/tokens/{token_uid}/authorize

Real-time authorization request. Returns OCPI 2004 for unknown tokens, 2002 when the request lacks a LocationReferences body, and 1000 + ALLOWED / BLOCKED otherwise.

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

Overview

POST /tokens/{token_uid}/authorize

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

Real-time authorization request. Returns OCPI 2004 for unknown tokens, 2002 when the request lacks a LocationReferences body, and 1000 + ALLOWED / BLOCKED otherwise.

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.2.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"evse_uids":["EVSE-001","EVSE-002"],"location_id":"LOC-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, defaults to RFID if not provided.

Request body

application/json · Optional

Schema: LocationReferences

Field	Type	Required	Description
`location_id`	`string`	Yes	—
`evse_uids`	`string[]`	No	—

Request example

1{
2  "evse_uids": [
3    "EVSE-001",
4    "EVSE-002"
5  ],
6  "location_id": "LOC-001"
7}

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": "2024-01-15T10:00:00Z",
5  "data": {
6    "allowed": "ALLOWED",
7    "authorization_reference": "AUTH-REF-001",
8    "info": {
9      "language": "en",
10      "text": "Charging authorized"
11    },
12    "location": {
13      "evse_uids": [
14        "EVSE-001"
15      ],
16      "location_id": "LOC-001"
17    },
18    "token": {
19      "contract_id": "NL-TNM-012345678905880-S",
20      "country_code": "NL",
21      "issuer": "MobilityPlus",
22      "language": "nl",
23      "last_updated": "2024-01-15T10:00:00Z",
24      "party_id": "TNM",
25      "type": "RFID",
26      "uid": "012345678905880",
27      "valid": true,
28      "visual_number": "DF000-2001-8999-1",
29      "whitelist": "ALLOWED"
30    }
31  }
32}

`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": 2001,
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.2.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"evse_uids":["EVSE-001","EVSE-002"],"location_id":"LOC-001"}'

OpenAPI reference

Sender authorize

POST/tokens/{token_uid}/authorize

Real-time authorization request. Returns OCPI 2004 for unknown tokens, 2002 when the request lacks a LocationReferences body, and 1000 + ALLOWED / BLOCKED otherwise.

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

Overview

POST /tokens/{token_uid}/authorize

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

Real-time authorization request. Returns OCPI 2004 for unknown tokens, 2002 when the request lacks a LocationReferences body, and 1000 + ALLOWED / BLOCKED otherwise.

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.2.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"evse_uids":["EVSE-001","EVSE-002"],"location_id":"LOC-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, defaults to RFID if not provided.

Request body

application/json · Optional

Schema: LocationReferences

Field	Type	Required	Description
`location_id`	`string`	Yes	—
`evse_uids`	`string[]`	No	—

Request example

1{
2  "evse_uids": [
3    "EVSE-001",
4    "EVSE-002"
5  ],
6  "location_id": "LOC-001"
7}

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": "2024-01-15T10:00:00Z",
5  "data": {
6    "allowed": "ALLOWED",
7    "authorization_reference": "AUTH-REF-001",
8    "info": {
9      "language": "en",
10      "text": "Charging authorized"
11    },
12    "location": {
13      "evse_uids": [
14        "EVSE-001"
15      ],
16      "location_id": "LOC-001"
17    },
18    "token": {
19      "contract_id": "NL-TNM-012345678905880-S",
20      "country_code": "NL",
21      "issuer": "MobilityPlus",
22      "language": "nl",
23      "last_updated": "2024-01-15T10:00:00Z",
24      "party_id": "TNM",
25      "type": "RFID",
26      "uid": "012345678905880",
27      "valid": true,
28      "visual_number": "DF000-2001-8999-1",
29      "whitelist": "ALLOWED"
30    }
31  }
32}

`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": 2001,
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.2.1/tokens/TOKEN123/authorize' \
2  -H "Authorization: Token $OCPI_TOKEN" \
3  -H 'Content-Type: application/json' \
4  -d '{"evse_uids":["EVSE-001","EVSE-002"],"location_id":"LOC-001"}'

Sender authorize

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

Sender authorize

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