Verify Voice

To perform the user’s biometric voice verification, the method to be used is Verify Voice. Similar to the enrollment process, the first request to this method will start the verification process, returning the voice sample expected to be present on the next request ( not expecting any file on the first request ). This process may need more than one request depending on the quality and acceptance of the sample provided. In case of success, the system will respond that the user is verified for this kind of biometric operation. In case of failure, it’s necessary to repeat the process until the verification step is completed.

Verify Voice

POST Https://api.biometrid.com/api/1.1/users/:userId/dialogue/verify/voice

Verify user's voice on client's chosen provider

Path Parameters

Name	Type	Description
userID	string	BiometrID user ID

Headers

Name	Type	Description
Content-type	string	Request content type (This is not required to be set. Referenced only to show how we expect data to be sent). { "Content-Type": "multipart/form-data" }
x-biometrid-key	string	Application Client Key
x-biometrid-secret	string	Application Client Secret

Request Body

Name	Type	Description
audio	object	Audio file with the voice biometrid sample. (only .wav format)

200 Success 200 types

HTTP/1.1 200 OK

//Audio Verified
{
    "status": true,
    "data": {
        "message": "AUDIO_RECOGNIZED_WITH_SUCCESS",
        "verified": true
    }
}

//Voice Verification Failed
{
    "status": false,
    "data": {
        "message": "AUDIO_RECOGNITION_FAILED"
     }
}

400 Bad Request types

HTTP/1.1 400 Bad Request

//No audio file detected on request. Not sent or invalid format.
{
    "status": false,
    "data": {
        "message": "NO_FILE_OR_INVALID_FORMAT"
    }
}
//User voice not enroled on this provider.
{
    "status": false,
    "data": {
        "message": "ENROLL_USER_VOICE_FIRST"
    }
}
// Missing Headers
{
    "status": false,
    "data": {
        "message": "AUTHENTICATION_HEADERS_MISSING"
    }
}

401 Invalid Headers.

HTTP/1.1 401 Unauthorized

{
    "status": false,
    "data": {
        "message": "INVALID_AUTHENTICATION_HEADERS"
    }
}

402 Payment Required - Request Limit Reached for Client Plan.

HTTP/1.1 402 Payment Required

{
    "status": false,
    "data": {
        "message": "REQUEST_LIMIT_REACHED"
    }
}

404 Not Found request types

HTTP/1.1 404 Not Found

// No active engine configuration for this provider.
{
    "status": false,
    "data": {
        "message": "NO_VOICE_ENGINE_CONFIGURATION_AVAILABLE"
    }
}
 // User's id not exists in biometrid environment.
{
    "status": false,
    "data": {
        "message": "USERID_NOT_EXISTS"
    }
}
//Client not found by given key.
{
    "status": false,
    "data": {
        "message": "CLIENT_NOT_FOUND/CHECK_AUTHENTICATION_HEADERS"
    }
}