Company Registry Report

1. Use /cra/{countryCode}/search/companies to find the ID for a company

2. Pass this ID to /cra/request to start the report process

3. Send requests to /cra/poll until the final document is returned

Request

post

This endpoint may retrieve the company JSON and document via two methods:

Automated retrieval using Company ID for supported countries

If the country supplied in countryCode is in the AutomatedCountry Model, and the supplied companyId is valid, the system will automatically fetch the document.

In order to ensure a valid companyId, please validate using /cra/{countryCode}/search/companies.

In this case, /cra/poll will resolve in around 5 minutes.

The /cra/{countryCode}/search/companies endpoint will not return a companyId for certain countries (empty string). In that case please refer to the information in the section below.

Manual request for unsupported countries or missing Company ID

In case of unsupported countries or missing companyId, Fill Easy will manually process the request. Retrieving this information may take longer (up to several days).

In any case, the endpoint returns a JWT token that should be used with the /cra/poll endpoint to retrieve the document when ready.

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

API Key authentication using x-client-id and x-client-secret headers.

x-client-secretstringRequired

The client secret used for API key authentication.

Body

application/json

Responses

200

Successfully initiated the request

application/json

400

Bad Request - Invalid input parameters

500

Internal server error

post

/cra/request

HTTPcURLJavaScriptPython

POST /cra/request HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "companyId": "0157548",
  "countryCode": "HK",
  "documentType": "companySearch"
}

Direct Company ID RequestChina Unified RequestManual Request

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U"
}

Poll Report

post

Poll this endpoint to check the status of a company registry report request. Keep polling until you receive a successful response with the message "CRA ready" and a presigned URL to download the document.

If the report is not ready yet, you will receive a 202 status code with the message "Report is pending".

Once the report is ready, the endpoint will bill the service and return a presigned URL valid for 1 hour to download the PDF document.

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

API Key authentication using x-client-id and x-client-secret headers.

x-client-secretstringRequired

The client secret used for API key authentication.

Body

application/json

tokenstringRequired

JWT token

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8UPattern: ^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$

Responses

200

Report is ready

application/json

202

Report is still being processed

application/json

400

Invalid token

500

Internal server error

post

/cra/poll

HTTPcURLJavaScriptPython

POST /cra/poll HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIn0.dozjgNryP4J3jVmNHl0w5N_XgL0n3I9PlFUP0THsR8U"
}

{
  "reportMetadata": {
    "reportDate": "2025-11-19",
    "countryCode": "HK",
    "status": "completed"
  },
  "originalDocuments": [
    {
      "link": "https://s3-presigned-url.com/document.pdf",
      "fileName": "document.pdf"
    }
  ],
  "companyIdentification": "null",
  "registrationDetails": "null",
  "location": "null",
  "management": "null",
  "ownership": "null",
  "shareCapital": "null",
  "operations": "null",
  "compliance": "null"
}

Search Companies by Name

post

This endpoint performs a search for companies in the respective country's Companies Registry by company name. It supports both English and Chinese company names and returns a list of matching companies.

Certain countries are unable to return a companyId - in those cases the idType in the response will be "Unavailable" and companyId will be an empty string.

The search will automatically detect if the input is in Chinese characters and adjust the search parameters accordingly.

The type of search is dependent on the country: Substring search: KY, TH Tokenized search (e.g. searching "PLE" will not result in "APPLE"): AU, SG Left partial search: HK Partial name search: US

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

API Key authentication using x-client-id and x-client-secret headers.

x-client-secretstringRequired

The client secret used for API key authentication.

Path parameters

countryCodestring · enumRequired

ISO 3166 alpha-2 country code in lowercase.

Pattern: ^[a-z]{2}(-[a-z]{2})?$Possible values:

Body

application/json

companyNamestringRequired

Company name to search (English or Chinese)

Responses

200

Successfully retrieved matching companies

application/json

400

Bad Request - Invalid input parameters

404

No matching companies found

500

Internal server error

post

/cra/{countryCode}/search/companies

HTTPcURLJavaScriptPython

