API contract reference. Production biometric endpoints currently return 503; example thresholds, SDK calls and performance figures are not release approval. Try the separately protected private comparison demo.

Getting Started

Quickstart

Install an SDK or call the REST API directly. Sandbox keys return real calibrated scores on test captures and never bill.

1

Install the SDK & export your key

Create a sandbox key in the Dashboard and export it as PAXLI_KEY.

pip install paxli
export PAXLI_KEY="fc_sbx_..."
2

Run a 1:1 verification

Send a live selfie (image_a) and reference ID photo (image_b) with a calibrated profile.

import os
from paxli.sdk import PaxLIClient

with PaxLIClient(base_url="https://api.paxli.dev", api_key=os.environ["PAXLI_KEY"]) as fc:
    res = fc.verify(
        open("selfie.jpg", "rb").read(),
        open("id_photo.jpg", "rb").read(),
        profile="standard",
        capture_type="selfie_id",
    )
    print(res["decision"], res["score"], res["threshold"])
3

Bind a one-time liveness session

For higher-assurance onboarding, mint a single-use session with POST /v1/liveness/sessions, submit the signed frame manifest, then pass liveness_session_id into /v1/verify.

One-time liveness flow (Python)
session = fc.create_liveness_session(tier="active", challenge_count=2)
# Capture frames matching session["challenges"], then sign manifest with HMAC-SHA256
verdict = fc.submit_liveness_session(
    session["session_id"],
    frames=[frame1, frame2],
    manifest_signature=signature,
)
verify = fc.verify(
    selfie_bytes,
    id_bytes,
    liveness_session_id=session["session_id"],
    require_liveness=True,
)