Skip to main content

​
Overview

The Hong Kong (HK) Enhanced Profile is now available directly from the Enhanced Profile endpoint, in the same way as other jurisdictions. Until now, the HK Enhanced Profile was returned by Filing Search as a document product, ordered with Product Order and retrieved asynchronously. The same structured data now comes back synchronously from Enhanced Profile.

​
Key points

  • New route: GET /core/company/profile/HK/{companyCode} now returns the HK Enhanced Profile.
  • No response changes: The structured data is identical to what the asynchronous product order returns. No changes to your parsing are needed.

​
What’s changing

​
If the registry responds slowly

The HK Enhanced Profile uses the asynchronous order pattern. If the registry can’t return the profile in time, the endpoint returns a pending response instead of the profile. Your integration should handle it. The pending response is also HTTP 200, so check the response body. It carries no profile data, only transactionIdField, responseCodeField and responseDetailsField.
  1. Read the transactionIdField from the pending response.
  2. Poll GET /core/filing/order-status/{orderedWithin} with exponential backoff, and find the item whose productOrderIdField matches your transactionIdField.
  3. When statusField is 2, 21 or 3, retrieve the profile from urlField or structuredDataUrlField. A status of 5 means the order failed.
Don’t re-issue the GET request if you lose the transactionIdField. This creates a new, separately billed order. Instead, filter the order-status results on your orderRef.

​
Timeline

​
What you need to do

If you order the HK Enhanced Profile through Filing Search and Product Order:
  1. Replace those calls with GET /core/company/profile/HK/{companyCode}, using the codeField from the search results as companyCode.
  2. Test the change.
You don’t need to do anything if you already use the Enhanced Profile endpoint for HK, or if you don’t order the HK Enhanced Profile.

​
Additional resources