Skip to main content

API releases — 2025

All API releases · How to read this history

21 February 2025 — Contact group enquiry source details​

  • Contact groups expose enquiry-source category, source and referrer identifiers, plus referrer and referrer-organisation names.
  • Adds an enquiry-source system URL. These new response fields are read-only; names allow 200 characters and the URL allows 400.

330 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 1 updated

Updated schemas and changed locations

  • ContactGroupAttributes: /properties/enquirySourceCategoryId, /properties/enquirySourceId, /properties/enquirySourceReferrerId, /properties/enquirySourceReferrerName, /properties/enquirySourceReferrerOrganisationName, /properties/enquirySourceSystemUrl

13 February 2025 — Marital status and liability sub-types​

  • Contact, lead and lead-contact attributes gain maritalStatus; income attributes gain read-only incomeVerification.
  • Liabilities gain sub-type details and structured lead liabilities gain liabilitySubTypeId.
  • Adds four GET and HEAD operations for liability sub-types related to a liability type.

330 operations after this release · 4 added · 0 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Added

  • GET /jsonapi/liability-types/{id}/liabilitySubTypes
  • GET /jsonapi/liability-types/{id}/relationships/liabilitySubTypes
  • HEAD /jsonapi/liability-types/{id}/liabilitySubTypes
  • HEAD /jsonapi/liability-types/{id}/relationships/liabilitySubTypes
Schema details — 7 added, 0 removed, 8 updated

Added schemas

  • LiabilitySubType
  • LiabilitySubTypeAttributes
  • LiabilitySubTypeDocument
  • LiabilitySubTypeRelationships
  • LiabilitySubTypesDocument
  • LiabilitySubTypesEntityType
  • MaritalStatus

Updated schemas and changed locations

  • ContactAttributes: /properties/maritalStatus
  • IncludedResource: /discriminator/mapping/liability-sub-types
  • IncomeAttributes: /properties/incomeVerification
  • LeadAttributes: /properties/maritalStatus
  • LeadContact: /properties/maritalStatus
  • LeadLiability: /properties/liabilitySubTypeId
  • LiabilityAttributes: /properties/liabilitySubType, /properties/liabilitySubTypeId
  • LiabilityTypeRelationships: /properties/liabilitySubTypes

5 February 2025 — Address field length limits​

  • Address responses specify a maximum of 500 characters for country, formatted address, postcode, street address and suburb, and 100 for state.

Compatibility: Check local storage lengths and generated model validation against these limits.

326 operations after this release · 0 added · 0 removed · 0 updated. Schema changes are counted separately below.

Schema details — 0 added, 0 removed, 1 updated

Updated schemas and changed locations

  • Address: /properties/country, /properties/formattedAddress, /properties/postCode, /properties/state, /properties/streetAddress, /properties/suburb

20 January 2025 — Deal securities and client review month​

  • Adds 20 GET and HEAD operations covering deal securities, their related resources and relationship data, and the securities attached to a deal.
  • Contact groups gain the nullable reviewMonth field for client review planning.

326 operations after this release · 20 added · 0 removed · 0 updated. Schema changes are counted separately below.

Endpoint details

Added

  • GET /jsonapi/deal-securities
  • GET /jsonapi/deal-securities/{id}
  • GET /jsonapi/deal-securities/{id}/asset
  • GET /jsonapi/deal-securities/{id}/ownership
  • GET /jsonapi/deal-securities/{id}/relationships/asset
  • GET /jsonapi/deal-securities/{id}/relationships/ownership
  • GET /jsonapi/deal-securities/{id}/relationships/titleIdentifications
  • GET /jsonapi/deal-securities/{id}/titleIdentifications
  • GET /jsonapi/deals/{id}/loanSecurities
  • GET /jsonapi/deals/{id}/relationships/loanSecurities
  • HEAD /jsonapi/deal-securities
  • HEAD /jsonapi/deal-securities/{id}
  • HEAD /jsonapi/deal-securities/{id}/asset
  • HEAD /jsonapi/deal-securities/{id}/ownership
  • HEAD /jsonapi/deal-securities/{id}/relationships/asset
  • HEAD /jsonapi/deal-securities/{id}/relationships/ownership
  • HEAD /jsonapi/deal-securities/{id}/relationships/titleIdentifications
  • HEAD /jsonapi/deal-securities/{id}/titleIdentifications
  • HEAD /jsonapi/deals/{id}/loanSecurities
  • HEAD /jsonapi/deals/{id}/relationships/loanSecurities
Schema details — 20 added, 0 removed, 3 updated

Added schemas

  • ApiLoanSecurity
  • ContactAccessType
  • DealSecuritiesDocument
  • DealSecuritiesEntityType
  • DealSecurity
  • DealSecurityAttributes
  • DealSecurityDocument
  • DealSecurityOwnership
  • DealSecurityOwnershipAttributes
  • DealSecurityOwnershipDocument
  • DealSecurityOwnershipEntityType
  • DealSecurityOwnershipRelationships
  • DealSecurityOwnershipsDocument
  • DealSecurityRelationships
  • DealSecurityTitleIdentitiesDocument
  • DealSecurityTitleIdentity
  • DealSecurityTitleIdentityAttributes
  • DealSecurityTitleIdentityDocument
  • DealSecurityTitleIdentityEntityType
  • DealSecurityTitleIdentityRelationships

Updated schemas and changed locations

  • ContactGroupAttributes: /properties/reviewMonth
  • DealRelationships: /properties/loanSecurities
  • IncludedResource: /discriminator/mapping/deal-securities, /discriminator/mapping/deal-security-ownership, /discriminator/mapping/deal-security-title-identity