Invite a roaming partner (admin)

POST

https://api.ocpplab.io/ocpi/partners/invites

POST

/ocpi/partners/invites

import { OcpplabSDK } from "ocpplab";
async function main() {
    const client = new OcpplabSDK({
        token: "YOUR_TOKEN_HERE",
    });
    await client.ocpi.invites.create({
        country_code: "DE",
        party_id: "EMS",
        role: "EMSP",
        version: "2.2.1",
        expires_days: 30,
    });
}
main();

{
  "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"
}

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

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

country_codestringRequiredformat: "^[A-Za-z]{2}$"

party_idstringRequiredformat: "^[A-Za-z0-9]{3}$"

roleenum or nullOptional

Allowed values:

versionenumOptionalDefaults to 2.2.1

Allowed values:

token_valuestring or nullOptional1-64 characters

Custom Token A; generated when omitted.

expires_daysinteger or nullOptional

gateway_roleenum or nullOptional

Allowed values:

Response

Successful Response

tokenstring

authorization_header_211string

authorization_header_221string

roleenum

Allowed values:

versionenum

Allowed values:

partner_country_codestring

partner_party_idstring

expires_atdatetime

versions_urlstring

version_detail_urlstring

credentials_urlstring

stepslist of strings

invite_idinteger or nullOptional

partner_operation_idinteger or nullOptional

actionenum or nullOptional

Allowed values:

Errors

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

502

Bad Gateway Error

504

Gateway Timeout Error