Preparation
To interact with our Web Portal or API, you will need the following credentials and configurations.
What You Need to Get Started
To create a test account, your company must provide a fixed public IP address and a valid email address. The table below outlines the credentials that Cactus Custody will provide.
| Item/Credential | Description | Usage & Notes |
|---|---|---|
ukey |
Also known as Yubico Key: a hardware authentication device. The ukey is linked to your user account during the setup process. |
Required for operations such as login and order approvals. How to obtain: 1. Provide us with your address, and we will ship it to you (charges and shipping fees apply). 2. Alternatively, you may purchase the ukey directly from Amazon or other authorized sellers. |
apikey |
Used to authenticate and access our API endpoints. Obtain your API key from our custody team. | Insert the key into your configuration file. See example. |
akid |
An identifier generated by custody for signature verification and authentication. It is uniquely tied to a specific operator. The operator’s permissions determine the permissions of API requests made with this akid. |
How to obtain: 1. Log in as Administrator on our webpage. 2. Go to Users Management. 3. Click the ≡ icon and select API PUBLIC KEY. 4. Upload your generated public key file in PEM format. Click here for steps to generate your public key. 5. The corresponding user will receive the akid via email. |
wallet_code |
Wallet ID: Unique identifier for your wallet. | Config Path: Administrator Login → Business Lines Management → Configuration. Only Administrators can apply for and configure wallets. |
b_id |
Business Line ID: Identifies your business line within our system. | Retrieval Path: Administrator Login → Business Lines Management. |
Network Configuration
IP Whitelisting – For access to our test environment Web Portal
For security, only whitelisted IP addresses can access our test environment.
- Requirement: A fixed public IP address.
- Alternative: If a fixed IP is not available, a proxy can be used to access the system.
- Check your IP: Visit https://checkip.amazonaws.com/ to verify your public IP.
API IP Whitelist
This step is essential for accessing our API in the production environment. The admin must assign a specific IP address to each API user. If the IP is incorrect, the API request will return an error.
Config Path: Administrator Login → Users Management → ≡ → API IP Whitelist
[!NOTE|style:flat] Only Administrators can configure API IP addresses.
Callback Configuration (Optional)
Callback URL
The callback_url is used to receive notifications for deposit and withdrawal transactions.
This step is optional and depends on your business requirements.
- Configuration: Enter your desired Callback URL through our Web Portal.
- Config Path: Administrator Login → Business Lines Management → Manage API → Insert Callback URL.