Skip to main content
POST
/
v1
/
transparenzregister
/
credentials
JavaScript
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' });

​
Store Transparenzregister credentials

Stores Transparenzregister login credentials so that subsequent extract requests can authenticate on your behalf. Use the body field name 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

StatusMeaning
201Credentials stored successfully
400Invalid body (e.g. reserved name sandbox, missing username/password)
401Not authenticated, or Transparenzregister rejected the provided username/password
403Transparenzregister access is not enabled for this account — contact support
500Internal server error
Cost: 0 credits

Authorizations

​
Authorization
string
header
required

API Key Authentication Provide your API key as a Bearer token in the Authorization header.

Body

application/json

Credentials for accessing the Transparenzregister API.

​
username
string
required

Username for Transparenzregister API access. Example: "compliance@example.com"

​
password
string<password>
required

Password for Transparenzregister API access.

​
name
string
default:default

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