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

# Get the Peppol registration status

GET https://service.invoice-api.xhub.io/api/v1/peppol/registration

Lifecycle state of the participant registration (unregistered/pending/active/deregistering/failed). Query param: `environment` (sandbox|production, default production).

Reference: https://docs.invoice-api.xhub.io/api-reference/peppol/get-registration

## Authentication

- `Authorization` header (bearer token, required) — API Key authentication. Use `sk_live_*` for production or `sk_test_*` for testing.

## Servers

- `https://service.invoice-api.xhub.io` (Invoice API v1 (production), default)
- `/` (Diese Instanz (lokale Entwicklung))

## Response

### 200

Registration state (settings null when nothing configured)

- `success` (boolean, required)
- `settings` (ApiV1PeppolRegistrationGetResponsesContentApplicationJsonSchemaSettings, required, nullable) — Registration lifecycle state (null when nothing is configured)
- `errorCode` (string, optional)
- `errorMessage` (string, optional)

## Errors

### 501 Not Implemented Error

Registration layer not available in this deployment yet

- `error` (string, required)
- `missing` (string, required)

## Types

### ApiV1PeppolRegistrationGetResponsesContentApplicationJsonSchemaSettings

Registration lifecycle state (null when nothing is configured)

- `senderPeppolId` (string, optional)
- `registrationStatus` (enum, optional)
  - Allowed values: `unregistered`, `pending`, `active`, `deregistering`, `failed`
- `registrationError` (string, optional, nullable)
- `registeredAt` (datetime, optional, nullable)
- `enabled` (boolean, optional)
- `environment` (enum, optional) — Peppol settings scope to use (which provider config + API key)
  - Allowed values: `sandbox`, `production`

## Examples

**Response**

```json
{
  "success": true,
  "settings": {
    "senderPeppolId": "string",
    "registrationStatus": "unregistered",
    "registrationError": "string",
    "registeredAt": "2024-01-15T09:30:00Z",
    "enabled": true,
    "environment": "sandbox"
  },
  "errorCode": "string",
  "errorMessage": "string"
}
```

**SDK Code**

```python
import requests

url = "https://service.invoice-api.xhub.io/api/v1/peppol/registration"

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

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

print(response.json())
```

```javascript
const url = 'https://service.invoice-api.xhub.io/api/v1/peppol/registration';
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://service.invoice-api.xhub.io/api/v1/peppol/registration"

	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://service.invoice-api.xhub.io/api/v1/peppol/registration")

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://service.invoice-api.xhub.io/api/v1/peppol/registration")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://service.invoice-api.xhub.io/api/v1/peppol/registration', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://service.invoice-api.xhub.io/api/v1/peppol/registration");
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://service.invoice-api.xhub.io/api/v1/peppol/registration")! 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()
```