Skip to main content
GET
Get a job

Get a job

Returns a job’s status and, once it completed, its result. Poll this endpoint after starting a job until status is completed or failed, or wait for the job’s webhook and read the result here. Recommended polling interval: every 5–10 seconds. Cost: 0 credits

Status values

Results

A completed job returns its result in results. Only the field of the job’s type is set, the other two are null. The document url is short-lived and presigned again on every read; read the job again for a fresh one. Results are returned for 12 hours after the job finished, until expires_at. After that results is null; read the regular endpoints instead. results is also null while the job is pending and when it failed.
Completed owners job

Failure reasons

Error cases

Authorizations

Authorization
string
header
required

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

Rejected keys return a JSON body {"message": "..."} naming the reason:

  • 401 API key is missing, API key is invalid, API key is disabled or API key has expired
  • 429 API key rate limit exceeded or API key usage limit exceeded

Path Parameters

job_id
string<uuid>
required

Job ID returned when the job was started. Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

Response

The job

id
string<uuid>
required

Unique job identifier. Example: f47ac10b-58cc-4372-a567-0e02b2c3d479

type
enum<string>
required
Available options:
company,
owners,
document
company_id
string
required

Company the job refreshes. For company and owners jobs this is the company's latest register ID, which differs from the requested one when the company moved to another register. Example: DE-HRB-F1103-267645

document_category
enum<string> | null
required
Available options:
current_printout,
chronological_printout,
historical_printout,
structured_information,
shareholder_list,
articles_of_association
status
enum<string>
required
Available options:
pending,
completed,
failed
reason
enum<string> | null
required

Why a failed job failed:

  • not_available: the register holds no such document for this company.
  • timeout: the Handelsregister did not answer in time; try again later.
  • internal_error: any other failure.
Available options:
not_available,
timeout,
internal_error
results
object | null
required

What a completed job produced, until expires_at. Null while the job is pending, when it failed, and after the results expired.

expires_at
string<date-time> | null
required

Until when a completed job returns results, 12 hours after it finished.

created_at
string<date-time>
required
finished_at
string<date-time> | null
required