Users (List users): manage the users of a business — the people who sign in to the Hiya Console for it. List them, invite one with a role (ADMIN, EDITOR or VIEWER) (Invite a user), update their name and role (Update a user), or delete them (Delete a user). A user is identified by their email. Inviting the email of a user on another of your businesses returns 409 unless you pass force=true, which moves them onto this business.
Batch phone number writes take their settings at the request level: PUT and PATCH on /v1/businesses/{businessId}/phone-numbers now take branding and spoofDefense once, next to phoneNumbers, and apply them to every number in the request. Each item in phoneNumbers carries only phoneNumber. To give numbers different settings, send one request per distinct set of settings (Add or replace phone numbers, Partially update phone numbers).
A phone number without billable calls returns 404: getting one phone number's billable calls now returns 404 when the number had no billable calls for the business in the range, the same as a number that isn't the business's (Get a phone number's billable calls by business ID).
Phone number search needs at least 2 characters: the search parameter when listing phone numbers now has a minimum length of 2 (List phone numbers).
Logos: uploading a logo to a business that hasn't completed verification returns 409, and a request body over 6 MB is refused by the API gateway with 413 (Upload a logo).
Phone numbers: removing a single phone number whose path value isn't valid E.164 returns 400 with INVALID_FIELD (Remove a phone number).
Billing: error responses now carry requestId and timestamp, error examples show the messages the API returns, and the paging limits (page at most 100000, size 1 to 200) are documented on the 400 responses (List billable calls).
Digital models retired: The digital voiceprint, identity, authenticity and message verification models are no longer available. Requests that select digital model return a model-not-available error. Use the phone models instead, which support audio with sample rates of 8 kHz or higher. For their specifications, please visit our model index page.
New API reference section — Partner: the API reference has a new Partner section for Hiya Amplify partners, alongside Connect, Protect, AI Voice Platform and Audio Intelligence.
Partner Management APIs (introduction): served from https://partner.api.hiyaapi.com, they let you create and manage your customers' businesses — create, read and list businesses (Create a business), turn branded call and Spoof Defense on or off, and delete a business (Delete a business); register and manage phone numbers with their branding and Spoof Defense; upload logos; and query billable calls (List billable calls).
Partner Call Authentication API (introduction): pre-announce an outbound call just before placing it, so Hiya can authenticate it and deliver the business's branding (Secure Branding) within a short validity window (Pre-announce a call). Served from https://api.hiyaapi.com under the /partner prefix, with the regional hosts uk.api.hiyaapi.com and ca.api.hiyaapi.com.
New endpoint — Profile Phones Cache (Hiya Protect): GET /v1/caches/phones returns a country-specific gzipped TSV combining reputation level, reputation category, and display info in a single download. Requires ?country=XX.
New endpoint — Branded Phones Cache (Hiya Connect): GET /v1/caches/branded_phones returns a gzipped TSV of branded phone numbers and their display names. No reputation data, no country filter.
Cross-references between cache pages: Each of the three cache reference pages (Spammer Cache, Profile Phones Cache, Branded Phones Cache) now links to the other two with a brief description of what each one contains, so integrators can pick the right endpoint at a glance.
Introducing Phone/v8: We are proud to announce our newest model, Phone/v8. This model delivers improved accuracy and broader coverage of newer deepfake attack techniques compared to its predecessor. It also includes an updated voice activity detector, improving voice detection accuracy for phone-channel audio. For comprehensive technical specifications and benchmarks, please visit our model index page.
Introducing Phone/v7: We are proud to announce our newest model, Phone/v7. This model delivers improved accuracy and broader coverage of newer deepfake attack techniques compared to its predecessor. For comprehensive technical specifications and benchmarks, please visit our model index page.
Introducing Phone/v6: We are proud to announce our newest model, Phone/v6. This model delivers improved accuracy and broader coverage of newer deepfake attack techniques compared to its predecessor. For comprehensive technical specifications and benchmarks, please visit our model index page.
Removal of Phone/v5: The Phone/v5 model has been replaced by Phone/v6 and is no longer available on the platform. Please update your integrations to use Phone/v6.
Next-Generation Phone Authenticity Verification: Introducing phone/v5, the new default phone model for authenticity verification. This advanced model delivers enhanced accuracy with double the parameters compared to previous versions, providing superior deepfake detection capabilities for telephone channel audio.
Enhanced Detection Performance: The phone/v5 authenticity verification model has been optimized with an expanded parameter set, enabling more sophisticated analysis of voice authenticity and improved reliability in identifying AI-generated or modified audio over telephone channels.
Introducing Digital/v3 authenticity verification model: We are proud to announce our newest model, Digital/v3. This new model deliver improved accuracy, with coverage of additional attacks and newer techniques. For comprehensive technical specifications and benchmarks, please visit our model index page.