Sign in

v1

latestOpenAPI 3.1.02026-07-2623108126.0 KB
v1

Submit Transparenzregister extract request

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-Name to default or another stored credential name.
  • company_id is required and must resolve to exactly one Transparenzregister legal entity.
post/v1/transparenzregister/extracts

Headers

X-Credential-Namestring

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"

Request body

company_idstring

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

idstring required

Stable extract identifier. Use this to poll the get-extract endpoint. Example: "tre_12345678"

status'processing' required

Always processing on create. Poll the get-extract endpoint for terminal state.

company_idstring nullable required

Company identifier associated with this extract request. May be null when using sandbox credentials.

ekrnstring nullable required

EKRN used to request this extract.

submitted_atstring date-time required

Timestamp when extract submission started.