The BOCHK Open API portal is a platform containing a set of APIs, which offers users the right to access data within BOCHK, for instance when different data is required for onboarding processes or the development of new functions.
The portal contains a ‘sandbox’, where API calls with the same form and function as our production environment can be made. The 'sandbox' contains mock data for testing prototypes, which protects our clients and validate our products before the official production stage.
Our API index page will show you the available APIs. If you have any innovative business idea, we strongly recommend you to sign up an account for more information.
For sandbox environment, it uses dummy data to provide an easily accessible testing environment, so that TSPs can test whether the APIs are suitable for their needs before go live for their application. For production environment, it is using real-life data which is intended to use by end users.
It is currently free of charge to access our 'sandbox' and 'production'. All prospective partners are welcome to use the portal.
To ensure the security of customer data, please install any of the recommended browser versions to log into the developer portal:
- Microsoft Internet Explorer (Version 11 or above)
- Mozilla Firefox (Version 48 or above)
- Apple Safari (Version 11 or above)
- Google Chrome (Version 43 or above)
Our system upgrade has been scheduled as follows. The affected services will not be available during this period.
| Date* | Period* | Services Affected |
|---|---|---|
| Every Monday to Sunday | 02:30-07:00 | Developer portal / Sandbox / Gateway |
* The system upgrade schedule could be adjusted without prior notice.
* Date and period are in Hong Kong Time.
To report bugs or to provide suggestions, please contact us at api@bochk.com
Email notification messages are generated in response to certain events, such as status update of your application
Once your account is created, an email containing the verification code will be sent to your registered email account. Please go to login page and click “Account Activation” to input the verification code in order to activate your account.
For security concern, we restrict the user ability to edit account information. If you need to edit your account information, please contact us atapi@bochk.com.
By clicking the "Sign up" button and filling in the required information, a new account for the developer portal will be generated after email verification.
Sandboxes for product information type APIs are generally available for all portal users upon registration. If you wish to access to sandboxes for product application type APIs, you are required to submit relevant documents as instructed.
Your account will be suspended after 5 failed login attempts. To restore a suspended account, please head to the login page and click the "Forgot Your Password" button. Follow all the steps to reset a new password. If you need further assistance, please contact us atapi@bochk.com.
You may click the "Forgot Your Password" button, which is located on the login page.
Application(s) can be created by clicking the "Create Application" button after logged in to your account. Once submitted the application, a sandbox access token (the API key and the client-specific "client secret") will be generated for you to access the bundled APIs if the registered App only contains product information type of APIs. However, if the registered App contains product application type of APIs, the sandbox access token will be granted once your App has been approved.
We have related documentation available for each API that will help you set up the API in your App. You may check more information at the APIs section.
After fully tested the prototype, you may click "move to production" in application section and receive a set of production tokens. However, if the registered App contains application type of APIs, the production access token will be granted once your App has been approved.
If you need further assistance, please contact us at api@bochk.com.
Currently, there is no limit on the number of APIs that an application can subscribe to.
In order to use product application type of APIs, you must upload the certificate for both Sandbox and Production.
You are required to upload SSL Certificate for public key exchange in order to request access for your app. Please upload your certificate via the “Upload SSL Certificate” function.
Note: For product information type of APIs, no certificate is required throughout the application process.
You can manage the details and check the expiry date of your sandbox and production certificates under SSL Certificate maintenance page.
You cannot use the sandbox or production APIs for your App if the uploaded certificate has expired. To prevent any unwanted issues, we strongly recommend you to renew the certificate before expiration. After reuploaded valid certificates, the APIs will be worked again.
Note: Currently, the expired certificate will only affect the use for application type of APIs.