vericlient

A Python client for the Veridas APIs — voice and face biometrics, without writing the plumbing.

Documentation · Supported endpoints · Error handling · Changelog

Veridas exposes its biometrics products as HTTP APIs, and every integration starts by writing the same client: multipart uploads, per-service error codes, environment and region routing. vericlient is that client, so you can get to the part that is actually yours.

• Typed in and out. Every request and response is a pydantic model, so a malformed call fails where you made it, not three layers down.
• Errors you can catch. API failures arrive as specific exceptions — NetSpeechDurationIsNotEnoughError, not a 400 and a string to parse.
• Cloud or self-hosted. Sandbox and production, EU and US, or your own deployment.
• Three runtime dependencies, all of them ones you probably already have.

API support

Endpoint by endpoint in Supported endpoints.

Install

pip install vericlient

Python 3.11 or newer.

Quickstart

from vericlient import DaspeakClient

client = DaspeakClient(apikey="your_api_key")

# A credential is the biometric representation of a voice.
model = client.get_models().models[-1]
credential = client.generate_credential(audio="/path/to/enrolment.wav", hash=model).credential

# Compare a new recording against it.
result = client.compare_credential_to_audio(
    credential_reference=credential,
    audio_to_evaluate="/path/to/verification.wav",
)
print(f"Similarity: {result.score}")

Audio can be a path or a bytes object, so nothing has to touch the filesystem.

Point the client somewhere else with environment, location, or a url for a self-hosted deployment:

DaspeakClient(apikey="your_api_key", environment="production", location="us")
DaspeakClient(url="https://veridas.internal.example.com")

Configuration

Every setting can be passed to the constructor or read from an environment variable. The constructor argument wins, the environment fills in what you left out, and the library falls back to its own default.

Runnable examples

One script per client in scripts/, each covering every endpoint that client supports. They run as they stand — they default to the repository's own test media — so with an API key in the environment:

VERICLIENT_APIKEY=your_api_key pdm run python scripts/daspeak.py

The VCSP one creates an account, a group and two tags, and removes all of them before it ends. Run it against a sandbox.

Contributing

Issues and pull requests are welcome. The project uses PDM:

pdm install --dev
pdm run lint && pdm run format-check && pdm run test

Tests run against mocks by default. To exercise a real environment, set VERICLIENT_APIKEY and run SERVICE=daspeak pdm run test-eu-sandbox.

Licence

MIT.