> 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.

# Read the stored handshake with a partner (admin)

GET https://api.ocpplab.io/ocpi/credentials/{version}/{role}

Admin only. Returns the stored handshake with a partner for the path version and role: its endpoints, token state and last exchange.

Reference: https://docs.ocpplab.io/api-reference/ocpi/credentials/status

## Authentication

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

## Request

### Path parameters

- `version` (enum, required) — OCPI version: ``211`` (2.1.1), ``221`` (2.2.1) or ``230`` (2.3.0).
  - Allowed values: `211`, `221`, `230`
- `role` (enum, required) — Our OCPI role for this partner.
  - Allowed values: `cpo`, `emsp`

### Query parameters

- `partner_id` (integer, required) — Roaming partner to talk to (from ``GET /ocpi/partners``).

## Response

### 200

Successful Response

- `partner_id` (integer, required)
- `version` (enum, required)
  - Allowed values: `2.1.1`, `2.2.1`, `2.3.0`
- `action` (enum, required)
  - Allowed values: `registered`, `updated`, `unregistered`, `unregistered_local`, `status`
- `credentials_url` (string, optional, nullable)
- `versions_url` (string, optional, nullable)
- `endpoints` (list of map from string to any, optional, nullable)
- `tokens_deactivated` (integer, optional, nullable)
- `error` (string, optional, nullable)

## 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.

### 404 Not Found Error

Not found for this organization

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

**Response**

```json
{
  "partner_id": 7,
  "version": "2.2.1",
  "action": "status",
  "credentials_url": "https://emsp.example.com/ocpi/2.2.1/credentials",
  "versions_url": "https://emsp.example.com/ocpi/versions",
  "endpoints": [
    {
      "identifier": "tokens",
      "role": "RECEIVER",
      "url": "https://emsp.example.com/ocpi/2.2.1/tokens"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.ocpplab.io/ocpi/credentials/221/cpo"

querystring = {"partner_id":"7"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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/credentials/221/cpo?partner_id=7")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.get("https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.ocpplab.io/ocpi/credentials/221/cpo?partner_id=7")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```