ORoregister
v1

Store Transparenzregister credentials

Changed on

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.

post/v1/transparenzregister/credentials

Request

  • Base URL
    https://api.openregister.de
  • Auth
    HTTP bearer

Request body

namestring

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"

usernamestring required

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

passwordstring password required

Password for Transparenzregister API access.

Response

Credentials stored successfully

Changes