F

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 FACECORE_KEY.

pip install facecore
export FACECORE_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 facecore.sdk import FaceCoreClient

with FaceCoreClient(base_url="https://api.facecore.dev", api_key=os.environ["FACECORE_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,
)