Store credentials

POST /v1/transparenzregister/credentials

JavaScript

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

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

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: "[e-mail]"

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

201

Credentials stored successfully