Hiya · Authentication Profile

Hiya Authentication

Authentication

Hiya secures its APIs with http-basic and http-bearer across 2 declared security schemes, as derived from its OpenAPI definitions.

CompanyVoice SecurityCaller IDBranded CallingSpam ProtectionScam ProtectionDeepfake DetectionVoice AuthenticationTelecommunicationsCall Analytics
Methods: http-basic, http-bearer Schemes: 2 OAuth flows: API key in: header

Security Schemes

BasicAuth http
scheme: basic · in: header ()
BearerAuth http
scheme: bearer · in: header ()

Source

Authentication Profile

hiya-authentication.yml Raw ↑
generated: '2026-07-19'
method: searched
source: https://developer.hiya.com/docs/getting-started/authentication
docs: https://developer.hiya.com/docs/getting-started/authentication
summary:
  types: [http-basic, http-bearer]
  api_key_in: [header]
  notes: >-
    Most Hiya REST APIs (Connect, Protect, AI Voice Platform) use HTTP Basic
    authentication over HTTPS with an App ID and App Secret. The Audio
    Intelligence API uses bearer tokens obtained via a credentials sign-in
    endpoint. Credentials are issued as separate Test and Production key pairs
    via the self-service Console or by contacting Hiya.
schemes:
- name: BasicAuth
  type: http
  scheme: basic
  in: header
  header: Authorization
  format: 'Basic base64(AppID:AppSecret)'
  description: >-
    App ID and App Secret are concatenated as "AppID:AppSecret", base64-encoded,
    and sent as "Authorization: Basic <credentials>". The App ID carries an
    environment prefix (e.g. PROD_SampleApp) to distinguish production from test.
    The encoded string must have no leading/trailing spaces or line breaks.
  applies_to: [Hiya Connect API, Hiya Protect API, Hiya AI Voice Platform API]
  source: https://developer.hiya.com/docs/getting-started/authentication
- name: BearerAuth
  type: http
  scheme: bearer
  in: header
  header: Authorization
  format: 'Bearer <token>'
  description: >-
    Audio Intelligence authenticates with bearer tokens. A token is obtained by
    signing in with credentials (credentials-sign-in) or via managed API keys
    (keys-create / keys-list). The AI Voice Platform also exposes a
    get-hiya-auth-token operation for issuing auth tokens.
  applies_to: [Hiya Audio Intelligence API]
  source: https://developer.hiya.com/docs/audio-intel/endpoints/credentials-sign-in