Download the PHP package azaharizaman/nexus-sanctions without Composer
On this page you can find all versions of the php package azaharizaman/nexus-sanctions. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download azaharizaman/nexus-sanctions
More information about azaharizaman/nexus-sanctions
Files in azaharizaman/nexus-sanctions
Package nexus-sanctions
Short Description Regulatory screening engine for sanctions lists (OFAC, UN, EU, UK HMT) and PEP detection with fuzzy matching
License MIT
Informations about the package nexus-sanctions
Nexus\Sanctions
Production-ready international sanctions screening and Politically Exposed Person (PEP) detection for financial compliance.
Table of Contents
- Overview
- Features
- Installation
- Quick Start
- Core Concepts
- Usage Examples
- Sanctions Screening
- PEP Detection
- Periodic Re-Screening
- Available Interfaces
- Enums Reference
- Value Objects
- Exception Handling
- Integration Guide
- Architecture
- License
Overview
Nexus\Sanctions is a truly atomic, framework-agnostic PHP package that provides enterprise-grade sanctions screening and PEP detection capabilities. Designed for financial institutions, compliance teams, and ERP systems, it implements FATF (Financial Action Task Force) guidelines and OFAC requirements.
Features
Sanctions Screening
- ✅ Multi-list screening - OFAC, UN, EU, UK HMT, AU DFAT, CA OSFI, JP METI, CH SECO
- ✅ Advanced fuzzy matching - Levenshtein distance, Soundex, Metaphone, token-based
- ✅ Configurable thresholds - Similarity threshold tuning (default: 85%)
- ✅ Batch processing - Screen multiple parties efficiently
- ✅ Alias support - Screen against known aliases
PEP Detection
- ✅ FATF-compliant - Implements Financial Action Task Force guidelines
- ✅ Risk-level classification - HIGH, MEDIUM, LOW, NONE
- ✅ Family & associates - Identify related persons with PEP exposure
- ✅ Former PEP detection - 40% risk reduction after 12 months rule
- ✅ Enhanced Due Diligence - Automatic EDD requirement determination
Periodic Re-Screening
- ✅ Risk-based frequency - REAL_TIME, DAILY, WEEKLY, MONTHLY, QUARTERLY, SEMI_ANNUAL, ANNUAL
- ✅ Batch execution - Process scheduled screenings efficiently
- ✅ Schedule management - Update, cancel, and query schedules
- ✅ Retry logic - Exponential backoff for failed screenings
Architecture
- ✅ Framework agnostic - Pure PHP 8.3+, works with Laravel, Symfony, or any framework
- ✅ Interface-based - Define contracts, consumers provide implementations
- ✅ Zero circular dependencies - Only depends on
azaharizaman/nexus-commonand PSR interfaces - ✅ Immutable value objects - Type-safe, validated domain objects
- ✅ Comprehensive logging - PSR-3 compatible logging
Installation
Requirements:
- PHP 8.3 or higher
azaharizaman/nexus-common^1.0psr/log^3.0
Quick Start
Core Concepts
Sanctions Lists
The package supports 8 major international sanctions lists:
| List | Authority | Description |
|---|---|---|
OFAC |
US Treasury | Specially Designated Nationals (SDN) List |
UN |
United Nations | Security Council Consolidated List |
EU |
European Union | Consolidated Financial Sanctions List |
UK_HMT |
UK Treasury | Office of Financial Sanctions (OFSI) |
AU_DFAT |
Australia | Department of Foreign Affairs and Trade |
CA_OSFI |
Canada | Office of the Superintendent of Financial Institutions |
JP_METI |
Japan | Ministry of Economy, Trade and Industry |
CH_SECO |
Switzerland | State Secretariat for Economic Affairs |
Match Strength
Matches are classified by confidence level:
| Strength | Similarity | Action |
|---|---|---|
EXACT |
100% | Block transaction immediately |
HIGH |
85-99% | Requires immediate compliance review |
MEDIUM |
70-84% | Requires thorough investigation |
LOW |
50-69% | Manual verification recommended |
NONE |
<50% | No action required |
PEP Risk Levels
Based on FATF guidelines:
| Level | Description | EDD Required |
|---|---|---|
HIGH |
Heads of state, senior politicians, military officials | Yes + Senior Management Approval |
MEDIUM |
Mid-level government officials, regional figures | Yes |
LOW |
Former PEPs (>12 months), honorary positions | Standard DD may suffice |
NONE |
No political exposure | Standard CDD applies |
Usage Examples
Sanctions Screening
Basic Screening
Batch Screening
Screen Single Name
Calculate Similarity
PEP Detection
Basic PEP Screening
Assess Risk Level
Check EDD Requirement
Check Related Persons
Periodic Re-Screening
Schedule Screening
Execute Scheduled Screenings
Update Frequency
Available Interfaces
SanctionsScreenerInterface
Primary interface for sanctions screening operations.
PepScreenerInterface
Interface for PEP detection and risk assessment.
PeriodicScreeningManagerInterface
Interface for managing periodic re-screening schedules.
SanctionsRepositoryInterface
Interface for data access - must be implemented by consuming application.
PartyInterface
Interface for party data required for screening.
Enums Reference
SanctionsList
MatchStrength
PepLevel
ScreeningFrequency
Value Objects
ScreeningResult
Complete result of a sanctions screening operation.
SanctionsMatch
A single match from a sanctions list.
PepProfile
A PEP (Politically Exposed Person) profile.
Exception Handling
Exception Hierarchy
InvalidPartyException
Thrown when party data is invalid for screening.
Factory methods:
missingRequiredFields(string $partyId, array $missingFields)invalidName(string $partyId, string $name, string $reason)invalidDateOfBirth(string $partyId, string $dob, string $reason)invalidNationality(string $partyId, string $nationality)
ScreeningFailedException
Thrown when screening operation fails.
Factory methods:
apiTimeout(string $partyId, SanctionsList $list, int $timeoutSeconds)networkError(string $partyId, SanctionsList $list, string $error)invalidListData(SanctionsList $list, string $reason)screeningFailed(string $partyId, string $reason)
SanctionsListUnavailableException
Thrown when a sanctions list is unavailable.
Integration Guide
1. Implement SanctionsRepositoryInterface
2. Implement PartyInterface Adapter
3. Register in Service Container (Laravel)
4. Use in Application Services
Architecture
Package Structure
Atomic Architecture Principles
- Zero Circular Dependencies: Only depends on
azaharizaman/nexus-commonand PSR interfaces - Interface-Based: Package provides contracts, consuming applications implement
- Independently Testable: Can be unit tested without database or framework
- Framework Agnostic: Pure PHP 8.3+, works with any framework
- Stateless Services: All services are
final readonlywith no mutable state
License
MIT License. See LICENSE for details.
Maintained by: Nexus Architecture Team
Last Updated: December 2025