Skip to main content

Using your API key safely

Manage your API key, understand access errors, and protect your credentials.

Your API key authenticates requests to Adesic endpoints that support API-key access. Keep it private and check the authentication requirements for the operation you want to use.

Manage your key

Sign in to API Keys.

Existing keys cannot be revealed on this page. If you need a replacement, choose Rotate and read the confirmation before proceeding. Rotating the key immediately invalidates the previous one, so requests using that key will stop working.

Copy the replacement key before refreshing or leaving the page, store it securely, and update the applications that use it. Coordinate the change with anyone responsible for those integrations.

Send the key securely

Use the api-key request header as described in the authentication documentation. Do not put the key in a URL.

Keep keys out of public repositories, browser-side application code, screenshots, and support messages. Use your application's secure configuration or secret storage.

If you believe a key has been exposed, rotate it and update the affected integrations.

If you receive an access error

Read the HTTP status and the error message together:

  • 401: check the authentication method required by the endpoint. A key may be missing, invalid, or no longer current, or the operation may require a signed-in session.

  • 403: check the access requirements for that operation and any outstanding verification requests. A valid key does not automatically authorize every action.

For example, subaccount management—including creating subaccounts or generating verification links—requires signing in to Trinity. An API key alone does not authorize those management operations.

Still need help?

Contact Support with the endpoint, HTTP method, status code, error message, and approximate request time and time zone. Include a request reference if one was returned.

Remove API keys, authorization headers, session cookies, and personal or financial information from examples. Never send your API key or sign-in code to Support.

Did this answer your question?