Voice Biometrics User Group Keys

This describes the web services that manage the access keys in a voice biometric User Group.

A user group access key must be supplied when calling the voice biometric methods on the user API.

Date formats

All dates are of the format YYYY-MM-DD_hh:mm:ss and are in Coordinated Universal Time (UTC).

Response content

All web services in this API return response content of type "application/json".

Note

This is a low level API. For information on higher level APIs see the Web Services Language Wrappers

Authorisation

This API employs basic authentication, using your cloud account username, but unlike other web service APIs, requires a suitable Voice Biometric User Group Key rather than your account's API Access Key.


Username	: cloudID/username (e.g. 1-2-0/bob@example.com)
Password	: Voice Biometric User Group Key

List

List the access keys in a user group.

Request


URL	: https://ws-[cloudID].aculabcloud.net/voice_biometrics/v1/user_group/keylist
Methods	: GET, POST

Parameter	Value	Description
user_group_name	required	the name of the user group.

Response

A JSON object containing a list of user group key objects containing the following parameters:

Parameter	Value	Description
user_group_key	string	always
created	string	always
enabled	boolean	always
retain_data	boolean	always

Example

Request

https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/key/list?user_group_name=BobsCompany

Response

{
    "user_group_keys": [
        {
            "user_group_key": "ak-CxdoWo/8kzAyBcgny-7qCh9/zfc0",
            "created": "2021-01-15_08:56:24",
            "enabled": true,
            "retain_data": false
        },
        {
            "user_group_key": "ak-OlRlRe8uNPUw0usbnIP2DBiafb0G",
            "created": "2021-01-15_09:21:35",
            "enabled": true,
            "retain_data": false
        },
    ]
}

Create

This creates a user group access key. Each key is guaranteed to be unique within the cloud account and is enabled by default.

Request


URL	: https://ws-[cloudID].aculabcloud.net/voice_biometrics/v1/user_group/keycreate
Methods	: GET, POST

Parameter	Value	Description
user_group_name	required	the name of the user group in which to create the access key.

Response

A JSON object containing the following parameters:

Parameter	Value	Description
user_group_key	string	always
created	string	always
enabled	bool	always
retain_data	boolean	always

Example

Request

https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/key/create?user_group_name=BobsCompany

Response

{
    "user_group_key": "ak-OlRlRe8uNPUw0usbnIP2DBiafb0G",
    "created": "2021-01-15_08:56:24"
    "enabled": true,
    "retain_data": false
}

Error Response

{
    "error": {
        "code": HTTP 404,
        "text": "Not found: user group BobsCompany was not found", 
        "link": "https://docs.cloud.aculab.com/Web_Services_API/web_service_voice_biometrics_user_group_keys/#create",
        "datetime": "2021-01-15_08:57:32"
    },
    "request": {
        "url": "/voice_biometrics/v1/user_group/key/create",
        "datetime": "2021-01-15_08:57.31"
    }
}

Modify

This modifies a user group access key.

Request


URL	: https://ws-[cloudID].aculabcloud.net/voice_biometrics/v1/user_group/keymodify
Methods	: GET, POST

Parameter	Value	Description
user_group_key	required	the access key to modify.
enabled	required	"true" or "false". Enable or disable the specified access key. If disabled, the key cannot be used to register, update or verify a user.
retain_data	required	"true" or "false". Enable to retain diagnostic audio and transaction data when using this key. During normal operation this should be disabled.

If retain_data is enabled for a key, the voice biometric server will store data associated with all transactions initiated using that key. This diagnostic data is accessible by Aculab only and you will need to contact Support to request it to be analysed. The data is retained for at most one month.

Response

A JSON object containing the following parameters:

Parameter	Value	Description
user_group_key	string	always
created	string	always
enabled	bool	always
retain_data	bool	always

Example

Request

https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/key/modify?user_group_key=ak-OlRlRe8uNPUw0usbnIP2DBiafb0Genabled=falseretain_data=false

Response

{
    "user_group_key": "ak-OlRlRe8uNPUw0usbnIP2DBiafb0G",
    "created": "2021-01-15_08:56:24"
    "enabled": false,
    "retain_data": false
}

Error Response

{
    "error": {
        "code": HTTP 404,
        "text": "Not found: user group BobsCompany was not found", 
        "link": "https://docs.cloud.aculab.com/Web_Services_API/web_service_voice_biometrics_user_group_keys/#modify",
        "datetime": "2021-01-15_08:58:22"
    },
    "request": {
        "url": "/voice_biometrics/v1/user_group/key/modify",
        "datetime": "2021-01-15_08:58.21"
    }
}

Delete

This deletes a user group access key.

Request


URL	: https://ws-[cloudID].aculabcloud.net/voice_biometrics/v1/user_group/keydelete
Methods	: GET, POST

Parameter	Value	Description
user_group_key	required	the access key to delete.

Response

A JSON object containing the following parameters:

Parameter	Value	Description
deleted	string	always

Example

Request

https://ws-1-2-0.aculabcloud.net/voice_biometrics/v1/user_group/key/delete?user_group_key=ak-OlRlRe8uNPUw0usbnIP2DBiafb0G

Response

{
    "deleted": "2021-01-15_08:56:24"
}

Error Response

{
    "error": {
        "code": HTTP 404,
        "text": "Not found: user group BobsCompany was not found", 
        "link": "https://docs.cloud.aculab.com/Web_Services_API/web_service_voice_biometrics_user_group_keys/#delete",
        "datetime": "2021-01-15_08:58:47"
    },
    "request": {
        "url": "/voice_biometrics/v1/user_group/key/delete",
        "datetime": "2021-01-15_08:58.46"
    }
}