This major release of Ark introduces a more flexible foundation for connecting to downstream providers, orchestrating onboarding journeys, and modelling the businesses and individuals you serve. Highlights include a new connector routing capability, Ark Flows for workflow orchestration, an expanded party model that now supports companies and sole traders, and a configurable business rules engine.

This release also brings new and expanded connectors, a vendor-agnostic approach to identity verification, and a range of behavioural and quality improvements across the platform. Some integrations will need minor updates to move smoothly onto this release; the highlights are outlined in the Migration or Upgrade Notes below, and your support representative can help with the specifics.

What's New​

New Features & Endpoints​

Connector Routing​

Ark now resolves the right downstream provider for each request through a flexible, configurable routing capability. Routing can take provider health and priority into account when selecting where to send a request, giving you more control over how Ark connects to underlying providers without changing how you call the API. This supersedes the previous mapping-based approach to selecting connectors.

Ark Flows​

Ark now offers workflow orchestration through Ark Flows, allowing onboarding journeys to be coordinated as managed, multi-step workflows. This provides a more reliable and observable way to run the longer-running processes that onboarding often involves.

Expanded Parties​

The party model has been extended beyond individuals to support a wider range of onboarding scenarios:

• Company parties - create, manage, and provision company entities.
• Sole trader parties - create and manage sole traders, including ABN and trading name details.
• Party relationships - associate parties with one another (for example, directors or secretaries of a company).
• Party search - find existing parties by name.

Example Endpoints:

• POST /v1/parties/{partyId}/relationships - Associate a related party (e.g. a director or secretary)
• GET /v1/parties/search - Search for existing parties by name

Account Signatories​

Ark now provides account signatory management, letting you control who is authorised to act on an account.

• GET /v1/accounts/{accountId}/signatories - List signatories for an account
• POST /v1/accounts/{accountId}/signatories - Add a signatory to an account
• DELETE /v1/accounts/{accountId}/signatories/{partyId} - Remove a signatory from an account

Business Rules Engine​

Ark now includes a configurable business rules engine, enabling decisioning logic to be defined and evaluated as part of your flows. Rules can be evaluated through the API, giving you a consistent way to apply business logic across journeys.

• POST /v1/rules/{ruleKey}/evaluate - Evaluate a configured business rule

New & Expanded Connectors​

• SimpleKYC - a new identity verification connector supporting KYC and KYB.
• MessageMedia - a new SMS notification connector, now the default for notifications.
• Vendor-agnostic KYX - identity verification is now modelled in a provider-agnostic way, so you can work with a consistent verification experience across underlying providers.

Changes & Improvements​

Identity verification (KYX) is now vendor-agnostic, providing a consistent model across the underlying verification providers. Notification and connector responses now include a vendor reference, making it easier to correlate Ark activity with the underlying provider. Connector routing replaces the previous mapping layer for selecting downstream providers.

Please review the Migration or Upgrade Notes section below for any changes that require action.

Fixes​

Resolved Issues​

• Platform & Payments:

  • Transfer Initiation: POST transfer requests now return 201 Created in line with the API contract.
  • Improved serialisation of payments connector responses for greater reliability.

• Kleber Connector:

  • Address Response Handling: Improved handling of empty and invalid address responses.
  • Corrected address unit field mapping.

Security Updates​

Authentication & Authorization​

No authentication or authorization changes in this release.

Known Issues​

No critical issues are currently known in this release.

For the latest information on identified issues, workarounds, and resolution timelines, please refer to the Ark Support page or contact your support representative.

Migration or Upgrade Notes​

This release includes a few integration updates to ensure a smooth upgrade. At a high level, clients should plan to:

• Provide party context on requests using the partyid header.
• Review error handling against the refreshed error codes and response statuses introduced in this release.
• Update integrations for a small number of relocated admin and party-document endpoints.
• Treat card and account identifiers as opaque values.

These updates are straightforward and can be planned alongside your usual integration testing. For the detailed migration guide and a full list of affected codes and endpoints, please refer to the Ark documentation or contact your support representative, who can help you plan the transition.

Documentation Updates​

OpenAPI Specification Updates​

OpenAPI specifications have been updated to reflect:

• Company, sole trader, party relationship, and party search endpoints
• Account signatory endpoints
• Vendor-agnostic KYX identity verification
• Business rules evaluation
• New and updated connectors

