put https://api.talkdeskapp.com/voicebiometrics/contacts//consent
For voice biometrics authentication
Scope
voicebiometrics-consent:write
Request Body (Required)
{
"status": "CONSENTED"
}
Body Response - Schema
200 (OK), 201 (created)
| Parameter | Type | Description | Required |
|---|---|---|---|
| status | string | The consent status. Allowed values: "NO_CONSENT", "CONSENTED", "DELETED", "REFUSED" | yes |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Voice Biometrics Opt-In API has been in General Availability since February 2022.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.