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 listed by the Documents endpoint, ordered with Create Order and retrieved asynchronously. The same structured data now comes back synchronously from Enhanced Profile.

Key points

  • New route: GET /v2/companies/{kyckrId}/enhanced now returns the HK Enhanced Profile.
  • No response changes: The structured data is identical to what the asynchronous 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 hasn’t returned the profile after about 40 seconds, the endpoint returns HTTP 202 with an orderId instead of the profile. Your integration should handle it:
  1. Read data.orderId from the 202 response.
  2. Poll GET /v2/orders/{orderId} with exponential backoff until data.status is Success. A status of Failed means fulfilment failed.
  3. Retrieve the profile from the order result.
If you prefer not to hold a connection open, you can still use POST /v2/companies/{kyckrId}/enhanced. It returns a 202 with an orderId immediately, and you poll the same way.
Don’t re-issue the GET request if you lose the orderId. This creates a new, separately billed order. Instead, call GET /v2/orders and filter on your customerReference.

Timeline

What you need to do

If you order the HK Enhanced Profile through Documents and Create Order:
  1. Replace those calls with GET /v2/companies/{kyckrId}/enhanced for HK companies.
  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