import Openregister from 'openregister';
const client = new Openregister({
apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});
await client.transparenzregister.setCredentialsV1({ password: 'password', username: 'username' });import os
from openregister import Openregister
client = Openregister(
api_key=os.environ.get("OPENREGISTER_API_KEY"), # This is the default and can be omitted
)
client.transparenzregister.set_credentials_v1(
password="password",
username="username",
)package main
import (
"context"
"github.com/oregister/openregister-go"
"github.com/oregister/openregister-go/option"
)
func main() {
client := openregister.NewClient(
option.WithAPIKey("My API Key"),
)
err := client.Transparenzregister.SetCredentialsV1(context.TODO(), openregister.TransparenzregisterSetCredentialsV1Params{
Password: "password",
Username: "username",
})
if err != nil {
panic(err.Error())
}
}
openregister transparenzregister set-credentials-v1 \
--api-key 'My API Key' \
--password password \
--username usernamecurl --request POST \
--url https://api.openregister.de/v1/transparenzregister/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"password": "<string>",
"name": "default"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openregister.de/v1/transparenzregister/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'password' => '<string>',
'name' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.openregister.de/v1/transparenzregister/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"name\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openregister.de/v1/transparenzregister/credentials")
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 \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"name\": \"default\"\n}"
response = http.request(request)
puts response.read_bodyStore credentials
Store username and password credentials for accessing the Transparenzregister API.
These credentials will be used for subsequent requests to retrieve company documents.
Credential names are user-scoped; the reserved name sandbox cannot be used.
Credentials are validated against Transparenzregister before they are persisted.
import Openregister from 'openregister';
const client = new Openregister({
apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});
await client.transparenzregister.setCredentialsV1({ password: 'password', username: 'username' });import os
from openregister import Openregister
client = Openregister(
api_key=os.environ.get("OPENREGISTER_API_KEY"), # This is the default and can be omitted
)
client.transparenzregister.set_credentials_v1(
password="password",
username="username",
)package main
import (
"context"
"github.com/oregister/openregister-go"
"github.com/oregister/openregister-go/option"
)
func main() {
client := openregister.NewClient(
option.WithAPIKey("My API Key"),
)
err := client.Transparenzregister.SetCredentialsV1(context.TODO(), openregister.TransparenzregisterSetCredentialsV1Params{
Password: "password",
Username: "username",
})
if err != nil {
panic(err.Error())
}
}
openregister transparenzregister set-credentials-v1 \
--api-key 'My API Key' \
--password password \
--username usernamecurl --request POST \
--url https://api.openregister.de/v1/transparenzregister/credentials \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"username": "<string>",
"password": "<string>",
"name": "default"
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.openregister.de/v1/transparenzregister/credentials",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'username' => '<string>',
'password' => '<string>',
'name' => 'default'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://api.openregister.de/v1/transparenzregister/credentials")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"name\": \"default\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.openregister.de/v1/transparenzregister/credentials")
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 \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"name\": \"default\"\n}"
response = http.request(request)
puts response.read_bodyStore Transparenzregister credentials
Stores Transparenzregister login credentials so that subsequent extract requests can authenticate on your behalf. Use the body fieldname to identify this credential set. If omitted, name defaults to default. You can store multiple named credential sets (e.g. per client). Submitting the same name again overwrites the stored credentials for that name without affecting extracts already in flight.
The reserved name sandbox cannot be used — it is reserved for test-mode extracts via X-Credential-Name: sandbox on the order extract endpoint. Using sandbox as a credential name returns 400.
Your credentials are encrypted at rest. The plaintext values never touch our database — only encrypted ciphertext is persisted, and every decryption is logged and auditable.
Responses
| Status | Meaning |
|---|---|
201 | Credentials stored successfully |
400 | Invalid body (e.g. reserved name sandbox, missing username/password) |
401 | Not authenticated, or Transparenzregister rejected the provided username/password |
402 | Transparenzregister API access requires a paid API plan — contact us |
409 | Maximum number of stored credential sets reached for this account |
500 | Internal server error |
Authorizations
API Key Authentication Provide your API key as a Bearer token in the Authorization header.
Body
Credentials for accessing the Transparenzregister API.
Username for Transparenzregister API access. Example: "compliance@example.com"
Password for Transparenzregister API access.
Name to identify this set of credentials. Allows storing multiple
Transparenzregister credentials per user (e.g., for different accounts
or clients). Defaults to 'default' if not provided.
Cannot be sandbox because that name is reserved for test-mode extracts.
Example: "client_a"
Response
Credentials stored successfully
Was this page helpful?

