Skip to main content

Voice Authentication

Biometric voice authentication for enrollment, verification, and management. Allows users to authenticate using their voiceprint.

Admin Endpoints

Create Voice Enrollment

Start voice enrollment for a user.

Endpoint: POST /uflow/admin/auth/voice/enroll

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Request Body

{
"user_id": "string",
"voice_data": "string"
}

Response

Success (200):

{
"enrollment_id": "string",
"status": "enrolled",
"message": "string"
}

Error Responses:

  • 400 - Bad Request
  • 401 - Unauthorized

Verify Voice

Verify a user's voice against their enrolled voiceprint.

Endpoint: POST /uflow/admin/auth/voice/verify

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesAdmin Bearer JWT token

Request Body

{
"user_id": "string",
"voice_data": "string"
}

Response

Success (200):

{
"verified": true,
"confidence": 0.95,
"message": "string"
}

Error Responses:

  • 400 - Bad Request
  • 401 - Unauthorized
  • 404 - No voiceprint enrolled for user

Get Voice Status

Get voice enrollment status for a user.

Endpoint: GET /uflow/admin/auth/voice/status/{user_id}

Path Parameters

ParameterTypeRequiredDescription
user_idstringYesUser ID

Response

Success (200):

{
"enrolled": true,
"enrollment_date": "string",
"user_id": "string"
}

Delete Voice Enrollment

Remove voice enrollment for a user.

Endpoint: DELETE /uflow/admin/auth/voice/enrollment/{user_id}

Path Parameters

ParameterTypeRequiredDescription
user_idstringYesUser ID

Response

Success (200):

{
"message": "Voice enrollment deleted successfully"
}

Error Responses:

  • 401 - Unauthorized
  • 404 - Voice enrollment not found

End-User Endpoints

Enroll Voice

End-user self-service voice enrollment.

Endpoint: POST /uflow/user/auth/voice/enroll

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesEnd-user Bearer JWT token

Request Body

{
"voice_data": "string"
}

Response

Success (200):

{
"enrollment_id": "string",
"status": "enrolled",
"message": "string"
}

Verify Voice (End-User)

End-user voice verification.

Endpoint: POST /uflow/user/auth/voice/verify

Headers

HeaderTypeRequiredDescription
AuthorizationstringYesEnd-user Bearer JWT token

Request Body

{
"voice_data": "string"
}

Response

Success (200):

{
"verified": true,
"confidence": 0.95,
"message": "string"
}

Get Voice Status (End-User)

Get own voice enrollment status.

Endpoint: GET /uflow/user/auth/voice/status

Response

Success (200):

{
"enrolled": true,
"enrollment_date": "string"
}

Delete Voice Enrollment (End-User)

Remove own voice enrollment.

Endpoint: DELETE /uflow/user/auth/voice/enrollment

Response

Success (200):

{
"message": "Voice enrollment deleted successfully"
}