Request fresh data from the register
Not available yet
This operation is described here and is not served. A call to it returns 404.
No worker consumes the queue, and the jobs table records neither the type nor the company, so a job could neither run nor describe itself back to you.
Asks Registercheck to fetch current documents, financial statements or the ownership history of a company from the register. The work is asynchronous: poll the returned job, then read the refreshed resource.
Costs 10 credits.
Authorization
bearerAuth Your API key, sent as Authorization: Bearer rc_live_….
In: header
Header Parameters
Makes a retry safe. A request repeated with the same key within 24 hours returns
the first response (with Idempotent-Replayed: true) instead of acting twice.
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 <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A job to start.
Response 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://example.com/jobs" \ -H "Content-Type: application/json" \ -d '{ "type": "refresh_documents", "company_id": "3f1c2a9e-5b7d-4c8a-9e21-6d4f0b8a1c55" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "job", "type": "refresh_documents", "status": "queued", "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf", "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z", "failure": { "code": "register_unavailable", "message": "string" }}