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}/enhancednow 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 HTTP202 with an orderId instead of the profile. Your integration should handle it:
- Read
data.orderIdfrom the202response. - Poll
GET /v2/orders/{orderId}with exponential backoff untildata.statusisSuccess. A status ofFailedmeans fulfilment failed. - Retrieve the profile from the order result.
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:- Replace those calls with
GET /v2/companies/{kyckrId}/enhancedfor HK companies. - Test the change.