Welcome to the CryptoNets™ Python SDK documentation

© 2023 by Private Identity® LLC All Rights Reserved

CryptoNets™ SDK is a Python library for generating and verifying private IDs using Face Recognition. CryptoNets™ SDK allows developers to integrate face recognition technology for secure and private ID verification. This documentation provides detailed guidance on installation, configuration, and usage.

Read Installation Guide for how to install the project.

Getting Started

• Installation Guide
  • Supported Python Versions
  • Dependencies
  • Using Virtual Environments
    • Creating a Virtual Environment
    • Activating the Environment
  • Installing CryptoNets™ SDK
  • Upgrading CryptoNets™ SDK

ChangeLog

• Changelog
  • Version 1.3.20 (2025-08-08)
  • Version 1.3.19 (2025-07-28)
  • Version 1.3.18 (2025-07-21)
  • Version 1.3.17 (2025-07-04)
  • Version 1.3.16 (2025-06-18)
  • Version 1.3.15 (2025-06-12)
  • Version 1.3.14 (2025-06-04)
  • Version 1.3.13 (2025-05-23)
  • Version 1.3.12 (2025-05-07)
  • Version 1.3.12b1 (2025-04-23)
  • Version 1.3.11 (2025-04-04)
  • Version 1.3.11b4 (2025-03-24)
  • Version 1.3.11b2 (2025-03-11)
  • Version 1.3.10 (2025-02-27)
  • Version 1.3.9 (2025-02-25)
  • Version 1.3.8 (2024-11-05)
  • Version 1.3.7 (2024-10-29)
  • Version 1.3.6 (2024-10-09)
  • Version 1.3.5 (2024-09-16)
  • Version 1.3.3 (2024-05-29)
  • Version 1.3.1 (2024-05-15)
  • Version 1.3.0 (2024-05-08)
  • Version 1.2.3 (2024-04-24)
  • Version 1.2.0 (2024-04-08)
  • Version 1.1.5 (2023-11-23)
  • Version 1.1.4 (2023-11-21)
  • Version 1.1.3 (2023-03-23)
  • Version 1.1.2 (2023-02-11)
  • Version 1.1.0 (2023-02-07)
  • Version 1.0.15 (2023-02-01)
  • Version 1.0.14 (2023-01-20)
  • Version 1.0.12 (2023-01-13)
  • Version 1.0.11 (2023-01-10)
  • Version 1.0.10 (2022-12-14)
  • Version 1.0.9 (2022-12-07)
  • Version 1.0.8 (2022-12-07)
  • Version 1.0.7 (2022-12-02)
  • Version 1.0.6 (2022-12-02)
  • Version 1.0.5 (2022-12-01)
  • Version 1.0.4 (2022-11-25)
  • Version 1.0.3 (2022-11-25)
  • Version 1.0.2 (2022-11-25)
  • Version 1.0.1 (2022-11-24)

Overview

• Overview

Usage

• CryptoNets SDK Usage Guide
  • API_KEY and SERVER_URL initialization parameters
  • Create and the Face Factor Object
  • 1) is_valid(): Validating Facial Biometrics
  • 2) estimate_age(): Determining User Age
  • 3) compare(): 1:1 Verification of Face Images
  • 4) compare_doc_with_face(): 1:1 Verification of a Face Image and Document Image
  • 5) antispoof_check(): Spoof Detection in Facial Recognition
  • 6) enroll(): Initialize Subject’s Face in the Identification System
  • 7) predict(): 1:N Matching of a Probe Image to the Enrolled Gallery
  • 8) delete(): Remove a User’s PUID from the Server
  • 9) get_iso_face(): Extract ISO Spec Face Image
    • Advanced Usage
      • Configuration Setup
      • Using Collections
      • Configuration Validation
      • Usage - Session
      • Usage - Local
      • is_valid: Advanced instructions
      • estimate_age: Advanced instructions
      • compare: Advanced instructions
      • enroll: Advanced instructions
      • predict: Advanced instructions
      • iso_face: Advanced instructions

Reference

• Factor
  • Face Factor
    • FaceFactor
      • FaceFactor.compare()
      • FaceFactor.delete()
      • FaceFactor.enroll()
      • FaceFactor.estimate_age()
      • FaceFactor.get_iso_face()
      • FaceFactor.is_valid()
      • FaceFactor.predict()
• Result Objects
  • AntispoofCheckResult
    • AntispoofCheckResult
      • AntispoofCheckResult.is_spoof
      • AntispoofCheckResult.message
      • AntispoofCheckResult.status
  • FaceCompareResult
    • FaceCompareResult
      • FaceCompareResult.distance
      • FaceCompareResult.first_validation_result
      • FaceCompareResult.message
      • FaceCompareResult.result
      • FaceCompareResult.second_validation_result
      • FaceCompareResult.status
  • FaceDeleteResult
    • FaceDeleteResult
      • FaceDeleteResult.message
      • FaceDeleteResult.status
  • FaceEnrollPredictResult
    • FaceEnrollPredictResult
      • FaceEnrollPredictResult.api_message
      • FaceEnrollPredictResult.api_status
      • FaceEnrollPredictResult.enroll_level
      • FaceEnrollPredictResult.enroll_performed
      • FaceEnrollPredictResult.guid
      • FaceEnrollPredictResult.message
      • FaceEnrollPredictResult.puid
      • FaceEnrollPredictResult.score
      • FaceEnrollPredictResult.status
  • FaceObjectResult
    • FaceObjectResult
      • FaceObjectResult.age
      • FaceObjectResult.age_confidence_score
      • FaceObjectResult.bounding_box
      • FaceObjectResult.message
      • FaceObjectResult.return_code
    • Utils
      • BoundingBox
      • Point
    • Return Codes for is valid and Error Messages
  • FaceValidationResult
    • FaceValidationResult
      • FaceValidationResult.error
      • FaceValidationResult.face_objects
      • FaceValidationResult.message
    • FaceObjectResult
      • FaceObjectResult
      • Utils
      • Return Codes for is valid and Error Messages
  • ISOFaceResult
    • ISOFaceResult
      • ISOFaceResult.confidence
      • ISOFaceResult.image
      • ISOFaceResult.iso_image_channels
      • ISOFaceResult.iso_image_height
      • ISOFaceResult.iso_image_width
      • ISOFaceResult.message
      • ISOFaceResult.status
  • AgeEstimateResult
    • AgeEstimateResult
      • AgeEstimateResult.face_age_objects
      • AgeEstimateResult.operation_message
      • AgeEstimateResult.operation_status_code
    • Utils
      • BoundingBox
      • Point
• Configuration
  • ConfigObject
    • ConfigObject
      • ConfigObject.config_param
  • LoggingLevel
    • LoggingLevel
  • PARAMETERS
    • PARAMETERS
    • Configurable Parameter List and Valid values

Search

• Search Page