fayda-python-sdk 1.0.4

Python SDK for Fayda IDA (Identity Authentication) - OTP, Authentication and eKYC services

Python IDA SDK

Python SDK for Fayda IDA (Identity Authentication) services. Provides a simple and intuitive interface for OTP generation, authentication, and eKYC (electronic Know Your Customer) operations.

Features

• OTP Management: Request and manage OTPs for Fayda ID verification
• Yes/No Auth: Yes/No authentication using OTP
• eKYC Services: Perform electronic KYC to retrieve verified identity information
• Secure Cryptography: Built-in support for RSA-OAEP, AES-GCM, and JWT signatures
• PKCS12 Key Management: Support for PKCS12 certificate and key files
• Easy Configuration: Configure via environment variables or dictionary
• Comprehensive Error Handling: Robust error handling and logging

Installation

Install from PyPI:

pip install fayda-python-sdk

Or install from source:

git clone https://github.com/National-ID-Program-Ethiopia/python-ida-sdk.git
cd python-ida-sdk
pip install -e .

Quick Start

Usage

Basic Configuration

from fayda_py_sdk import ConfigBuilder
from fayda_py_sdk.dto import OtpRequestDTO, AuthRequestDTO

# Configure from environment variables
config = ConfigBuilder().from_env()

# Or configure from dictionary
config = ConfigBuilder().from_dict({
    "partnerId": "fayda-partner-demo",
    "fayda.base.url": "https://fayda.baseurl.et",
    "mispLicenseKey": "your-license-key",
    "partnerApiKey": "your-api-key",
    "ida.reference.id": "PARTNER",
    "p12.path": "keys",
    "p12.password": "pass@123",
    "ida.ssl.verify": False
})

# Build client
client = config.build()

Request OTP

from fayda_py_sdk.dto import OtpRequestDTO

otp_request = OtpRequestDTO(
    individual_id="1234567890",
    individual_id_type="FIN",
    otp_channel=["email"]
)

response = client.request_otp(otp_request)
print(response)

Yes/No Auth

from fayda_py_sdk.dto import AuthRequestDTO

# Fayda ID: UIN for FIN or VID for FAN
auth_request = AuthRequestDTO(
    individual_id="1234567890",  # Fayda ID
    individual_id_type="UIN",     # UIN for FIN or VID for FAN
    otp="123456"
)

response = client.yes_no_auth(auth_request)
print(response)

Perform eKYC

from fayda_py_sdk.dto import AuthRequestDTO

# Fayda ID: UIN for FIN or VID for FAN
ekyc_request = AuthRequestDTO(
    individual_id="1234567890",  # Fayda ID
    individual_id_type="UIN",     # UIN for FIN or VID for FAN
    otp="123456"
)

response = client.perform_ekyc(ekyc_request)
print(response)

Configuration

The SDK can be configured using:

1. Environment Variables:

   • PARTNER_ID: Partner ID
   • FAYDA_BASE_URL: Base URL for Fayda API
   • MISP_LICENSE_KEY: MISP License Key
   • PARTNER_API_KEY: Partner API Key
   • IDA_REFERENCE_ID: IDA Reference ID
   • P12_PATH: Path to PKCS12 keys directory
   • P12_PASSWORD: Password for PKCS12 files
   • IDA_SSL_VERIFY: Enable/disable SSL verification (true/false)

2. Dictionary: Pass configuration as a dictionary to ConfigBuilder.from_dict()

3. Manual Configuration: Use ConfigBuilder().set_config(key, value) for individual settings

Key Files

The SDK expects PKCS12 key files in the keys directory (default: keys/). The files should be named:

• {partnerId}-partner.p12 - Partner private key and certificate
• {partnerId}-partner.cer - Partner certificate

Running Examples

# Make sure your keys are in the keys/ directory
# Update configuration in example.py or set environment variables

python example.py

Requirements

• Python 3.8 or higher
• PKCS12 key files (.p12 format) for partner authentication
• Valid Fayda API credentials

Error Handling

The SDK includes comprehensive error handling. All exceptions are logged and raised with descriptive messages. Common errors include:

• RuntimeError: For authentication failures, certificate errors, or API errors
• ValueError: For invalid configuration or key file issues
• Exception: For network or parsing errors

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Support

For issues, questions, or contributions, please use the GitHub Issues page.

For direct support, contact:

• Fayda API Support: [e-mail]

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

See CHANGELOG.md for a list of changes and version history.