Sandbox Encryption Keys
Corporate Sandbox Encryption
On this page
API Security at HSBC
HSBC maintains a secure connection to its Corporate APIs through multiple layers of security:
- Transport Level Security - to secure the connection
- Client Credentials or Signed JSON Web token - to identify and authenticate
- Message Level Encryption - to secure the communication and authorise the exchange
To provide a representative test environment the Corporate Sandbox supports PGP encryption and the exchange of public and private keys via the sandbox project workflow.
Sandbox encryption keys
During the sandbox project creation workflow, a set of sandbox PGP encryptions keys is dynamically created and the key exchange procedure takes place automatically. This allows you to begin using our sandbox immediately as it removes any manual setup by the HSBC admin team.
To access the sandbox PGP encryption keys, first create a sandbox project using the create project workflow from the Dev Hub. Further details here: Sandbox Project - User Guide.
After creating a sandbox project for your chosen APIs you will be able to download the sandbox PGP keys by clicking the Download Keys button. This will then provide the following files for use in the sandbox message encryption process:
- On the Credential and Keys pane, click on the Download Keys button.
- A zip file containing the HSBC public key and the clients private and public keys is presented.
- Save the file to a secure location for use in the message encryption process.
Files provided include:
| File | Description |
|---|---|
| hsbc-public.key | Use the HSBC Public Key to encrypt the request sent to the Corporate API Sandbox. |
| client-private.key |
For Treasury APIs - use the Client Private key to sign the request sent to the Treasury API Sandbox and decrypt the response received from the Treasury API Sandbox. For Trade Finance APIs - sign the JSON Web Token using the Client Private key and send to the Trade Finance API Sandbox and decrypt the response received from the Trade Finance API Sandbox. |
| client-public.key | The Corporate API sandbox will use this key to encrypt the response message before sending, this file is included for reference purpose only. |
| client-pgp-keys.info | This file contains the default passphrase for the key files. |
Related articles
Knowledge article: API Security at HSBC
Knowledge article: Sandbox toolkit