Generate a Full-Access API Key

Audience: Organizations

Before you begin.

Availability: API key functionality may require enablement by Proof. Contact your Customer Success Manager (CSM) or Sales representative for enablement assistance.
Important: Full-access API keys provide broad API access to your Proof account. Store API keys securely and never share them publicly.

The short answer: Organization owners and admins can generate a full-access API key from Settings to use with integrations, EasyLinks, and API-based workflows.

Full-access API keys should be treated as sensitive credentials. Anyone with access to a valid API key may be able to perform API actions on behalf of your organization.

Required permissions

Only organization owners, administrators, or users with the appropriate API management permissions can generate and manage full-access API keys.

Common use cases

  • Connecting an external system to the Proof API
  • Creating transactions through an integration
  • Supporting EasyLinks or embedded workflows
  • Automating transaction creation and management
  • Testing API-based workflows in an approved environment

Security considerations

  • Store API keys in a secure credential management system.
  • Never expose API keys in source code repositories or client-side applications.
  • Limit access to API keys to authorized users only.
  • Rotate API keys according to your organization’s security policies.
  • Delete unused or compromised API keys immediately.

Generate the API Key

Log in to your Proof account to complete the steps below.

  1. Click Settings from the navigation panel on the left.
  2. Select API Keys from the Settings menu.
  3. Click Generate Full Access Key at the top of the page. A new key appears in the list below the button.
  4. Click the Settings icon next to the newly created API key.

    Settings icon next to a newly generated API key
  5. Configure the API key settings as needed, such as name, payer, minimum signers, maximum signers, and other available options.
  6. Click Save.
  7. Return to the main API Keys page and click the copy icon to copy the API key.

    Copy icon next to an API key on the API keys page
Important: Copy and store the API key securely. Do not send API keys through email, chat, support tickets, or any unsecured channel.

Summary Checklist

  • Navigate to Settings > API Keys and click Generate Full Access Key.
  • Open the key's settings, configure the name and available options, and click Save.
  • Copy the API key from the main API Keys page using the copy icon.
  • Store the API key securely and limit access to authorized users only.

Troubleshooting

  • If you do not see the API Keys option, confirm your organization has API access enabled.
  • If you cannot generate a key, confirm you have the required organization role or API management permissions.
  • If an integration cannot authenticate, confirm the correct API key is being used.
  • If an API key may have been exposed, delete the key and generate a new one.

Still Unsure?

Our support team is happy to help. Submit a support request or chat with us from any page in the app.


Updated

Was this article helpful?

0 out of 3 found this helpful