POST /cra/{countryCode}/search/companies HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "companyName": "WING KAI INVESTMENT COMPANY LIMITED"
}

English searchChinese search

{
  "message": "Success",
  "result": [
    {
      "companyName": "WING KAI INVESTMENT COMPANY LIMITED",
      "companyId": "0123456",
      "idType": "BRN",
      "status": "Live",
      "nameType": "current",
      "incorporationType": "Company Limited by Shares",
      "entityCategory": "Private Company"
    }
  ]
}

Search Company Documents

post

This endpoint searches for and returns documents filed by a company with the Companies Registry. Documents are grouped by category (e.g., Annual Return, Director/Secretary Changes, Charges Filed, etc.).

You can optionally filter by document type and year to narrow down the results.

Document categories include: Annual Return, Director / Secretary Changes, Charges Filed, Incorporation & Name Change, Liquidation & Deregistration, Registered Office / Address, Share Capital, and Other.

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

API Key authentication using x-client-id and x-client-secret headers.

x-client-secretstringRequired

The client secret used for API key authentication.

Path parameters

countryCodestring · enumRequired

ISO 3166 alpha-2 country code.

Pattern: ^[a-z]{2}$Possible values:

Body

application/json

companyIdstringRequired

Company ID (e.g., BRN for Hong Kong, ACN for Australia)

documentTypestring · enumOptional

Optional filter by document type

Possible values:

documentYearnumberOptional

Optional filter by year

Responses

200

Successfully retrieved documents as a flat array

application/json

400

Bad Request - Invalid input parameters

404

No documents found

500

Internal server error

post

/cra/{countryCode}/search/documents

HTTPcURLJavaScriptPython

POST /cra/{countryCode}/search/documents HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "companyId": "12104666"
}

Basic searchFiltered search

{
  "message": "success",
  "result": [
    {
      "category": "Annual Return & Accounts",
      "documentYear": "2023",
      "documentName": "Annual Return",
      "pages": "5",
      "filingDate": "2023-12-15",
      "documentId": "12345678",
      "companyId": "12104666",
      "hasLinked": false
    },
    {
      "category": "Directors & Company Secretaries",
      "documentYear": "2023",
      "documentName": "Director Change",
      "pages": "2",
      "filingDate": "2023-11-10",
      "documentId": "12345679",
      "companyId": "12104666",
      "hasLinked": false
    }
  ]
}

Get Company Base Information

post

This endpoint retrieves the base information for a specific company from the Companies Registry using its Company ID.

For Hong Kong Companies, the information includes company name (English and Chinese), status, type, category, incorporation date, dissolution date (if applicable), and any remarks.

For other countries, the information includes company name, status, category, incorporation date, and other available details such as entity type, registration address, and remarks where applicable. The exact fields returned may vary depending on the data provided by each country’s registry.

Authorizations

ClientID & ClientSecret

x-client-idstringRequired

API Key authentication using x-client-id and x-client-secret headers.

x-client-secretstringRequired

The client secret used for API key authentication.

Path parameters

countryCodestring · enumRequired

ISO 3166 alpha-2 country code.

Pattern: ^[a-z]{2}(-[a-z]{2})?$Possible values:

Body

application/json

companyIdstringRequired

Company ID (e.g., BRN for Hong Kong, ACN for Australia)

Responses

200

Successfully retrieved company information

application/json

400

Bad Request - Invalid input parameters

404

Company not found

500

Internal server error

post

/cra/{countryCode}/search/company

HTTPcURLJavaScriptPython

POST /cra/{countryCode}/search/company HTTP/1.1
Host: sandbox.staging-api.fill-easy.com
x-client-id: YOUR_API_KEY
x-client-secret: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "companyId": "12104666"
}

{
  "message": "success",
  "result": {
    "companyId": "12104666",
    "idType": "BRN",
    "companyName": "ABC COMPANY LIMITED",
    "localName": "ABC公司有限公司",
    "status": "Live",
    "incorporationType": "Company Limited by Shares",
    "entityCategory": "Private Company",
    "dissolutionDate": "",
    "incorporationDate": "2015-03-20",
    "remarks": ""
  }
}