GET
/
v1
/
documents
/
tasks
/
{task_id}
curl --request GET \
  --url https://api.openregisters.com/v1/documents/tasks/{task_id} \
  --header 'X-API-Key: <api-key>'
{
  "task_id": "<string>",
  "org_id": "<string>",
  "task_status": "pending",
  "result": {
    "http_url": "<string>",
    "content_type": "<string>",
    "original_filename": "<string>",
    "file_type": "<string>",
    "error": "<string>"
  }
}

Authorizations

​
X-API-Key
string
header
required

Sign up at OpenRegisters.com to get an API key

Path Parameters

​
task_id
string
required

Response

200
application/json
Successful Response
​
task_id
string
required

ID of the triggered download task.

​
org_id
string
required

ID of the Organization the task was created in

​
task_status
enum<string>
Available options:
done,
failed,
pending
​
result
object | null

Response model for document downloads.