Ark Docs Updates​

Documentation updates in this release include:

• New and updated guides for Parties, KYX, and the new connectors
• Connector routing and Ark Flows documentation
• Refreshed API reference and migration guidance

Support & Resources​

For additional assistance with this release:

• Documentation Portal: https://ark-docs.digizoo.com.au
• Support Team: support@digizoo.com.au

For questions or feedback about this release, please contact your support representative.

This major release of Ark introduces Parties, enabling clients to use these APIs along with their own workflows to orchestrate onboarding experiences.

Additionally, this release also includes improvements to address validation handling, new admin endpoints for configuring and managing products and improvements to the overall behaviour and performance of Ark.

What's New​

New Features & Endpoints​

Parties​

Ark now provides Parties endpoints for clients to consume and use as part of orchestrating their onboarding experiences. The Parties endpoints have now replaced all Customer endpoints with a more flexible and feature-rich approach in order to facilitate with onboarding experiences.

Party Lifecycle Endpoints:

• GET /v1/parties/{partyId} - Retrieve party details and information
• PUT /v1/parties/{partyId} - Update party information and attributes
• DELETE /v1/parties/{partyId} - Remove a party from the system
• POST /v1/parties/provision - Provision party in the core banking system

KYX Verification Endpoints:

• POST /v1/parties/kyx - Initiate a new KYX verification process
• GET /v1/parties/kyx/{arkVerificationId} - Retrieve verification status and results
• GET /v1/parties/kyx/{arkVerificationId}/documents - List documents associated with a verification

Document Management Endpoints:

• POST /v1/parties/documents - Upload new documents for a party

Admin Products Endpoints:

• GET /v1/admin/products - Retrieve connector product configurations
• GET /v1/admin/clients/{slug}/products - View client-specific product mappings and settings

Changes & Improvements​

Existing customer endpoints have been replaced with the new Parties implementation.

• See the Migration Notes section below for more details
• Authentication mechanism remains unchanged for this release

Fixes​

Resolved Issues​

• Kleber Connector:

  • Address Response Handling: Fixed handling of empty, invalid, and unavailable address responses from Kleber
  • Improved error messages for address validation failures
  • Better handling of edge cases in address data quality

• Platform & UDA Card Workflows:

  • Account Product Mapping: Create card now returns 404 with Ark error code CAR004005 when account product mapping is missing for the requesting client/brand
  • Card Authorization Error Code: Reverted card authorization behavior to return CAR003003 when the customer does not have authority over the card

Security Updates​

Authentication & Authorization​

No authentication or authorization changes in this release.

Known Issues​

No critical issues are currently known in this release.

For the latest information on identified issues, workarounds, and resolution timelines, please refer to the Ark Support page or contact your support representative.

Migration or Upgrade Notes​

What's Changed:

New Parties API. Please use Parties endpoints for orchestrating onboarding flows.

Changes Include:

• New tables: Party tables
• Updated relationships: Links between parties and customers
• Migration from customer to party data model via pipeline scripts

Documentation Updates​

OpenAPI Specification Updates​

OpenAPI specifications have been updated to reflect:

• Parties endpoints with request/response schemas
• KYX verification endpoints and workflows
• KYX Document endpoints
• Admin product configuration endpoints

Ark Docs Updates​

Documentation updates in this release include:

• Customer documentation migration to Parties documentation in Ark Docs
• OpenAPI development guide updates
• Instance management documentation additions

Support & Resources​

For additional assistance with this release:

• Documentation Portal: https://ark-docs.digizoo.com.au
• Support Team: support@digizoo.com.au

For questions or feedback about this release, please contact your support representative.

This hotfix addresses ARKSUP-25 where v1/customer/register endpoint was failing with a 500 Server Internal Error when calling the address service Kleber when attempting to retrieve an address

Fixes​

fix(ark-connector-kleber): ARKSUP-25 support empty, undefined or invalid address response from kleber

Client-specific Information

Ark has updated the way it handles address retrieval when registering a customer where if an error occurs due to data supplied, it will return the following:

• 422 Unprocessable Entity (ADR022001) if a malformed result is returned
• 404 Not Found (ADR004001) if no results are returned for the address supplied
• 500 Server Internal Error (ADR100005) if the downstream connector has failed

Clients will now be able to call v1/customer/register endpoint and observe the above described behaviour.

