Order extract
Submit a Transparenzregister extract request and return an extract resource with processing status.
Sandbox integration testing (recommended for all non-production testing):
- Send
X-Credential-Name: sandbox. - Do not send
company_id(an empty body{}is valid). - OpenRegister uses the Transparenzregister test environment and built-in test authentication.
- The request is submitted with the fixed test EKRN
DE727032388716. - The response has
company_id: null.
Production usage:
- Always set
X-Credential-Nametodefaultor another stored credential name. company_idis required and must resolve to exactly one Transparenzregister legal entity.
Order a Transparenzregister extract
Places an order for a Transparenzregister extract and returns aTransparenzregisterExtract resource with processing status. Use the returned id as the polling handle.
The typical flow is:
- Store your credentials with the credentials endpoint
- Order an extract here with
company_id(production) or sandbox mode (see below) - Poll the get extract endpoint with the returned
iduntilstatusiscompletedorfailed
status leaves processing.
Sandbox mode (integration testing)
Send headerX-Credential-Name: sandbox and omit company_id (an empty body {} is valid). OpenRegister uses the EiS test environment at https://test2.api.transparenzregister.de with the built-in test user testnutzer-eis@transparenzregister.de. The request uses the fixed test EKRN DE727032388716; the response has company_id: null. Cost: 0 credits.
Production mode
Always setX-Credential-Name — use default or another stored credential name you use in production. company_id is required and must resolve to exactly one Transparenzregister legal entity.
Error cases
X-Credential-Name: sandbox)
Notes
- The returned
id(e.g.tre_12345678) is stable — store it to retrieve the extract later.
Authorizations
API Key Authentication Provide your API key as a Bearer token in the Authorization header.
Headers
Name identifying which credentials to use. Always send this header in production (typically default or another stored name).
Reserved values:
- default: use persisted default credentials for the current user.
- sandbox: use OpenRegister's built-in Transparenzregister test client, test authentication, and fixed test EKRN. Any other value selects persisted credentials with the same name for the current user. Example: "client_a"
Body
Request body for creating a Transparenzregister extract.
Unique company identifier.
Required unless X-Credential-Name is set to sandbox.
In sandbox mode this field should be omitted.
Example: DE-HRB-F1103-267645
Response
Extract request submitted successfully
Response from creating a Transparenzregister extract.
Only fields known at creation time are present.
Poll GET /v1/transparenzregister/extracts/{extract_id} to retrieve report and documents.
Stable extract identifier. Use this to poll the get-extract endpoint. Example: "tre_12345678"
Always processing on create.
Poll the get-extract endpoint for terminal state.
processing Company identifier associated with this extract request. May be null when using sandbox credentials.
EKRN used to request this extract.
Timestamp when extract submission started.

