GETTING STARTED

API Fundamentals

Master the core concepts and patterns of the 7G Registry Platform API. Learn about request structures, authentication, response handling, and best practices for building robust integrations.

API Architecture

The 7G Registry Platform API is a modern RESTful financial services API for managing investor entities, transactions, and distributions. Built for performance, security, and scalability.

🔄

RESTful Design

Standard HTTP methods with predictable resource endpoints and consistent JSON responses.

🔒

Secure by Default

HTTPS-only communication with Bearer token authentication and role-based permissions.

⚡

High Performance

Optimized for high-volume operations with server-side filtering and efficient pagination.

Base Configuration

Environments

The 7G API provides multiple environments for different stages of development:

  • Production: api.7g.com.au
  • Development:dev-api.7g.com.au
  • Test: test-api.7g.com.au
  • Lab: lab-api.7g.com.au
  • Demo: demo-api.7g.com.au

Required Headers

Every API request must include these headers:

  • Content-Type: application/json
  • Version: 2.0
  • Authorization: {accessToken}

Standard Response Format

All API responses follow a consistent structure that makes error handling and data processing predictable:

Response Structure

Field Type Description Example
result boolean Indicates if the request was successful true / false
message string Human-readable message, typically error details "Invalid entity ID provided"
recordCount integer Number of records returned (for GET requests) 42
data object/array The actual response payload Entity object or array
json
{
  "result": true,
  "message": "",
  "recordCount": 1,
  "data": {
    "bizEntityID": 12345,
    "name": "Smith Family Trust",
    "bizEntityTypeID": 3,
    "createdDate": "2024-01-15T10:30:00Z",
    "accounts": [
      {
        "accountID": 67890,
        "productID": 100,
        "balance": 250000.00
      }
    ]
  }
}

HTTP Methods & Operations

GET Retrieve Data

Used to fetch resources from the API. Supports filtering, pagination, and dot operators for advanced queries.

  • Single record by ID
  • Multiple records with filters
  • Date-based synchronization

POST Create Resources

Creates new entities in the system. Requires complete data structures including all mandatory fields.

  • New business entities
  • Transaction records
  • Document uploads

PUT Update Resources

Modifies existing resources. Recommended pattern: GET → Modify → PUT to ensure data consistency.

  • Full resource updates
  • Preserves relationships
  • Validates business rules

DELETE Remove Resources

Deletes resources from the system. Subject to referential integrity constraints.

  • Cascading deletes where applicable
  • Blocked if dependencies exist
  • Audit trail maintained

Error Handling

The API uses standard HTTP status codes along with detailed error messages in the response body:

Common Status Codes

Code Status Description Action Required
200 OK Request successful Process the data in response
400 Bad Request Invalid request format or parameters Check request syntax and data
401 Unauthorized Invalid or expired token Refresh token or re-authenticate
403 Forbidden Insufficient permissions Verify user permissions
404 Not Found Resource doesn't exist Verify resource ID
409 Conflict Business rule violation Review business constraints
429 Too Many Requests Rate limit exceeded Implement exponential backoff
500 Server Error Internal server error Retry with exponential backoff
json
{
  "result": false,
  "message": "Invalid request: Missing required field 'bizEntityTypeID'",
  "recordCount": 0,
  "data": {}
}

Performance & Optimization

Performance Tips

The 7G API is optimized for performance, but following these guidelines will ensure the best experience for your integration.

Use Native IDs

Native IDs (e.g., bizEntityID) provide better performance than external IDs. Use external IDs only when necessary for integration purposes.

Implement Pagination

For large datasets, use pageSize (max 1000) and pageNumber parameters to retrieve data in manageable chunks.

Batch Operations

When creating multiple related entities, use the hierarchical structure to create them in a single API call rather than multiple individual calls.

Date-Based Sync

Use updatedDateFull for comprehensive change detection including all related entities, not just the primary record.

Rate Limiting & Throttling

The API implements rate limiting to ensure fair usage and system stability:

Rate Limit Guidelines

  • Implement exponential backoff when receiving 429 (Too Many Requests) responses
  • Cache frequently accessed data to reduce API calls
  • Use bulk operations where available instead of individual requests
  • Monitor rate limit headers in API responses for current usage
  • Implement request queuing for batch processing scenarios

Next Steps

Core Concepts Overview

Essential concepts powering the 7G Registry Platform API

IDs & External References

Understanding native vs external IDs and when to use each

Query & Filtering

Master dot operators and advanced filtering techniques

Pagination & Limits

Learn about pagination strategies and system limits