v1

latestOpenAPI 3.1.02026-07-2623108126.0 KB

Get Transparenzregister extract

Get the results of a Transparenzregister extract request. This endpoint handles all internal complexity including polling request status, selecting all available documents, creating Transparenzregister baskets, and returning download URLs when ready. If the request is still processing, it will return a pending status. Polling reuses the credential mode stored on the extract at create time. Sandbox extracts keep using the Transparenzregister test client automatically; no credential header is accepted on this endpoint.

get/v1/transparenzregister/extracts/{extract_id}

Path parameters

extract_idstring required

Extract ID from the submit endpoint. Example: "tre_12345678"

Response

Extract retrieved successfully

idstring required

Stable extract identifier. Example: "tre_12345678"

status'completed' | 'processing' | 'failed' required

Status of the Transparenzregister extract.

company_idstring nullable

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

ekrnstring nullable

EKRN used to request this extract.

reference_numberstring nullable

Transparenzregister reference number from the extract.

submitted_atstring date-time

Timestamp when extract submission started.

completed_atstring date-time nullable

Timestamp when extract processing completed.