Skip to main content

Changelog

The Trail API is intended to be updated over time with additional endpoints, features, and capabilities. This page will highlight all changes completed over time.

August 28th 2025​

This release introduces support for archived contacts and standardizes several data models for improved consistency.

Enhancements:

  • Archived Contact Support: A new boolean property IsArchived was added. This allows you to easily identify and filter contacts that have been archived.

  • State Property Added for Financial Products: A State property has been added to the Mortgage, KiwiSaver, and Investment data models to provide more detailed location information.

July 30th 2025​


🚀 Official Release of Trail API v1

We’re excited to announce the official release of the Trail API!

After several beta updates and iterations, the Trail API is now production-ready and available for use. This version includes all previously introduced features and improvements, along with final refinements:

Final Changes and Updates:

  • API is now marked as stable (v1).

  • Documentation links and schemas are finalized.

  • Response schemas are version-locked to ensure backwards compatibility.

  • Enhancements:

    • Exposed isArchived/isProfileArchived flag in API responses to support filtering and analysis.
    • Updated restrictions for archived profiles: Objects linked to archived profiles can no longer be updated, except for contacts if at least one related profile remains active.

Please review the API Documentation and update any integration scripts used during beta testing to reflect version-locked paths and structures.

July 8th 2025​

  1. Fixes

    • Fixed an issue when creating a Personal Contact related to validation logic for AddressHistory and EmploymentHistory.

  2. Enhancements

    • Added a Status property to the response payload of all GET opportunity endpoints.

      • GET /opportunities
      • GET /opportunities/search
      • GET /opportunities/:opportunityId

    • PATCH Profile Endpoint: Updates are now restricted. Only profiles that are not archived can be updated.

      • PATCH /profiles/:profileId

    • PATCH Opportunity Endpoint: Updates are now restricted to opportunities with Status = "Open" only.

      • PATCH /opportunities/:opportunityId

June 24th 2025​

NOTE: We have changed the name of the Accounts endpoint and updated the way Contact endpoints work. Please ensure you read the patch notes and update your API calls.

For our first ever update of the Trail API, we’re adding new endpoints and updating existing objects to provide more information to our users and help with their workflows. There are some fundamental changes below, so please understand them and ensure your API calls are updated accordingly.

  1. ACCOUNTS ENDPOINT NAME CHANGED

    • "Accounts" is now "Members"

  2. ADDED MEMBERS ENDPOINT TO GET BY ID

    • GET Member by ID allows the retrieval of specific member information.

      • New Endpoint: GET /members/:memberId

  3. ADDED SIX NEW CONTACT ENDPOINTS

    • In Trail there are three types of contacts that each have differing fields, we've updated the contact endpoint to reflect this:

      • Person:

        • POST /contacts/person
        • PATCH /contacts/:contactId/person

      • Trust:

        • POST /contacts/trust
        • PATCH /contacts/:contactId/trust

      • Company:

        • POST /contacts/company
        • PATCH /contacts/:contactId/company
    • This means your current Contact API calls must be updated to specify the contact type.

  4. UPDATED CONTACT RESPONSE STRUCTURE

    • The response structure of the Contact API has been updated and now differs based on the contact type:

      • Person
      • Trust
      • Company
    • Each contact type returns a type-specific structure, enabling better clarity and validation.

  5. ADDED “GET” ENDPOINT THAT LISTS ALL OBJECTS

    • We’ve added a new endpoint to key objects that allows users to list all information without having to provide a unique identifier.

      • List Contacts: GET /contacts
      • List Opportunities: GET /opportunities
      • List Members: GET /members
      • List Profiles: GET /profiles

  6. NEW FIELDS TO EXISTING MORTGAGE PRODUCT OBJECT

    • In order to provide you with more mortgage data, we’ve added two new fields to the mortgage object:

      • Repayment Amount: repayment
      • Repayment Frequency: frequency

  7. NEW TIMESTAMP FIELDS TO EXISTING OBJECTS

    • To help identify key moments in an object's lifetime, we’ve added two timestamp fields to all objects except Pipeline:

      • createdTimestamp: The date and time the object was created
      • modifiedTimestamp: The date and time the object was last modified
    • The format will be ISO 8601 in NZT.
    • Note: Not all objects will have a “Created Timestamp”, as auditing was only introduced to Trail after October 2023. The default value will show NULL if created before this date.

June 9th 2025​

Trail API BETA is released for the first time 🎉