7G Registry Platform API Reference
Complete reference for all 75 endpoints across 14 resource types. Built for financial services with sophisticated transaction processing and entity management.
Complete API Reference
This comprehensive reference covers all 75 endpoints across 14 resource types, designed specifically for financial services with sophisticated transaction processing, entity management, and regulatory compliance features.
API Architecture & Flow
Complete integration workflow from authentication through transaction execution to reporting. The 7G API architecture supports flexible workflows with parallel resource operations and event-driven coordination.
Obtain JWT tokens for secure API access with automated expiration and refresh workflows. Retrieve system metadata for validation and form building.
Configure investment products with unit classes, allocation rules, distribution settings, and initial pricing foundation for transaction processing.
Establish investor identity using BizEntity-centric architecture supporting Individual, Company, Trust, SMSF with nested Person/Organisation structures and automatic deduplication.
Coordinate transaction workflows with notice periods and approval gates (BizEvent) before executing immutable financial operations (BizTransaction) with real-time balance calculations.
Execute distribution lifecycle from declaration through DRP allotment with withholding tax automation. Maintain current investment pricing with NAV calculations and performance tracking.
Generate investor statements and regulatory documents with comprehensive metadata management. Execute asynchronous report generation with status monitoring and automated delivery.
Workflow Flexibility
This diagram presents a typical integration workflow. The 7G API architecture supports parallel operations across resources—Investment products can be configured independently, Distributions can be declared while transactions process, and reporting can occur at any lifecycle stage. The BizEntity-centric architecture (Stage 3) is the foundational principle for all investor operations.
Authentication & Security
Secure API access with JWT-based authentication and token management. All endpoints except /User/Login and /Common/Lookup require access token authentication.
User Login
Authenticate user credentials and obtain JWT access tokens for secure API access. No prior authentication required - this is your entry point to the 7G system.
Refresh Token
Refresh expired access tokens using refresh tokens to maintain continuous API access without requiring user re-authentication.
Entity Management
Core investor and organizational entity management built on BizEntity-centric architecture. BizEntity serves as the primary aggregation point for all investor operations, with specialized resources for advanced scenarios.
BizEntity Primary
The foundational investor identity supporting Individual, Company, Trust, SMSF, and Partnership structures. Central aggregation point for all investor operations with 8 endpoints.
Create BizEntity
Create complete investor entity with nested Person/Organisation structures, accounts, addresses, and payment details in a single atomic operation.
Get BizEntities
Advanced querying with 15+ filter parameters, dot operators (.Equal, .Contains), cross-resource filtering, and comprehensive pagination support.
Update BizEntity
Complete replacement update for entity structures, party relationships, and associated data with automatic deduplication logic.
Delete BizEntity
Remove entity from system (restricted if active transactions exist). Cascades to related records while preserving audit trails.
Account Holdings
Real-time investment position data with current balances, unit quantities, market values, and performance metrics across all accounts.
Establish hierarchical entity relationships for complex corporate structures, trust arrangements, and multi-level ownership models.
Modify existing hierarchical relationships, change ownership percentages, and update structural dependencies between entities.
Remove Parent Relationship
Safely remove hierarchical links while maintaining data integrity and preserving historical relationship records for audit purposes.
The 7G API is designed around BizEntity as the primary aggregation point for all investor operations. This architecture ensures data consistency, prevents duplication, and provides comprehensive relationship management.
🏛️ Primary Resource
The central hub for all investor operations. Creates and manages Person, Organisation, Address, Communication, and PaymentDetail records through comprehensive nested structures with deduplication.
🔧 Supporting Resources
Direct endpoints for specialized workflows. Use when focused operations on specific resources better suit your integration needs.
🔗 Deduplication Logic
When creating entities through BizEntity operations, the platform deduplicates Person and Organisation
records based on externalPersonId and externalOrganisationId. The same external ID used multiple
times in a single request creates only ONE record, preventing data duplication.
Supporting Resources Supporting
Direct endpoints for specialized scenarios. Most management occurs through BizEntity operations. Use these for bulk imports, data migration, or when focused resource operations better suit your workflow.
Person
4 endpointsIndividual identity management with comprehensive KYC/AML data, tax residency information, and FATCA classification for regulatory compliance.
Organisation
4 endpointsCorporate entities, trusts, and institutions with associated persons, FATCA classification, and complex organizational structure management.
Address
4 endpointsPhysical and postal address management with international support, validation services, and exclusive entity ownership relationships.
Communication
4 endpointsContact information management including phone, email, and other communication methods with verification and preference settings.
PaymentDetail
4 endpointsBanking and payment method configuration for automated deposits, distributions, and redemption processing with secure credential management.
Transaction Processing
High-performance financial transaction engine supporting the complete investment lifecycle. Features real-time balance calculations, automated settlement workflows, and sophisticated business rule validation.
BizTransaction
Mission-critical transaction processing system handling the complete investment lifecycle with real-time balance calculations, automated settlement workflows, and comprehensive audit trails.
Adjust Quantity
Apply relative quantity adjustments for corrections, corporate actions, or administrative changes with comprehensive audit trail maintenance.
Unit Allotment
Convert deposit funds into investment units based on current pricing, allocation rules, and automated unit calculation with settlement processing.
Convert between investment classes or products with automated pricing calculations, compliance validation, and seamless account transitions.
Process Deposit
Record cash deposits with fee calculations, automated processing workflows, and integration with external payment systems and bank reconciliation.
Process Redemption
Execute investment redemptions by amount or unit quantity with automated valuation, fee application, and payment processing coordination.
Set Quantity
Set precise unit quantities for reconciliation, migration, or correction scenarios with full validation and balance recalculation.
Account Transfer
Transfer units between accounts with validation of transfer rules, automated compliance checking, and real-time balance adjustments.
Get Transactions
Advanced transaction querying with comprehensive filtering, dot operators, status-based searches, and cross-entity transaction tracking with pagination.
Events & Notifications
Transaction event notifications and corporate action processing. Handles notice workflows before actual transaction execution.
BizEvent
Event-based notifications for upcoming transactions and corporate actions. Enables notice periods, approval workflows, and regulatory compliance tracking across the investment lifecycle.
Notice of Conversion
Issue conversion notices for investment class changes with impact analysis, stakeholder notifications, and compliance validation.
Notice of Deposit
Create advance notice for upcoming deposit transactions with regulatory notice periods and stakeholder notification workflows.
Notice of Redemption
Generate redemption notices for pending withdrawals with automated notice period calculations and approval gate management.
Retrieve business events with comprehensive filtering by status, type, entity, and date ranges for event tracking and compliance reporting.
Cancel pending business events with automated reversal of notices, stakeholder notifications, and audit trail maintenance.
Investment & Pricing Management
Investment product and pricing management. Handles unit classes, share classes, and daily pricing with comprehensive price history.
Investment
Investment product management including unit classes, share classes, allocation rules, distribution settings, and comprehensive pricing management with historical tracking.
Create new investment products with unit classes, allocation rules, distribution configurations, and fee structures for comprehensive product setup.
Retrieve investment products with filtering by status, type, manager, and performance metrics for portfolio analysis and product discovery.
Modify investment product configurations, allocation rules, distribution settings, and operational parameters with versioning and audit trails.
Delete Investment Product
Remove investment products from system (restricted if active holdings exist) with cascading cleanup of related configuration data.
Set Investment Price
Establish daily pricing for investment products with NAV calculations, performance tracking, and automated distribution to valuation systems.
Retrieve historical and current pricing data with date range filtering, performance analytics, and comprehensive valuation metrics.
Modify existing price records for corrections, adjustments, or backdated entries with comprehensive audit trail and impact analysis.
Delete Investment Price
Remove erroneous price records with validation of dependent transactions and automated recalculation of affected valuations.
Distribution Management
Corporate action lifecycle from declaration through execution. Features distribution reinvestment plans (DRP), withholding tax calculations, and declaration-time account selection (preCalculatedAccounts, includeAccounts, excludeAccounts).
Distribution
Complete corporate action lifecycle from declaration through execution with distribution reinvestment plans (DRP), withholding tax automation, and account-specific processing.
Create Distribution
Create distribution declarations with tax component breakdowns, payment dates, record dates, and comprehensive corporate action parameters.
Declare Distribution
Declare distributions with account selection (preCalculatedAccounts, includeAccounts, excludeAccounts), entitlement calculations, and automated processing setup.
Execute Distribution
Process distribution payments with withholding tax calculations, payment method routing, and comprehensive reconciliation tracking.
DRP Allotment
Execute Distribution Reinvestment Plan (DRP) allotments with automated unit allocation, pricing application, and account balance updates.
Retrieve distribution records with filtering by status, product, date ranges, and comprehensive account-level impact analysis and reporting.
Modify distribution parameters, tax components, payment scheduling, and DRP configurations with comprehensive validation and impact assessment.
Delete Distribution
Delete distribution declarations with payment dates, and comprehensive corporate action parameters.
Read-only access to account-level distribution details. Account management now occurs at declaration time via Declare endpoint.
Document & Reporting
Document management system and report generation capabilities. Handles file uploads, statement generation, and comprehensive reporting for compliance and analytics.
Document Management
Comprehensive document lifecycle management including metadata, file operations, and automated statement generation for investor communications and regulatory reporting.
Create Document
Create document metadata records with classification, versioning, access controls, and automated indexing for comprehensive document management.
Get Documents
Retrieve document metadata with advanced filtering by type, entity, date, status, and comprehensive search capabilities across document libraries.
Update Document
Update existing document metadata records with classification, versioning, access controls, and automated indexing for comprehensive document management.
Delete Document
Delete existing document metadata records with classification, versioning, access controls, and automated indexing for comprehensive document management.
Generate Statements
Automated generation of investor statements, transaction reports, and regulatory documents with template management and batch processing.
Upload Files
Secure file upload with format validation, encryption, and automated backup for investor documents and regulatory filings.
Download Files
Secure file retrieval with access logging, watermarking, and audit trail maintenance for sensitive financial document distribution.
Update File
Secure file updates, with access logging, watermarking, and audit trail maintenance for sensitive financial document distribution.
Report Generation
Asynchronous report generation system with comprehensive status monitoring, flexible parameter configuration, and automated delivery capabilities for business intelligence and regulatory reporting.
Generate Report
Initiate asynchronous report generation with flexible parameters, scheduling options, and automated delivery to specified recipients or secure download locations.
Get Reports
Retrieve completed reports with filtering by type, status, generation date, and comprehensive metadata for report library management and distribution tracking.
Check Status
Monitor report generation progress with detailed status information, completion estimates, error reporting, and automated notification capabilities.
Delete Report
Remove completed reports from the system with secure deletion, audit trail maintenance, and automated cleanup of associated temporary files.
Utilities & System
System utilities including health monitoring and metadata lookup services. Essential for system integration and monitoring.
Common
Essential system utilities including metadata lookup services and health monitoring. These endpoints require no authentication and provide foundational system integration capabilities.
Lookup Metadata
Retrieve system metadata including enum values, configuration options, validation rules, and reference data for dynamic form building and data validation.
Health Check
Monitor API system health with comprehensive status reporting, dependency checking, and performance metrics for integration monitoring and alerting.
Key API Features
Essential capabilities that make the 7G API powerful and flexible for financial services integration.
🆔 Dual ID System
Native IDs for performance, External IDs for integration flexibility. Most endpoints support both identification methods.
🔍 Advanced Filtering
Dot operators (.Equal, .GreaterThan, .Contains, .In) enable precise data retrieval with complex filter combinations.
📊 Pagination Support
Built-in pagination with pageSize (max 1000) and pageNumber parameters for efficient data handling.
🔗 Relationship Management
Complex entity relationships with referential integrity, cascade operations, and business rule validation.
📈 Real-time Calculations
Automatic balance updates, closing calculations, and audit trail maintenance for all transactions.
⚡ Performance Optimized
Efficient queries, bulk operations support, and date-based synchronization for large-scale integrations.
Getting Started
Ready to integrate? Start with these essential resources to get up and running quickly.