Consumers using Ark should review the PAF values they are sending across to ensure they retrieve the correct address.

Please refer to https://ark-docs.digizoo.com.au for updated API documentation reflecting this change.

Support & Resources​

For additional assistance with this release:

• Documentation Portal: https://ark-docs.digizoo.com.au
• Support Team: support@digizoo.com.au

For questions or feedback about this release, please contact your support representative.

This major release of Ark includes the introduction of dynamic connector configuration, OAuth 2.0 authentication support through Microsoft Entra ID integration, and a new notification system for customer communications.

Additionally, platform includes administration APIs for managing client configurations and banking products, improved observability and health monitoring across all services, and infrastructure-as-code capabilities for Azure deployments.

What's New​

New Features & Endpoints​

Dynamic Connector Configuration Management​

Clients can now configure and manage how Ark routes requests to different backend connectors or target platforms (e.g. different core banking instances).

New Endpoints:

• Rule management endpoints (administrative access required)

• GET /v1/admin/bre-configuration/rules/:key - Retrieve a configuration rule by key

• PUT /v1/admin/bre-configuration/rules/:key - Update a configuration rule by key

• DELETE /v1/admin/bre-configuration/rules/:key - Delete a configuration rule by key

• GET /v1/admin/bre-configuration/rules - Retrieve all configuration rules

• Configuration management endpoints (administrative access required)

• GET /v1/admin/bre-configuration/:key - Retrieve a configuration by key

• PUT /v1/admin/bre-configuration/:key - Update a configuration by key

• DELETE /v1/admin/bre-configuration/:key - Delete a configuration by key

• GET /v1/admin/bre-configuration - Retrieve all configurations

OAuth 2.0 Authentication with Microsoft Entra ID​

Ark now offers OAuth 2.0 support for business-to-business (B2B) API integrations:

• Client Credentials Flow: Secure machine-to-machine authentication without user interaction
• Microsoft Entra ID Integration: Native support for enterprise identity management
• Health Check Endpoint: New /health/admin/auth/entra-id endpoint to verify authentication configuration

Migration Note: We've deprecated our built-in authentication system. It remains fully functional but clients will need to eventually migrate to the new OAuth-based authentication in future releases.

Customer Notification System​

Ark provides support for customer communications using our connector with Twilio:

• SMS/MMS Notifications: Integration with Twilio for sending text messages
• Notification Templates: Database-stored templates for consistent messaging
• Send and Cancel Operations: Ability to send notifications and cancel scheduled messages
• Client-Specific Configuration: Each client can maintain their own notification templates and settings

New Endpoints:

• POST /notifications - Send notification to a customer
• DELETE /notifications/{id} - Cancel a scheduled or pending notification

Banking Product Mapping​

Clients can now configure the mapping of products from core banking to Ark’s own internal IDs. Clients can then retrieve the mapped products via a customer-facing endpoint.

• Product Setup Endpoints: Administrative APIs to configure banking products available to customers
• Product Configuration: Set product-specific parameters and rules
• Public Product Catalog: Customer-facing endpoint to retrieve available banking products

New Endpoints:

• POST /admin/products - Create or update banking product configuration
• GET /banking/products - Retrieve available banking products for customers

Enhancements​

Health Monitoring​

Ark now supports better health check monitoring throughout its connectors and third-party services

Documentation​

• Docusaurus Documentation Site: Contains guides, API references, and integration examples
• Sequence Diagrams: Added visual documentation for all major API workflows
• Setup Instructions: Environment configuration and deployment
• Blog Platform: Release notes, announcements, and technical articles

Changes & Improvements​

Modified Behaviour​

Card Operations​

• Simplified Cancel Logic: Card cancellation process has been refactored for better maintainability and reliability
• Account Ownership Verification: Enhanced validation to ensure proper authorization before card operations

Fixes​

Resolved Issues​

Connector Fixes​

• GreenID Connector:
  • Corrected health check endpoint behavior for improved monitoring reliability
• Kleber Connector:
  • Improved integration reliability with external DataTools Cloud endpoints

Security Updates​

Authentication & Authorization​

• OAuth 2.0 Implementation: Industry-standard authentication protocol implementation
• Microsoft Entra ID Integration: Enterprise-grade identity management with support for multi-factor authentication, conditional access policies, and centralized user management
• Token-Based Security: Machine-to-machine authentication using client credentials eliminates the need to share user passwords

