Easily view, create, and manage your API tokens for both Production and Sandbox environments directly within the sanctions.io portal. API tokens provide secure, programmatic access to your account and resources, enabling seamless integration and control of your screening workflows.
You can also manage tokens programmatically via API calls. See our API documentation for details.
Topics Covered
Best Practices and Considerations
- API tokens are a critical security component. Changing or deleting a token may immediately impact the stability and performance of your systems.
- API tokens remain active until they are manually revoked or deleted.
- Rotate tokens periodically to reduce security risks.
- Remove tokens that are no longer in use.
Create a Token
1. Go to API Settings, under the API Tokens section, click Create Token.
2. Select the environment, Production or Sandbox. Then, click Create Token.
3. That's it! A notification will confirm the token's creation, and your new token will be immediately available in the token list.
Set a Token as Default
Note: Only 'Production' tokens can be set as the default.
1. In API Settings, under API Tokens, locate the token you want to set as default.
2. In the Actions column, look for the key icon. The key can appear in three color states:
- Green: This token is already the default.
- Dark grey: This token can be set as the default.
- Greyed out: This token cannot be set as default (usually Sandbox tokens).
3. To set a token as default, click the dark grey key icon next to the desired token. This action will immediately make it the new default token.
Delete a Token
‼️ Warning: This action is irreversible. Deleting a token may directly affect your system's stability and performance. When a token is deleted, it becomes immediately invalid. Any system that is still relying on it will encounter request failures until the token is updated or replaced.
1. In API Settings, under API Tokens, locate the token you want to delete.
2. In the Actions column, click the trash icon.
3. A confirmation dialog will pop up. Make sure you've selected the correct token, then click Delete to proceed. You'll receive a notification confirming the token's deletion.
We're here to help!
If you have any questions or require further assistance, please don't hesitate to reach out to our support team:
-
Chat: Available directly on the Help Center page.
-
Email: help@sanctions.io