Cancel a job that has not started
Cancels a queued job and refunds it in full. A job that is running or already
finished (succeeded, failed or canceled) answers 409 conflict.
Free.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Path Parameters
The job's id.
^job_[0-7][0-9a-hjkmnp-tv-z]{25}$Header Parameters
Makes a retry safe. A request repeated with the same key within 24 hours returns
the first successful response (with Idempotent-Replayed: true) instead of acting
twice; an error is not stored, so its retry runs again. Reusing a key with a different
body returns 422; retrying while the first request is still running returns 409.
Use a random UUID.
1 <= length <= 255Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://api.registercheck.de/v1/jobs/job_71yahv9hep9szrn6rc3mq3yjjv/cancel" \ -H "Authorization: Bearer $REGISTERCHECK_API_KEY"{ "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": "canceled", "status_details": { "running": null, "failed": null, "canceled": { "reason": "requested" } }, "status_transitions": { "running_at": null, "succeeded_at": null, "failed_at": null, "canceled_at": "2026-11-05T10:00:05Z" }, "result": null, "credits": { "charged": 25, "refunded": 25 }, "metadata": { "case_id": "KYB-2026-118204" }, "created_at": "2026-11-05T10:00:02Z"}