FraudDetectionConfiguration
Defines the risk threshold to identify a fraudster during a session.
Contents
RiskThreshold
Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by VoiceID is higher than the threshold, the speaker is considered a fraudster.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FraudDetectionResult
FraudDetectionResult
Contains information produced as a result of performing fraud detection on a speaker.
Contents
AudioAggregationEndedAt
A timestamp indicating when audio aggregation ended for this fraud detection result.
Type: Timestamp Required: No
AudioAggregationStartedAt
A timestamp indicating when audio aggregation started for this fraud detection result.
Type: Timestamp Required: No Configuration
The FraudDetectionConfiguration used to generate this fraud detection result.
Type: FraudDetectionConfiguration (p. 73) object Required: No
Decision
The decision produced by VoiceID as a result of the fraud detection process.
Type: String
Valid Values: HIGH_RISK | LOW_RISK | NOT_ENOUGH_SPEECH Required: No
FraudDetectionResultId
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, VoiceId always returns cached results for this API.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No Reasons
The reason a speaker is identified as a fraudster. There is currently only one valied value, KNOWN_FRAUDSTER, and is only populated if the fraud detection reason is HIGH_RISK.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
See Also
Valid Values: KNOWN_FRAUDSTER Required: No
RiskDetails
Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk details.
Type: FraudRiskDetails (p. 76) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FraudRiskDetails
FraudRiskDetails
Details regarding various fraud risk analyses performed on a speaker. This contains results for the known fraudster risk analysis.
Contents
KnownFraudsterRisk
The details resulting from 'Known Fraudster Risk' analysis of the speaker.
Type: KnownFraudsterRisk (p. 85) object Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Fraudster
Fraudster
Contains all the information about a fraudster.
Contents
CreatedAt
The timestamp when VoiceID identified the fraudster.
Type: Timestamp Required: No DomainId
The identifier for the domain containing the fraudster.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No GeneratedFraudsterId
The service-generated identifier for the fraudster.
Type: String
Length Constraints: Fixed length of 25.
Pattern: ^id#[a-zA-Z0-9]{22}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FraudsterRegistrationJob
FraudsterRegistrationJob
Contains all the information about a fraudster registration job.
Contents
CreatedAt
A timestamp showing the creation time of the fraudster registration job.
Type: Timestamp Required: No DataAccessRoleArn
The IAM role Amazon Resource Name (ARN) that grants VoiceID permissions to read input and write output files in your S3 buckets.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$
Required: No DomainId
The identifier of the domain containing the fraudster registration job.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No EndedAt
A timestamp showing when the fraudster registration job ended.
Type: Timestamp Required: No FailureDetails
Contains details that are populated when an entire batch job fails. In cases of individual
registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
Type: FailureDetails (p. 72) object Required: No
InputDataConfig
The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
Contents
Type: InputDataConfig (p. 83) object Required: No
JobId
The service-generated identifier for the fraudster registration job.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No JobName
The client-provied name for the fraudster registration job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
Required: No JobProgress
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
Type: JobProgress (p. 84) object Required: No
JobStatus
The current status of the fraudster registration job.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED
Required: No OutputDataConfig
The output data config containing the S3 location where you want VoiceID to write your job output file; you must also include a KMS Key ID in order to encrypt the file.
Type: OutputDataConfig (p. 86) object Required: No
RegistrationConfig
The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.
Type: RegistrationConfig (p. 87) object Required: No
See Also
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
FraudsterRegistrationJobSummary
FraudsterRegistrationJobSummary
Contains a summary of information about a fraudster registration job.
Contents
CreatedAt
A timestamp showing when the fraudster registration job is created.
Type: Timestamp Required: No DomainId
The identifier of the domain containing the fraudster registration job.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No EndedAt
A timestamp showing when the fraudster registration job ended.
Type: Timestamp Required: No FailureDetails
Contains details that are populated when an entire batch job fails. In cases of individual
registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual registration requests that failed.
Type: FailureDetails (p. 72) object Required: No
JobId
The service-generated identifier for the fraudster registration job.
Type: String
Length Constraints: Fixed length of 22.
Pattern: ^[a-zA-Z0-9]{22}$
Required: No JobName
The client-provied name for the fraudster registration job.
Type: String
See Also
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
Required: No JobProgress
Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
Type: JobProgress (p. 84) object Required: No
JobStatus
The current status of the fraudster registration job.
Type: String
Valid Values: SUBMITTED | IN_PROGRESS | COMPLETED | COMPLETED_WITH_ERRORS | FAILED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
InputDataConfig
InputDataConfig
The configuration containing input file information for a batch job.
Contents
S3Uri
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: ^s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
JobProgress
JobProgress
Indicates the completion progress for a batch job.
Contents
PercentComplete
Shows the completed percentage of enrollment or registration requests listed in the input file.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
KnownFraudsterRisk
KnownFraudsterRisk
Contains details produced as a result of performing known fraudster risk analysis on a speaker.
Contents
GeneratedFraudsterId
The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, this value is null.
Type: String
Length Constraints: Fixed length of 25.
Pattern: ^id#[a-zA-Z0-9]{22}$
Required: No RiskScore
The score indicating the likelihood the speaker is a known fraudster.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
OutputDataConfig
OutputDataConfig
The configuration containing output file information for a batch job.
Contents
KmsKeyId
the identifier of the KMS key you want VoiceID to use to encrypt the output file of the fraudster registration job.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: No S3Uri
The S3 path of the folder to which VoiceID will write the job output file, which has a *.out extension. For example, if the input file name is input-file.json and the output folder path is s3://output-bucket/output-folder, the full output file path is s3://output-bucket/
output-folder/job-Id/input-file.json.out.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Pattern: ^s3://[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9](/.*)?$
Required: Yes
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
RegistrationConfig
RegistrationConfig
The configuration definining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.
Contents
DuplicateRegistrationAction
The action to take when a fraudster is identified as a duplicate. The default action is SKIP, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW always registers a new fraudster into the specified domain.
Type: String
Valid Values: SKIP | REGISTER_AS_NEW Required: No
FraudsterSimilarityThreshold
The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3