Accounts API Contracts

Table of Contents


Access API

Module DA.ASX.API.Account.AccountCancellation_V001

Templates

template AccountCancellation

FieldTypeDescription
operatorPartyThe operator
controllingParticipantPartyOptional PartyThe controlling party of the account (ASX: Controlling participant)
accountIdKAccount Identifier (HIN) from the request (ASX: Account Id)
cancellationRequesterActorIdTextActor Id of the person requesting the cancellation (ASX: Cancellation Requester Actor
transactionIdTextTransaction Id from the Account Cancellation request message (ASX: Transaction Id)
  • Choice Archive

Data Types

type C= ContractId T

type K= Text

type T= AccountCancellation

Module DA.ASX.API.Account.AccountHolderStatusReason_V001

Data Types

data AccountHolderStatusReason

Housekeeping

(ASX: HOUS)

NotifiedAsDeceased

(ASX: NODE)

NotifiedAsBankrupt

(ASX: BKRL)

NonSpecific

(ASX: NOSC)

SubjectToCourtOrder

(ASX: SNCO)

ActionByAsxOperations

(ASX: ASXO)

GrantOfProbateOrLettersOfAdministration

(ASX: GPLA)

SmallEstateStatement

(ASX: SEST)

TransferIndemnityBond

(ASX: TIBD)

NoHoldings

(ASX: NHDL)

LegalTrusteeRequest

(ASX: LTRQ)

Annulment

(ASX: ANNT)

Error

(ASX: ERRO)

RegistrationIdentifierDeleted

(ASX: RGDL)

NoReason

(ASX: NORE)

Active

(ASX: ACTV)

AccountCancellation

(ASX: CNCL)

Module DA.ASX.API.Account.AccountHolderStatus_V001

Data Types

data AccountHolderStatus

Active

(ASX: ACTV)

Locked

(ASX: LOCK)

type T= AccountHolderStatus

Module DA.ASX.API.Account.AccountOwnershipType_V001

Data Types

data AccountOwnershipType

Type of account's ownership

Single

(ASX: SIGL)

Joint

(ASX: JOIT)

type T= AccountOwnershipType

Module DA.ASX.API.Account.AccountType_V001

Data Types

data AccountType

Account type in the system

Sponsored

(ASX: SPSD)

Direct

(ASX: DRCT)

SettlementEntrepot

(ASX: SETT)

AccumulationEntrepot

(ASX: ACCU)

RegistrationIdentifier

(ASX: RGID)

type T= AccountType

Module DA.ASX.API.Account.Account_V001

Templates

template AccountAdditionalView

FieldTypeDescription
operatorPartyThe operator
observingPartyOptional PartyThe observing party
accountIdAccountIdThe platform-generated unique ID of the account (ASX: Account Identifier)
emailAddressOptional TextEmail address for account-related communication (ASX: Email Address)
mobileNumberOptional TextMobile number for account-related communication (ASX: Mobile Number)
residencyIndicatorResidencyIndicator_V001.ResidencyIndicatorThe residency of the account holder (ASX: Residency Indicator)
communicationPreferenceOptional CommunicationPreference_V001.CommunicationPreferenceThe communication preference of the registered holder of the account (ASX: Communication Preference)
accountStatusReasonOptional AccountHolderStatusReason_V001.AccountHolderStatusReasonReason for the account status (ASX: Account Status Reason)
  • Choice Archive

template AccountFullView

FieldTypeDescription
operatorPartyThe operator
observingPartyOptional PartyThe observing party
accountIdAccountIdThe platform-generated unique ID of the account (ASX: Account Identifier)
lockingActorIdOptional Actor.Actor_V001.KIdentifier of the actor who requested the lock, if applicable
validToDateOptional DateIf the status is locked, the date the lock is due to be released (ASX: Valid To Date)
creationDateTimeTimeCreation date & time (ASX: Creation Date Time)
lockDateOptional DateThe Lock date is a business date the lock is applied to the account (ASX: Lock Date)
paymentFacilities[PaymentFacilities.PaymentFacilityRelationship_V001.PaymentFacilityRelationship]Payment Facilities associated with the account (Account Specific) (ASX: Payment Facility ID)
  • Choice Archive

template AccountStandardView

FieldTypeDescription
operatorPartyThe operator
observingPartyOptional PartyThe observing party
accountIdAccountIdThe platform-generated unique ID of the account (ASX: Account Identifier)
holderIds[Text]The unique ID(s) of the holders associated with the account (ASX: Holder Identifiers)
controllingParticipantActorIdActor.Actor_V001.KThe identifier of the controlling Participant of the account (ASX: Controlling Participant)
accountTypeAccountType_V001.AccountTypeThe type of account (Sponsored, Direct, AccumulationEntrepot, SettlementEntrepot, or RegistrationIdentifier) (ASX: Account Type)
accountNameTextName of the registered holder of the account (ASX: Account name)
ownershipTypeAccountOwnershipType_V001.AccountOwnershipTypeAccount ownership type (Single or Joint) (ASX: Ownership Type)
designationOptional TextAdditional account information over and above the name of the registered holder (ASX: Designation)
mailingAddresseeLineTextThe addressee line to be used for account statements (ASX: Mailing Addressee Line)
addressLines[Text]Address of the registered holder of the account (ASX: Registered Address)
townNameTextName of the town or city (ASX: Town Name)
countrySubdivisionOptional TextSubdivision within the country (e.g. State, Region), if applicable (ASX: Country Sub-Division)
postCodeOptional TextPost code (ASX: Post Code)
countryCodeTextTwo digit code for the country (ASX: Country Code)
accountStatusAccountHolderStatus_V001.AccountHolderStatusThe current status of the account (ASX: Account Status)
  • Choice Archive

Data Types

type AccountId= Text

type K= AccountId

Module DA.ASX.API.Account.AddressType_V001

Data Types

data AddressType

Registered

Registered address

Residential

Residential address

type T= AddressType

Module DA.ASX.API.Account.ChangeOfControllingParticipantStatus_V001

Data Types

data Status

Request Status

Pending

(ASX: Pending)

Scheduled

(ASX: Scheduled)

type T= Status

Module DA.ASX.API.Account.ChangeOfControllingParticipant_V001

Templates

template ChangeOfControllingParticipant

FieldTypeDescription
operatorPartyThe operator
receivingPartyOptional PartyParty that will be the new controller of the account (ASX: New Controlling Participant)
deliveringPartyOptional PartyParty that is the current controller of the account (ASX: Controlling Participant)
controllingActorIdActor.Actor_V001.KThe Actor id of the Controlling Participant of the Account Identifier (ASX: Controling Participant Actor Id)
requestingActorIdActor.Actor_V001.KThe Actor id of the New Controlling Participant of the Account Identifier (ASX: Requesting Participant Actor Id)
accountIdKIdentifier of the account to be transferred (ASX: Account Identifier)
statusChangeOfControllingParticipantStatus_V001.StatusCurrent status of the request (Pending, Authorised) (ASX: Request Status)
  • Choice Archive

Data Types

type C= ContractId T

type K= Account_V001.K

type T= ChangeOfControllingParticipant

Module DA.ASX.API.Account.CommunicationPreference_V001

Data Types

data CommunicationPreference

ElectronicASXOnly

ElectronicIssuerOnly

ElectronicASXIssuer

Post

type T= CommunicationPreference

Module DA.ASX.API.Account.HolderType_V001

Data Types

data HolderType

Individual

(ASX: Individual)

Company

(ASX: COMP)

Trust

(ASX: TRST)

Partnership

(ASX: PRTN)

SuperannuationFund

(ASX: SPFD)

DeceasedIndividual

(ASX: DECD)

GovernmentOrganisation

(ASX: GOVN)

OtherNonIndividual

(ASX: OTHR)

Unknown

(ASX: UNKN)

type T= HolderType

Module DA.ASX.API.Account.Holder_V001

Templates

template HolderFullView

FieldTypeDescription
operatorPartyThe operator
observingPartyOptional PartyThe observing party
holderIdKThe platform-generated unique identifier of the holder (ASX: Holder Id)
addressTypeOptional AddressType_V001.AddressTypeType of address (ASX: Address Type)
addressLinesOptional [Text]Address of the holder (ASX: Holder Address)
townNameOptional TextName of the town or city (ASX: Town Name)
countrySubdivisionOptional TextSubdivision within the country (e.g. State, Region), if applicable (ASX: Country Sub-Division)
postCodeOptional TextPost code (ASX: Post Code)
countryCodeOptional TextTwo digit code for the country (ASX: Country Code)
emailAddressOptional TextEmail address of the holder (ASX: Email Address)
mobileNumberOptional TextMobile number of the holder (ASX: Mobile Number)
dateOfBirthOptional DateDate of birth for an individual holder (ASX: Date of Birth)
dateOfDeathOptional DateDate of death for an individual holder (ASX: Date of Death)
companyIncorporationDateOptional DateIncorporation date for an organisation holder (ASX: Company Incorporation Date)
dateOfBankruptcyOptional DateDate of bankruptcy for an organisation holder (ASX: Date of Bankruptcy)
legalEntityIdentifierOptional TextLegal entity identifier for an organisation holder (ASX: Legal Entity Identifier)
lockRequesterActorIdOptional Actor.Actor_V001.KIdentifier of the actor who requested the lock or unlock, if applicable (ASX: Lock/Unlock Requester Actor Id)
  • Choice Archive

template HolderStandardView

FieldTypeDescription
operatorPartyThe operator
observingPartyOptional PartyThe observing party
holderIdKThe platform-generated unique identifier of the holder (ASX: Holder Id)
holderTypeHolderType_V001.HolderTypeType of holder (ASX: Holder Type)
holderNameTextLegal name of the holder (ASX: Holder Name)
holderStatusAccountHolderStatus_V001.AccountHolderStatusCurrent status of the holder (ASX: Holder Status)
holderStatusReasonOptional AccountHolderStatusReason_V001.AccountHolderStatusReasonIf the holder status is locked, the reason for the lock (ASX: Holder Status Reason)
  • Choice Archive

Data Types

type K= Text

Module DA.ASX.API.Account.ResidencyIndicator_V001

Data Types

data ResidencyIndicator

Domestic

Mixed

Foreign

Unknown

type T= ResidencyIndicator




Related Pages:

There are no related labels.

Browse Popular Pages:

No labels match these criteria.



This document provides general information only. ASX Limited (ABN 98 008 624 691) and its related bodies corporate (“ASX”) makes no representation or warranty with respect to the accuracy, reliability or completeness of the information. To the extent permitted by law, ASX and its employees, officers and contractors shall not be liable for any loss or damage arising in any way (including by way of negligence) from or in connection with any information provided or omitted or from anyone acting or refraining to act in reliance on this information.

© 2022 ASX Limited ABN 98 008 624 691


The following macros are not currently supported in the footer:
  • style