Skip to main content
POST
/
v1
/
transparenzregister
/
request
JavaScript
import Openregister from 'openregister';

const client = new Openregister({
  apiKey: process.env['OPENREGISTER_API_KEY'], // This is the default and can be omitted
});

const response = await client.transparenzregister.request.createV1();

console.log(response.request_id);
{
  "request_id": "<string>"
}

​
Submit a Transparenzregister request

Creates a new request and returns a request_id you use to poll for results. The typical flow is:
  1. Store your credentials with the credentials endpoint
  2. Submit a request here, providing the company_id and the matching credential_label
  3. Poll the result endpoint with the returned request_id until status is completed or failed

​
Test mode

Send X-Credential-Label: test to run against the Transparenzregister test environment. In test mode:
  • No company_id is required
  • No stored credentials are needed
  • The request costs 0 credits
  • The response mirrors the real flow but uses test data

​
Error cases

StatusCause
400Missing or invalid company_id
403Transparenzregister access not enabled for this account — contact support
404Company not found in Transparenzregister
422No credentials found for the given credential_label
Cost: 25 credits (0 credits when X-Credential-Label: test)

​
Notes

  • The returned request_id is stable — store it to retrieve results later

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Credential-Label
string
default:default

Label identifying which credentials to use. Uses 'default' if not provided. Example: "client_a"

Query Parameters

​
company_id
string

Unique company identifier. Required unless using X-Credential-Label=test. Example: DE-HRB-F1103-267645

Response

Document request submitted successfully

Response from submitting a document request.

​
request_id
string
required

Request ID for tracking the document request. Example: "req_12345678"