Skip to main content

API keys

How to generate and safely use API keys for accessing the Deeper Signals API.

Updated over 2 weeks ago

Overview

API keys are used to authorize and authenticate external projects or users making requests to the Deeper Signals API.

They allow secure access to API endpoints and are also used to sign JWT payloads for SSO authorization. Because API keys grant access to your account, they must be handled with care.


What an API key is used for

An API key enables you to:

  • Authenticate external applications making calls to the Deeper Signals API

  • Authorize access to protected API resources

  • Sign JWT payloads for Single Sign-On (SSO) integrations


Generating an API key

You can generate an API key directly from the Deeper Signals platform.


Important: API key generation is a one-time action

Once the key is created, it will be displayed only once and cannot be viewed again.



Security considerations

Important: Your API keys must be kept confidential.

API keys provide full access to your account and should never be shared publicly or committed to source control.

Best practices include:

  • Store keys securely using environment variables or a secrets manager

  • Restrict access to only the systems that require the key

  • Rotate keys if you believe a key has been exposed


Note: If a key is lost or compromised, you will need to generate a new one and update all dependent integrations.


Learn more

For detailed implementation guidance, available endpoints, and authentication examples, refer to the official API documentation.

Did this answer your question?