POST
/
v1
/
documents
/
search_async
/
{document_type}
curl --request POST \
  --url https://api.openregisters.com/v1/documents/search_async/{document_type} \
  --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

​
document_type
enum<string>
required

The type of document to download

Available options:
AD,
CD,
SI,
HD,
shareholders,
articles

Query Parameters

​
company_name
string
required

The name of the company

​
register_number
string
required

The register number of the company

​
register_type
string
required

The register type (e.g., 'HRB', 'HRA')

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.