Skip to main content

Official VerifID identity verification SDK for Python

Project description

verifid

Official VerifID identity verification SDK for Python.

Install

pip install verifid

Quick Start

from verifid import VerifID
from verifid.types import UserData

client = VerifID(
    api_key="sk_live_...",
    base_url="https://api.verifid.dev",  # optional
)

# Create a verification session
session = client.create_session(
    document_type="national_id",
    user_data=UserData(full_name="Ana Garcia"),
)
print(session.session_id, session.qr_url)

# Upload images
client.upload_document_front(session.session_id, base64_image)
client.upload_document_back(session.session_id, base64_image)
client.upload_selfie(session.session_id, [base64_frame1, base64_frame2])

# Trigger verification and wait for result
client.trigger_verification(session.session_id)
result = client.wait_for_result(session.session_id)

print(result.status)            # "VERIFIED" | "REJECTED"
print(result.confidence_score)  # 0.0 - 1.0
print(result.reasons)           # ["face_match_passed", ...]

Single-Device Verify

created = client.verify(
    selfie_image=selfie_b64,
    document_image=document_b64,
)

result = client.get_verification(created.session_id)

Context Manager

with VerifID(api_key="sk_live_...") as client:
    session = client.create_session()
    # ...

GDPR

# Export session data
data = client.export_session_data(session_id)

# Delete session data (right to erasure)
client.delete_session_data(session_id)

Error Handling

from verifid import VerifIDError, RateLimitError

try:
    client.create_session()
except RateLimitError as e:
    print(f"Rate limited. Retry after {e.retry_after}s")
except VerifIDError as e:
    print(f"API error: {e.status}{e}")

Configuration

Param Default Description
api_key (required) Your API key (sk_live_* or sk_test_*)
base_url https://api.verifid.dev API base URL
timeout 30.0 Request timeout in seconds

Sandbox

Use a sk_test_* key to get mock results without real ML processing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

verifid-1.0.0.tar.gz (11.0 kB view details)

Uploaded Source

File details

Details for the file verifid-1.0.0.tar.gz.

File metadata

  • Download URL: verifid-1.0.0.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for verifid-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0b1bb1e9400a309af00c190164928ab333305b743b1a5315a16126c32fdbf0ae
MD5 6d6638373bdaa53a500fc995f9b96082
BLAKE2b-256 155944384b8cdae2c31ab782f481e755c35228b0b055c517aa0a823d0351c53a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page