API Keys

View as Markdown

Lead Receive API calls use a company API key in the X-Company-API-Key header.

Getting a key

API keys are provided through approved SimZ onboarding or portal workflows. Public docs intentionally do not expose API key administration endpoints.

Security guidance

  • Store the full key securely when generated.
  • Do not expose keys in frontend JavaScript.
  • Rotate keys if they are shared with the wrong party.
  • Revoke old keys after migration.