Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Authentication

The Phalcon Compliance APP REST API uses API keys for secure authentication. Please keep your API keys secure to protect your data.

Get an API Key

In your project workspace, navigate to System -> API, then click Generate Key to create a key. Each project supports up to 3 active keys, and all API calls will count toward your project's usage quota.

Use an API Key

Authenticate API requests by including your API key in the HTTP request header:

Request Header Format

  • Key: api-key

  • Value: Your API key

Optional IP Allowlist

You can configure an IP Allowlist for each API key in System → API → Manage → Security Settings. Once enabled, requests must include a valid API key and come from an allowed public outbound IP address.

Verification is optional and disabled by default. Saving an IP Allowlist does not enable verification; turn it on separately when your applications are ready. See the IP Allowlist guide for configuration and troubleshooting.

Last updated