Known Issues​

No critical issues are currently known in this release.

For the latest information on identified issues, workarounds, and resolution timelines, please refer to the Ark Support page or contact your support representative.

Migration or Upgrade Notes​

Dynamic Connector Configuration Migration​

What Changed: Dynamic connector configuration has moved from static files bundled at build time to a database-driven approach.

Migration Steps:

1. Review Migration Scripts:

   • Migration scripts are located in azure-pipelines/migration-scripts/bre-upgrade/
   • Review these scripts thoroughly and test in a non-production environment first

2. Run Pre-Deployment Scripts:

   • Execute migration scripts in your environment before deploying version 1.0.0
   • Scripts will create and populate db tables with your existing configuration data from static files

3. Deploy Version 1.0.0:

   • After successful script execution, deploy the new version
   • The application will run database migrations seamlessly
   • Application will read connector configuration from the database

4. Verify Configuration:

   • Confirm that app behaviour is functioning as expected
   • Use the new administrative endpoints to review configurations

Important Notes:

• Migration scripts are idempotent and can be safely re-run
• Test the migration process in a development or staging environment first
• Ensure database backups are current before beginning migration
• No downtime is required if scripts are run before deployment
• The client is responsible for verifying migration scripts work correctly in their specific environment

Optional: OAuth 2.0 Authentication Migration​

Impact: Recommended migration from deprecated authentication to OAuth 2.0.

Timeline:

• Legacy authentication remains available in version 1.0.0
• Future removal date to be announced

Migration Steps:

1. Configure Microsoft Entra ID:

   • Follow the infrastructure setup guide in the documentation portal
   • Use the provided Terraform modules or manual setup scripts
   • Register Ark as an application in your Entra ID tenant

2. Configure Environment Variables:

   PASSPORT_AUTH_STRATEGY=entra-id
   AUTH_MICROSOFT_ENTRA_API_ID="your-entra-id-client-id"
   AUTH_MICROSOFT_ENTRA_TENANT_ID="your-entra-id-tenant-id"
   

3. Test Authentication:

   • Use the health check endpoint: GET /health/admin/auth/entra-id
   • Verify successful OAuth token acquisition using client credentials flow
   • Test API calls with OAuth bearer tokens

4. Update Client Applications:

   • Modify your integration code to use OAuth 2.0 client credentials flow
   • Refer to the Microsoft documentation for OAuth 2.0 implementation patterns
   • Update API keys to OAuth tokens in your API requests

Resources:

• Microsoft Entra ID OAuth 2.0 documentation: https://learn.microsoft.com/en-us/entra/identity-platform/v2-oauth2-client-creds-grant-flow
• Ark OAuth setup guide: Available in the documentation portal
• Infrastructure automation scripts: Located in infra/entra-id/

Database Schema Updates​

Several database schema changes have been introduced in this release. These changes are automatically applied through Prisma migrations when the application starts.

Changes Include:

• New tables: connector configuration, notification template tables
• Updated metadata fields: Consistent naming across all tables
• New foreign key constraints: Improved referential integrity
• New indexes: Performance optimization for log queries

Action Required: None - migrations run automatically. Ensure proper database backup procedures are in place before deployment.

Documentation Updates​

New Documentation​

Ark Documentation Portal​

Updates to the Ark Documentation Portal includes:

• API Reference: Complete endpoint documentation with examples
• Architecture Documentation: System design, component interactions, and decision records
• Integration Guides: How to integrate with Ark APIs and services
• Infrastructure Guides: Deployment and hosting instructions for Azure environments
• Blog: Release notes, announcements, and technical articles

Access: Available via https://ark-docs.digizoo.com.au

OpenAPI Specification Updates​

OpenAPI specifications have been updated to reflect:

• New endpoints for connector configuration, notifications, and product management
• OAuth 2.0 security schemes
• Updated request/response schemas
• API key documentation in Swagger UI

Infrastructure Documentation​

Infrastructure-as-code documentation including:

• Terraform module documentation for all Ark components
• Network architecture diagrams
• Security group and routing configurations
• Deployment runbooks for different Azure environments

Support & Resources​

For additional assistance with this release:

• Documentation Portal: https://ark-docs.digizoo.com.au
• Support Team: support@digizoo.com.au

For questions or feedback about this release, please contact your support representative.