GET
/
v1
/
documents
/
search
/
{document_type}
Search Real-Time Documents
curl --request GET \
  --url https://api.openregisters.com/v1/documents/search/{document_type} \
  --header 'X-API-Key: <api-key>'
{
  "http_url": "<string>",
  "content_type": "<string>",
  "original_filename": "<string>",
  "file_type": "<string>",
  "file_hash": "<string>",
  "error": "<string>",
  "s3_uri": "<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

Unified model for download responses and file metadata.

This model combines the functionality of both DocumentDownloadResponse and DownloadedFile, providing a single interface for handling downloaded files across the platform.

Used for:

  • API responses to clients (public fields)
  • Internal file tracking with S3 references
  • Integration layer file handling