Introduction to the Partner Call Authentication API

Call Authentication lets you declare an outbound call to Hiya ahead of time so that Hiya can authenticate it and deliver the business's branding (Secure Branding) at call time.

This API exposes the real-time, per-call pre-announce action: just before placing a call, the originator declares it to Hiya, and Hiya authenticates and/or brands a matching call placed within a short validity window (timeToLiveSeconds).

Base URL for API requests -- https://api.hiyaapi.com

Hosts and regions

Pre-announce is served from api.hiyaapi.com under the /partner prefix, alongside the existing call-announcement API.

api.hiyaapi.com is latency-routed. The regional names uk.api.hiyaapi.com and ca.api.hiyaapi.com serve the same endpoints and process the request in that region. The /partner prefix is the same on every regional name.

Hiya writes a pre-announce to the regions responsible for the country of terminatingPhone, whichever host you call, and regionalResponses lists them. This is not a data-residency guarantee.

Authentication

All endpoints use Basic HTTP Authentication with your API key, sent in the Authorization: Basic <credentials> header. It is the same API key you use for the Partner Management APIs.

Conventions

Timestamps. Every timestamp in a response is in UTC, in RFC 3339 format with up to nine fractional-second digits; trailing zeros are dropped, and the fraction is left out when it is zero — for example 2026-05-28T14:32:10.123456Z or 2026-05-28T14:32:10Z.