API Keys
The API Keys page is used to generate and manage API keys within the system.
API Keys are used to authenticate requests when sending API Requests.
Generate API Key​
The Generate API key section sits at the top of the page, above the lists of keys. Enter the following details:
- Key Name - A meaningful name describing the key's purpose.
- Expiration Date - Sets an expiration date, after which the key expires and no longer functions. Leave this field empty for no expiration date.
- Token Type - Identifies which environment the key will be used for, either Production or Test. This determines which environment transactions are sent to.
After selecting Generate key, the key is only shown once and cannot be recovered afterwards. If you generate a key while viewing the Expired tab, the page switches to the Active tab.
You can have a maximum of five active keys per environment. Expired keys do not count toward this limit. When you reach it, FraudShield shows a message asking you to revoke a key for that environment before generating a new one.
Manage API Keys​
This section lists all your personal keys. The Org Owner/ Org Admin roles can view all API keys in the system, including those belonging to other users.
Keys are split across two tabs, Active and Expired, with Active selected by default. The key itself is not visible in either tab, only at the time of generation.
Active Keys​
The Active tab lists every key that can still be used, including all keys without an expiry date. It shows "No API keys found" when there are none.
Active Key Columns
| Column | Description |
|---|---|
| API Key | Displays the Key Name. |
| Token Type | Identifies which environment the key was set for (Production or Test). This determines which environment transactions are sent to. |
| Issue Date | Date and time the key was generated. |
| Generated By | User who generated the key. |
| Last Used | Date and time the key was last used. |
| Expire In | Expiry date set for the key. Displayed as No Expiry for keys without an expiry date. |
The following action is available for each active key:
- Revoke - Immediately disables the key, causing all future API calls using it to fail. This action is irreversible - ensure the key is no longer in use before revoking.
A revoked key is removed from the list entirely, and does not appear on the Expired tab.
Expired Keys​
A key moves to the Expired tab once its expiration date has passed. The tab shows the same columns as the Active tab, with Expired On - the date and time the key expired - in place of Expire In. It shows "No expired API keys found" when there are none.
Expired keys no longer work and cannot be revoked, so the Revoke action is not available on this tab.
For full details on the available API endpoints, see the API Reference.