Set a Contact Consent Status

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

voicebiometrics-consent:write

Request Body (Required)

{
  "status": "CONSENTED"
}

Body Response - Schema

200 (OK), 201 (created)

ParameterTypeDescriptionRequired
statusstringThe consent status. Allowed values:
"NO_CONSENT",
"CONSENTED", "DELETED", "REFUSED"
yes

400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[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.

Path Params
string
required
Body Params
string
required
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json