Request fresh data from the register

Server URLloading...

POST

/jobs

Send

Authorization

Header

Body

Asks the register for the current documents of one company. The work is asynchronous: the answer is the job, and GET /jobs/{job_id} reads it.

Costs 25 credits. Charged when the job is accepted; the refreshed company in its result is included. Refunded in full when the job ends failed, or canceled before the register is asked. When the data already held is newer than max_age_seconds, the job succeeds at once without asking the register and costs 10 credits, the price of reading the company it returns (retrieval: stored). Free when this workspace already has an open job of this type for this company that covers the asked documents: that job comes back. The balance must hold 25 credits when the job is asked for, also when it then costs 10 or nothing: the difference comes back in the same call.

Scale and Enterprise only. Any other plan answers 403 job_requires_plan and is never charged (x-credit-cost-free-when: plan_without_jobs).

503 with Retry-After when the lane cannot take work.

Header Parameters

Response Body

curl -X POST "https://api.registercheck.de/v1/jobs" \  -H "Authorization: Bearer $REGISTERCHECK_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "type": "refresh_documents",    "subject_id": "cmp_01hxn3rys1fh58w4d1pb1x9s81",    "max_age_seconds": 3600,    "refresh_documents": {      "document_types": [        "current_register_extract",        "chronological_register_extract",        "structured_register_data",        "articles_of_association"      ]    },    "metadata": {      "case_id": "KYB-2026-118204"    }  }'

{  "object": "job",  "id": "job_71yahv9hep9szrn6rc3mq3yjjv",  "type": "refresh_documents",  "subject": {    "object": "company",    "id": "cmp_01hxn3rys1fh58w4d1pb1x9s81",    "name": "Beispiel Reisen GmbH"  },  "max_age_seconds": 3600,  "refresh_documents": {    "document_types": [      "current_register_extract",      "chronological_register_extract",      "structured_register_data"    ]  },  "status": "queued",  "status_details": {    "running": null,    "failed": null,    "canceled": null  },  "status_transitions": {    "running_at": null,    "succeeded_at": null,    "failed_at": null,    "canceled_at": null  },  "result": null,  "credits": {    "charged": 25,    "refunded": 0  },  "metadata": {    "case_id": "KYB-2026-118204"  },  "created_at": "2026-11-05T10:00:02Z"}