Overview

Validates one or more superannuation fund USIs (Unique Superannuation Identifiers) to confirm they are active and able to receive electronic contributions through SuperChoice.

Simplified Request Format

The fund validation endpoint has been simplified to automatically retrieve employer information from the database. You only need to provide the fund USIs you want to validate.

Minimal Request (Recommended):

{
  "fundUsis": ["40328908469310"]
}

The system automatically retrieves your employer information based on your authentication credentials, so you no longer need to include employer details in the request.

Transaction ID - Server-Generated

The server automatically generates a unique transaction ID and timestamp for each request.

Transaction ID Format: txn-{uuid}

Example generated IDs:

• txn-550e8400-e29b-41d4-a716-446655440000
• txn-6ba7b810-9dad-11d1-80b4-00c04fd430c8

The transaction ID will be:

• Included in all response payloads
• Available in error messages for troubleshooting
• Returned in response headers for request tracking

Transaction ID in Response

The validate fund endpoint returns the server-generated transaction ID in the response:

{
  "success": true,
  "statusCode": 200,
  "message": "Fund validation successful",
  "transactionId": "txn-550e8400-e29b-41d4-a716-446655440000"
}

Use this ID for logging, debugging, and tracking requests in your system.

Validation Checks Performed

1. USI Format: Verifies the USI follows the correct 14-character format
2. Fund Active Status: Confirms the fund is currently accepting contributions
3. Electronic Capability: Verifies the fund can receive SuperStream contributions
4. Employer Association: Optional check if employer is already registered with the fund

When to Use

• Member Onboarding: Validate the fund USI provided by a new employee
• Choice of Fund: Verify funds before presenting them to employees
• Pre-submission Check: Validate all funds in a batch before submission
• Periodic Verification: Funds occasionally change status (mergers, closures)

Common USI Issues

• Fund has merged with another fund (will return new USI)
• Fund is temporarily not accepting electronic contributions
• USI is for a closed or legacy product

Benefits of Simplified Format

• Simpler Integration: No need to manage employer details
• Smaller Request Payloads: Only send what's necessary
• Always Up-to-Date: Uses the most current employer information from the database
• Consistent Data: Same employer data used across all requests

Best Practices

1. Cache valid USIs for up to 24 hours
2. Always re-validate before first contribution to a new fund
3. Handle fund merge redirects gracefully
4. Use the transaction ID from responses for request tracking

Overview

Retrieves a comprehensive list of all superannuation funds currently registered and active in the SuperChoice network. These funds are verified and capable of receiving electronic contributions.

Authentication

This endpoint requires Basic Authentication using your API Key credentials. For detailed authentication instructions, please refer to the Authentication guide.

Use Cases

• Initial Setup: Populate your system's fund dropdown/selection list
• Periodic Refresh: Update your local fund cache (recommended: daily)
• Validation: Verify a USI before attempting contribution submission
• Member Onboarding: Present fund options to new employees

Response Details

The response includes each fund's:

• USI (Unique Superannuation Identifier): The 14-character identifier required for contributions
• Fund Name: The display name for user interface purposes
• Product Name: The specific product name within the fund
• Organisation Name: The name of the superannuation organisation
• Australian Business Number (ABN): The fund's ABN
• Account Details: Bank account information (account name, BSB, account number)
• Contact Details: Contact information including name, phone number, and email

Performance

• Response is cached for 15 minutes on the server
• Average response time: < 200ms
• Typical list size: 200-300 active funds

Rate Limiting

This endpoint has a higher rate limit (300 requests/minute) as it's commonly used for autocomplete features.