> For the complete documentation index, see [llms.txt](https://docs.facephi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.facephi.com/docs.facephi-en/sdks/backend-sdk/voice/technical_documentation/api_reference/models.md). # Models ## The AudioBuffer object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AudioBuffer":{"type":"string","description":"Raw audio buffer in WAV, OPUS/OGG, MP3 or AAC format, encoded in base64 RFC4648. The audio may or may not be encrypted."}}}} ``` ## The AudioTemplate object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AudioTemplate":{"type":"string","description":"Biometric template buffer, obtained from Enrollment(), encrypted and encoded in base64 RFC4648."}}}} ``` ## The CheckLiveness object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"CheckLiveness":{"type":"boolean","default":false,"description":"If true, a liveness check will be performed"}}}} ``` ## The CheckQuality object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"CheckQuality":{"type":"boolean","default":true,"description":"If true, a quality check will be performed"}}}} ``` ## The LivenessThreshold object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"LivenessThreshold":{"type":"number","default":0.5,"description":"Threshold for liveness detection. If the liveness probability is below this value, the audio is considered invalid."}}}} ``` ## The OperationResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"OperationResult":{"type":"number","description":"Result of the operation.","enum":["NOISY = 0","LONG_REVERBERATION = 1","SMALL_SPEECH = 2","OK = 3","NOT_EVALUATED = 4","SPOOF = 5","DUPLICATED_AUDIO = 6","DIFFERENT_VOICES = 7","EMPTY_AUDIO = 8","TOO_MANY_AUDIOS = 9","NOT_ENOUGH_GOOD_AUDIOS = 10","CONFIG_MANAGER_ERROR = 11","INVALID_LICENSE = 12","EXPIRED = 13","SUSPENDED = 14","E_SYSTEM_PERMISSION = 15","E_WMIC = 16","E_INET = 17","E_NET_PROXY = 18","E_REVOKED = 19","E_LICENSE_KEY = 20","E_ACTIVATION_LIMIT = 21","E_VM = 22","E_COUNTRY = 23","E_IP = 24","E_CONTAINER = 25","DATA_NOT_FOUND = 26","ENVIRONMENT_VARIABLE_NOT_FOUND = 27","SMALL_RELATIVE_SPEECH = 28","MULTIPLE_SPEAKERS = 29"]}}}} ``` ## The TemplateType object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"TemplateType":{"type":"string","description":"Type of template returned as the result of the operation."}}}} ``` ## The Match object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"Match":{"type":"boolean","description":"Indicates whether the audio matches the template"}}}} ``` ## The LivenessScore object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"LivenessScore":{"type":"number","description":"Liveness probability"}}}} ``` ## The MatchingScore object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MatchingScore":{"type":"number","description":"Matching probability"}}}} ``` ## The AudioPosition object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AudioPosition":{"type":"integer","description":"Position of the audio in the audio array. Starts at 0."}}}} ``` ## The TimeStamp object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"TimeStamp":{"type":"string","description":"A date/time value in the format \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The MinimumSnrDb object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MinimumSnrDb":{"type":"number","description":"Minimum SNR in dB for the audio to be considered valid.","default":8}}}} ``` ## The MinimumAudioLengthMs object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MinimumAudioLengthMs":{"type":"number","description":"Minimum audio duration in milliseconds for it to be considered valid.","default":1000}}}} ``` ## The MinimumSpeechRelativeLength object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MinimumSpeechRelativeLength":{"type":"number","description":"Minimum relative speech length (speech length relative to the total audio duration).","default":0}}}} ``` ## The MaximumMultipleSpeakersDetectorScore object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MaximumMultipleSpeakersDetectorScore":{"type":"number","description":"Maximum score allowed by the multiple speakers detector.","default":1}}}} ``` ## The ExtraData object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"ExtraData":{"type":"string","description":"Tokenized data to invoke the Api Tracking service after the operation, encoded in base64."}}}} ``` ## The SnrDbDetected object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"SnrDbDetected":{"type":"number","description":"SNR in dB detected in the audio."}}}} ``` ## The SpeechLengthMsDetected object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"SpeechLengthMsDetected":{"type":"number","description":"Speech duration in milliseconds detected in the audio."}}}} ``` ## The SpeechRelativeLengthDetected object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"SpeechRelativeLengthDetected":{"type":"number","description":"Relative speech length detected in the audio."}}}} ``` ## The MultipleSpeakersScoreDetected object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"MultipleSpeakersScoreDetected":{"type":"number","description":"Multiple speakers score detected in the audio."}}}} ``` ## The TrackingStatus object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."}}}} ``` ## The TrackingMessage object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."}}}} ``` ## The AudioResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AudioResult":{"type":"object","description":"Result of processing an audio","properties":{"audio_position":{"$ref":"#/components/schemas/AudioPosition"},"result_code":{"$ref":"#/components/schemas/OperationResult"},"liveness_score":{"$ref":"#/components/schemas/LivenessScore"},"matching_score":{"$ref":"#/components/schemas/MatchingScore"},"snr_db_detected":{"$ref":"#/components/schemas/SnrDbDetected"},"speech_length_ms_detected":{"$ref":"#/components/schemas/SpeechLengthMsDetected"},"speech_relative_length_detected":{"$ref":"#/components/schemas/SpeechRelativeLengthDetected"},"multiple_speakers_score_detected":{"$ref":"#/components/schemas/MultipleSpeakersScoreDetected"}}},"AudioPosition":{"type":"integer","description":"Position of the audio in the audio array. Starts at 0."},"OperationResult":{"type":"number","description":"Result of the operation.","enum":["NOISY = 0","LONG_REVERBERATION = 1","SMALL_SPEECH = 2","OK = 3","NOT_EVALUATED = 4","SPOOF = 5","DUPLICATED_AUDIO = 6","DIFFERENT_VOICES = 7","EMPTY_AUDIO = 8","TOO_MANY_AUDIOS = 9","NOT_ENOUGH_GOOD_AUDIOS = 10","CONFIG_MANAGER_ERROR = 11","INVALID_LICENSE = 12","EXPIRED = 13","SUSPENDED = 14","E_SYSTEM_PERMISSION = 15","E_WMIC = 16","E_INET = 17","E_NET_PROXY = 18","E_REVOKED = 19","E_LICENSE_KEY = 20","E_ACTIVATION_LIMIT = 21","E_VM = 22","E_COUNTRY = 23","E_IP = 24","E_CONTAINER = 25","DATA_NOT_FOUND = 26","ENVIRONMENT_VARIABLE_NOT_FOUND = 27","SMALL_RELATIVE_SPEECH = 28","MULTIPLE_SPEAKERS = 29"]},"LivenessScore":{"type":"number","description":"Liveness probability"},"MatchingScore":{"type":"number","description":"Matching probability"},"SnrDbDetected":{"type":"number","description":"SNR in dB detected in the audio."},"SpeechLengthMsDetected":{"type":"number","description":"Speech duration in milliseconds detected in the audio."},"SpeechRelativeLengthDetected":{"type":"number","description":"Relative speech length detected in the audio."},"MultipleSpeakersScoreDetected":{"type":"number","description":"Multiple speakers score detected in the audio."}}}} ``` ## The EnrollmentBody object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"EnrollmentBody":{"type":"object","description":"Enrollment request body","properties":{"audios":{"description":"The array length can be 1, or from 3 to 5. Sending 2 audios or more than 5 is not valid. 1 audio for text-independent enrollment. 3 to 5 audios for text-dependent enrollment.","type":"array","maxItems":5,"items":{"$ref":"#/components/schemas/AudioBuffer"}},"check_liveness":{"$ref":"#/components/schemas/CheckLiveness"},"check_quality":{"$ref":"#/components/schemas/CheckQuality"},"liveness_threshold":{"$ref":"#/components/schemas/LivenessThreshold"},"minimum_snr_db":{"$ref":"#/components/schemas/MinimumSnrDb"},"minimum_speech_duration_ms":{"$ref":"#/components/schemas/MinimumAudioLengthMs"},"minimum_speech_relative_length":{"$ref":"#/components/schemas/MinimumSpeechRelativeLength"},"maximum_multiple_speakers_detector_score":{"$ref":"#/components/schemas/MaximumMultipleSpeakersDetectorScore"},"extra_data":{"$ref":"#/components/schemas/ExtraData"}},"required":["audios"]},"AudioBuffer":{"type":"string","description":"Raw audio buffer in WAV, OPUS/OGG, MP3 or AAC format, encoded in base64 RFC4648. The audio may or may not be encrypted."},"CheckLiveness":{"type":"boolean","default":false,"description":"If true, a liveness check will be performed"},"CheckQuality":{"type":"boolean","default":true,"description":"If true, a quality check will be performed"},"LivenessThreshold":{"type":"number","default":0.5,"description":"Threshold for liveness detection. If the liveness probability is below this value, the audio is considered invalid."},"MinimumSnrDb":{"type":"number","description":"Minimum SNR in dB for the audio to be considered valid.","default":8},"MinimumAudioLengthMs":{"type":"number","description":"Minimum audio duration in milliseconds for it to be considered valid.","default":1000},"MinimumSpeechRelativeLength":{"type":"number","description":"Minimum relative speech length (speech length relative to the total audio duration).","default":0},"MaximumMultipleSpeakersDetectorScore":{"type":"number","description":"Maximum score allowed by the multiple speakers detector.","default":1},"ExtraData":{"type":"string","description":"Tokenized data to invoke the Api Tracking service after the operation, encoded in base64."}}}} ``` ## The EnrollmentResponse object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"EnrollmentResponse":{"type":"object","description":"Enrollment response","properties":{"operation_result":{"$ref":"#/components/schemas/OperationResult"},"template_type":{"$ref":"#/components/schemas/TemplateType"},"template":{"$ref":"#/components/schemas/AudioTemplate"},"validate_audios_result":{"type":"array","items":{"$ref":"#/components/schemas/AudioResult"}}}},"OperationResult":{"type":"number","description":"Result of the operation.","enum":["NOISY = 0","LONG_REVERBERATION = 1","SMALL_SPEECH = 2","OK = 3","NOT_EVALUATED = 4","SPOOF = 5","DUPLICATED_AUDIO = 6","DIFFERENT_VOICES = 7","EMPTY_AUDIO = 8","TOO_MANY_AUDIOS = 9","NOT_ENOUGH_GOOD_AUDIOS = 10","CONFIG_MANAGER_ERROR = 11","INVALID_LICENSE = 12","EXPIRED = 13","SUSPENDED = 14","E_SYSTEM_PERMISSION = 15","E_WMIC = 16","E_INET = 17","E_NET_PROXY = 18","E_REVOKED = 19","E_LICENSE_KEY = 20","E_ACTIVATION_LIMIT = 21","E_VM = 22","E_COUNTRY = 23","E_IP = 24","E_CONTAINER = 25","DATA_NOT_FOUND = 26","ENVIRONMENT_VARIABLE_NOT_FOUND = 27","SMALL_RELATIVE_SPEECH = 28","MULTIPLE_SPEAKERS = 29"]},"TemplateType":{"type":"string","description":"Type of template returned as the result of the operation."},"AudioTemplate":{"type":"string","description":"Biometric template buffer, obtained from Enrollment(), encrypted and encoded in base64 RFC4648."},"AudioResult":{"type":"object","description":"Result of processing an audio","properties":{"audio_position":{"$ref":"#/components/schemas/AudioPosition"},"result_code":{"$ref":"#/components/schemas/OperationResult"},"liveness_score":{"$ref":"#/components/schemas/LivenessScore"},"matching_score":{"$ref":"#/components/schemas/MatchingScore"},"snr_db_detected":{"$ref":"#/components/schemas/SnrDbDetected"},"speech_length_ms_detected":{"$ref":"#/components/schemas/SpeechLengthMsDetected"},"speech_relative_length_detected":{"$ref":"#/components/schemas/SpeechRelativeLengthDetected"},"multiple_speakers_score_detected":{"$ref":"#/components/schemas/MultipleSpeakersScoreDetected"}}},"AudioPosition":{"type":"integer","description":"Position of the audio in the audio array. Starts at 0."},"LivenessScore":{"type":"number","description":"Liveness probability"},"MatchingScore":{"type":"number","description":"Matching probability"},"SnrDbDetected":{"type":"number","description":"SNR in dB detected in the audio."},"SpeechLengthMsDetected":{"type":"number","description":"Speech duration in milliseconds detected in the audio."},"SpeechRelativeLengthDetected":{"type":"number","description":"Relative speech length detected in the audio."},"MultipleSpeakersScoreDetected":{"type":"number","description":"Multiple speakers score detected in the audio."}}}} ``` ## The AuthenticationBody object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AuthenticationBody":{"type":"object","description":"Authentication request body","properties":{"audio":{"$ref":"#/components/schemas/AudioBuffer"},"template":{"$ref":"#/components/schemas/AudioTemplate"},"check_liveness":{"$ref":"#/components/schemas/CheckLiveness"},"check_quality":{"$ref":"#/components/schemas/CheckQuality"},"liveness_threshold":{"$ref":"#/components/schemas/LivenessThreshold"},"minimum_snr_db":{"$ref":"#/components/schemas/MinimumSnrDb"},"minimum_speech_duration_ms":{"$ref":"#/components/schemas/MinimumAudioLengthMs"},"minimum_speech_relative_length":{"$ref":"#/components/schemas/MinimumSpeechRelativeLength"},"maximum_multiple_speakers_detector_score":{"$ref":"#/components/schemas/MaximumMultipleSpeakersDetectorScore"},"extra_data":{"$ref":"#/components/schemas/ExtraData"}},"required":["audio","template"]},"AudioBuffer":{"type":"string","description":"Raw audio buffer in WAV, OPUS/OGG, MP3 or AAC format, encoded in base64 RFC4648. The audio may or may not be encrypted."},"AudioTemplate":{"type":"string","description":"Biometric template buffer, obtained from Enrollment(), encrypted and encoded in base64 RFC4648."},"CheckLiveness":{"type":"boolean","default":false,"description":"If true, a liveness check will be performed"},"CheckQuality":{"type":"boolean","default":true,"description":"If true, a quality check will be performed"},"LivenessThreshold":{"type":"number","default":0.5,"description":"Threshold for liveness detection. If the liveness probability is below this value, the audio is considered invalid."},"MinimumSnrDb":{"type":"number","description":"Minimum SNR in dB for the audio to be considered valid.","default":8},"MinimumAudioLengthMs":{"type":"number","description":"Minimum audio duration in milliseconds for it to be considered valid.","default":1000},"MinimumSpeechRelativeLength":{"type":"number","description":"Minimum relative speech length (speech length relative to the total audio duration).","default":0},"MaximumMultipleSpeakersDetectorScore":{"type":"number","description":"Maximum score allowed by the multiple speakers detector.","default":1},"ExtraData":{"type":"string","description":"Tokenized data to invoke the Api Tracking service after the operation, encoded in base64."}}}} ``` ## The AuthenticationResponse object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"AuthenticationResponse":{"type":"object","description":"Authentication response","properties":{"operation_result":{"$ref":"#/components/schemas/OperationResult"},"match":{"$ref":"#/components/schemas/Match"},"liveness_score":{"$ref":"#/components/schemas/LivenessScore"},"matching_score":{"$ref":"#/components/schemas/MatchingScore"},"snr_db_detected":{"$ref":"#/components/schemas/SnrDbDetected"},"speech_length_ms_detected":{"$ref":"#/components/schemas/SpeechLengthMsDetected"},"speech_relative_length_detected":{"$ref":"#/components/schemas/SpeechRelativeLengthDetected"},"multiple_speakers_score_detected":{"$ref":"#/components/schemas/MultipleSpeakersScoreDetected"},"tracking_status":{"$ref":"#/components/schemas/TrackingStatus"},"tracking_message":{"$ref":"#/components/schemas/TrackingMessage"}}},"OperationResult":{"type":"number","description":"Result of the operation.","enum":["NOISY = 0","LONG_REVERBERATION = 1","SMALL_SPEECH = 2","OK = 3","NOT_EVALUATED = 4","SPOOF = 5","DUPLICATED_AUDIO = 6","DIFFERENT_VOICES = 7","EMPTY_AUDIO = 8","TOO_MANY_AUDIOS = 9","NOT_ENOUGH_GOOD_AUDIOS = 10","CONFIG_MANAGER_ERROR = 11","INVALID_LICENSE = 12","EXPIRED = 13","SUSPENDED = 14","E_SYSTEM_PERMISSION = 15","E_WMIC = 16","E_INET = 17","E_NET_PROXY = 18","E_REVOKED = 19","E_LICENSE_KEY = 20","E_ACTIVATION_LIMIT = 21","E_VM = 22","E_COUNTRY = 23","E_IP = 24","E_CONTAINER = 25","DATA_NOT_FOUND = 26","ENVIRONMENT_VARIABLE_NOT_FOUND = 27","SMALL_RELATIVE_SPEECH = 28","MULTIPLE_SPEAKERS = 29"]},"Match":{"type":"boolean","description":"Indicates whether the audio matches the template"},"LivenessScore":{"type":"number","description":"Liveness probability"},"MatchingScore":{"type":"number","description":"Matching probability"},"SnrDbDetected":{"type":"number","description":"SNR in dB detected in the audio."},"SpeechLengthMsDetected":{"type":"number","description":"Speech duration in milliseconds detected in the audio."},"SpeechRelativeLengthDetected":{"type":"number","description":"Relative speech length detected in the audio."},"MultipleSpeakersScoreDetected":{"type":"number","description":"Multiple speakers score detected in the audio."},"TrackingStatus":{"type":"number","description":"Status returned by the Api Tracking service, or -1 if tracking is not required."},"TrackingMessage":{"type":"string","description":"Message returned by the Api Tracking service, or empty if tracking is not required."}}}} ``` ## The BadRequestResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"BadRequestResult":{"type":"object","description":"Result returned when the request contains incorrect parameters.","properties":{"status":{"type":"number"},"error":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in the format \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The ExceptionResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"ExceptionResult":{"type":"object","description":"An error occurred while calling the Voice-SDK backend.","properties":{"status":{"type":"number"},"error":{"type":"string"},"exception":{"type":"string"},"timeStamp":{"$ref":"#/components/schemas/TimeStamp"}}},"TimeStamp":{"type":"string","description":"A date/time value in the format \"%Y-%m-%dT%H:%M:%SZ\"."}}}} ``` ## The HealthStatus object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"HealthStatus":{"type":"string","description":"Result of the health service (indicates whether the SDK is active or not).","enum":["Healthy","Unhealthy"]}}}} ``` ## The HealthResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"HealthResult":{"type":"object","description":"The result of a health check.","properties":{"message":{"$ref":"#/components/schemas/HealthStatus"}}},"HealthStatus":{"type":"string","description":"Result of the health service (indicates whether the SDK is active or not).","enum":["Healthy","Unhealthy"]}}}} ``` ## The VersionResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"VersionResult":{"type":"object","description":"The result of a version check.","properties":{"message":{"type":"string"}}}}}} ``` ## The ConfigResult object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"ConfigResult":{"type":"object","description":"JSON object with the service configuration parameters. JWT authentication settings are intentionally omitted."}}}} ``` ## The ConfigBody object ```json {"openapi":"3.0.1","info":{"title":"Voice-Service REST API","version":"3.2.0"},"components":{"schemas":{"ConfigBody":{"type":"object","description":"Config request body. This endpoint does not accept JWT authentication settings.","properties":{"config_json_string":{"type":"string","description":"JSON string with the configuration parameters to modify. Only the read-write parameters listed in `POST /api/v1/config` are applied."}},"required":["config_json_string"]}}}} ```