Amazon Web Services, Inc.

Amazon Voice ID

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and…

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which
make voice interactions in contact centers more secure and efficient.

Endpoints 29

Domain

  • POSTCreate domain/#X-Amz-Target=VoiceID.CreateDomainCreates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a…
  • POSTDelete domain/#X-Amz-Target=VoiceID.DeleteDomainDeletes the specified domain from Voice ID.
  • POSTDescribe domain/#X-Amz-Target=VoiceID.DescribeDomainDescribes the specified domain.
  • POSTList domains/#X-Amz-Target=VoiceID.ListDomainsLists all the domains in the Amazon Web Services account.
  • POSTUpdate domain/#X-Amz-Target=VoiceID.UpdateDomainUpdates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not…
  • POSTAssociate fraudster/#X-Amz-Target=VoiceID.AssociateFraudsterAssociates the fraudsters with the watchlist specified in the same domain.
  • POSTCreate watchlist/#X-Amz-Target=VoiceID.CreateWatchlistCreates a watchlist that fraudsters can be a part of.
  • POSTDelete fraudster/#X-Amz-Target=VoiceID.DeleteFraudsterDeletes the specified fraudster from Voice ID. This action disassociates the fraudster from any watchlists it is a part of.
  • POSTDelete speaker/#X-Amz-Target=VoiceID.DeleteSpeakerDeletes the specified speaker from Voice ID.
  • POSTDelete watchlist/#X-Amz-Target=VoiceID.DeleteWatchlistDeletes the specified watchlist from Voice ID. This API throws an exception when there are fraudsters in the watchlist that you are trying to delete. You must…
  • POSTDescribe fraudster/#X-Amz-Target=VoiceID.DescribeFraudsterDescribes the specified fraudster.
  • POSTDescribe fraudster registration job/#X-Amz-Target=VoiceID.DescribeFraudsterRegistrationJobDescribes the specified fraudster registration job.
  • POSTDescribe speaker/#X-Amz-Target=VoiceID.DescribeSpeakerDescribes the specified speaker.
  • POSTDescribe speaker enrollment job/#X-Amz-Target=VoiceID.DescribeSpeakerEnrollmentJobDescribes the specified speaker enrollment job.
  • POSTDescribe watchlist/#X-Amz-Target=VoiceID.DescribeWatchlistDescribes the specified watchlist.
  • POSTDisassociate fraudster/#X-Amz-Target=VoiceID.DisassociateFraudsterDisassociates the fraudsters from the watchlist specified. Voice ID always expects a fraudster to be a part of at least one watchlist. If you try to…
  • POSTEvaluate session/#X-Amz-Target=VoiceID.EvaluateSessionEvaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
  • POSTList fraudster registration jobs/#X-Amz-Target=VoiceID.ListFraudsterRegistrationJobsLists all the fraudster registration jobs in the domain with the given JobStatus . If JobStatus is not provided, this lists all fraudster registration jobs in…
  • POSTList fraudsters/#X-Amz-Target=VoiceID.ListFraudstersLists all fraudsters in a specified watchlist or domain.
  • POSTList speaker enrollment jobs/#X-Amz-Target=VoiceID.ListSpeakerEnrollmentJobsLists all the speaker enrollment jobs in the domain with the specified JobStatus . If JobStatus is not provided, this lists all jobs with all possible speaker…
  • POSTList speakers/#X-Amz-Target=VoiceID.ListSpeakersLists all speakers in a specified domain.
  • POSTList tags for resource/#X-Amz-Target=VoiceID.ListTagsForResourceLists all tags associated with a specified Voice ID resource.
  • POSTList watchlists/#X-Amz-Target=VoiceID.ListWatchlistsLists all watchlists in a specified domain.
  • POSTOpt out speaker/#X-Amz-Target=VoiceID.OptOutSpeakerOpts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they already exist in Voice ID. If they don't yet exist, a new…
  • POSTStart fraudster registration job/#X-Amz-Target=VoiceID.StartFraudsterRegistrationJobStarts a new batch fraudster registration job using provided details.
  • POSTStart speaker enrollment job/#X-Amz-Target=VoiceID.StartSpeakerEnrollmentJobStarts a new batch speaker enrollment job using specified details.
  • POSTTag resource/#X-Amz-Target=VoiceID.TagResourceTags a Voice ID resource with the provided list of tags.
  • POSTUntag resource/#X-Amz-Target=VoiceID.UntagResourceRemoves specified tags from a specified Amazon Connect Voice ID resource.
  • POSTUpdate watchlist/#X-Amz-Target=VoiceID.UpdateWatchlistUpdates the specified watchlist. Every domain has a default watchlist which cannot be updated.

API details

Base URL
https://voiceid.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
29 operations on 29 pathsPOST 29
Main resources
Domain 5
Description format
AWS Smithy model, API version 2021-09-27

How to test the Amazon Voice ID in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Voice ID collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Create domain” (POST /#X-Amz-Target=VoiceID.CreateDomain), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon Voice ID?

Amazon Connect Voice ID provides real-time caller authentication and fraud risk detection, which make voice interactions in contact centers more secure and… It is listed under Communication and has 29 endpoints.

Who publishes the Amazon Voice ID?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon Voice ID?

Requests go to https://voiceid.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon Voice ID?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon Voice ID have?

29 operations on 29 paths (29 POST). The largest groups are Domain.

Is forking the Amazon Voice ID free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.