> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.ocpplab.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.ocpplab.io/_mcp/server.

# Invite a roaming partner (admin)

POST https://api.ocpplab.io/ocpi/partners/invites
Content-Type: application/json

Returns Token A and the handshake URLs to hand to the partner, once.

Reference: https://docs.ocpplab.io/api-reference/ocpi/invites/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a PartnerInviteCreateRequest.

- `country_code` (string, required)
- `party_id` (string, required)
- `role` (enum, optional, nullable)
  - Allowed values: `CPO`, `EMSP`
- `version` (enum, optional, default: 2.2.1)
  - Allowed values: `2.1.1`, `2.2.1`, `2.3.0`
- `token_value` (string, optional, nullable) — Custom Token A; generated when omitted.
- `expires_days` (integer, optional, nullable)
- `gateway_role` (enum, optional, nullable)
  - Allowed values: `cpo`, `emsp`

## Response

### 201

Successful Response

- `token` (string, required)
- `authorization_header_211` (string, required)
- `authorization_header_221` (string, required)
- `role` (enum, required)
  - Allowed values: `CPO`, `EMSP`
- `version` (enum, required)
  - Allowed values: `2.1.1`, `2.2.1`, `2.3.0`
- `partner_country_code` (string, required)
- `partner_party_id` (string, required)
- `expires_at` (datetime, required)
- `versions_url` (string, required)
- `version_detail_url` (string, required)
- `credentials_url` (string, required)
- `steps` (list of string, required)
- `invite_id` (integer, optional, nullable)
- `partner_operation_id` (integer, optional, nullable)
- `action` (enum, optional, nullable)
  - Allowed values: `created`, `updated`

## Errors

### 401 Unauthorized Error

Missing or invalid Bearer token

- `detail` (string, required) — Human-readable error message returned by the API.

### 403 Forbidden Error

Admin role required

- `detail` (string, required) — Human-readable error message returned by the API.

### 409 Conflict Error

Already exists or not allowed in its current state

- `detail` (string, required) — Human-readable error message returned by the API.

### 422 Unprocessable Entity Error

Validation Error

- `detail` (list of ValidationError, optional) — One entry per invalid field.

### 429 Too Many Requests Error

Gateway rate limit reached; retry after the given seconds

- `detail` (string, required) — Human-readable error message returned by the API.

### 502 Bad Gateway Error

Gateway unreachable, failing, or misconfigured

- `detail` (string, required) — Human-readable error message returned by the API.

### 504 Gateway Timeout Error

Gateway timed out

- `detail` (string, required) — Human-readable error message returned by the API.

## Types

### ValidationError

Why one field is invalid.

- `loc` (list of ValidationErrorLocItems, required) — Where the field is: ``body`` / ``query`` / ``path`` / ``header``, then its name.
- `msg` (string, required) — What is wrong, in English.
- `type` (string, required) — Machine-readable error code, e.g. ``missing``.
- `input` (any, optional) — The value that was sent.
- `ctx` (ValidationErrorCtx, optional) — Details of the rule that failed, e.g. `{"le": 200}`.

### ValidationErrorLocItems

### ValidationErrorCtx

Details of the rule that failed, e.g. `{"le": 200}`.

## Examples

**Request**

```json
{
  "country_code": "DE",
  "party_id": "EMS",
  "role": "EMSP",
  "version": "2.2.1",
  "expires_days": 30
}
```

**Response**

```json
{
  "token": "3f1c9e8a-7b2d-4c5e-9f0a-1b2c3d4e5f6a",
  "authorization_header_211": "Token 3f1c9e8a-7b2d-4c5e-9f0a-1b2c3d4e5f6a",
  "authorization_header_221": "Token M2YxYzllOGEtN2IyZC00YzVlLTlmMGEtMWIyYzNkNGU1ZjZh",
  "role": "EMSP",
  "version": "2.2.1",
  "partner_country_code": "DE",
  "partner_party_id": "EMS",
  "expires_at": "2026-10-30T10:00:00Z",
  "versions_url": "https://ocpi.ocpplab.io/ocpi/cpo/versions",
  "version_detail_url": "https://ocpi.ocpplab.io/ocpi/cpo/2.2.1",
  "credentials_url": "https://ocpi.ocpplab.io/ocpi/cpo/2.2.1/credentials",
  "steps": [
    "Send the token to the partner over a secure channel",
    "The partner calls GET versions_url with 'Authorization: Token <token>'",
    "The partner POSTs its credentials to credentials_url"
  ],
  "invite_id": 12,
  "partner_operation_id": 7,
  "action": "created"
}
```

**SDK Code**

```python
import requests

url = "https://api.ocpplab.io/ocpi/partners/invites"

payload = {
    "country_code": "DE",
    "party_id": "EMS",
    "role": "EMSP",
    "version": "2.2.1",
    "expires_days": 30
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://api.ocpplab.io/ocpi/partners/invites';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"country_code":"DE","party_id":"EMS","role":"EMSP","version":"2.2.1","expires_days":30}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

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

func main() {

	url := "https://api.ocpplab.io/ocpi/partners/invites"

	payload := strings.NewReader("{\n  \"country_code\": \"DE\",\n  \"party_id\": \"EMS\",\n  \"role\": \"EMSP\",\n  \"version\": \"2.2.1\",\n  \"expires_days\": 30\n}")

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

	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(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.ocpplab.io/ocpi/partners/invites")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"country_code\": \"DE\",\n  \"party_id\": \"EMS\",\n  \"role\": \"EMSP\",\n  \"version\": \"2.2.1\",\n  \"expires_days\": 30\n}"

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

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.ocpplab.io/ocpi/partners/invites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"country_code\": \"DE\",\n  \"party_id\": \"EMS\",\n  \"role\": \"EMSP\",\n  \"version\": \"2.2.1\",\n  \"expires_days\": 30\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.ocpplab.io/ocpi/partners/invites', [
  'body' => '{
  "country_code": "DE",
  "party_id": "EMS",
  "role": "EMSP",
  "version": "2.2.1",
  "expires_days": 30
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.ocpplab.io/ocpi/partners/invites");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"country_code\": \"DE\",\n  \"party_id\": \"EMS\",\n  \"role\": \"EMSP\",\n  \"version\": \"2.2.1\",\n  \"expires_days\": 30\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "country_code": "DE",
  "party_id": "EMS",
  "role": "EMSP",
  "version": "2.2.1",
  "expires_days": 30
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ocpplab.io/ocpi/partners/invites")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```