Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Page Properties
hiddentrue


StatusApproverReviewerLast Review DateTarget Release

Status
titleDraft



Info
titleTable of Contents

Table of Contents



Overview

The Self-Service Investor Data and Foreign Tax Status Advice Tool is provided to the Issuer (Registries) to act as a Participant via upload of a configurable CSV file, which will be consumed and validated by the CSP.

By updating the field details of an Investor Data and Foreign Tax Status Details (acct_012) message in the CSV file, developers are able to perform different account management test scenarios.

This service allows developers to submit a fixed CSV file containing the account management information using a cURL command to a REST endpoint.

The REST endpoint translates the CSV file to a ISO XML message (Investor Data and Foreign Tax Status Details (acct_012)) which is then submitted to the CSP.

The Self-Service Tool will be provided to the Issuer (Registries) to act as a Participant to receive an Investor Data and Foreign Tax Status Advice (acct_012) for a TFN that was added.

On success the related Issuer (Registry) will receive an Investor Data and Foreign Tax Status Advice (acct_012) for a TFN that was added.

If the CSV submitted by the Issuer (Registry) acting as a Participant is invalid due to errors in the business validity, an Invalid Transaction (comm_808) is received.

If the CSV submitted by the Issuer (Registry) acting as a Participant is invalid due to errors in the file format or schema validity, a rejection from the Self-Service Tool is received. 

These responses are delivered to the REST endpoint, where it is converted to a JSON response. 

The sample below is provided as a reference; additional information on the column names and elements present in the CSV can be found on the Investor Data functional specification.

Sample Template

The file below contains a Excel file template which is used to build the CSV submitting to the cURL. 

When populating the CSV, the developer is required to ensure:

  • The message includes the appropriate fields as populated in the attached template; and
  • Supplied dates are valid business dates.
Expand
titleDownload Sample Data


Note

CSV files submitted to the CSP must be encoded in UTF-8 not UTF-8-BOM. For further details refer here.

Self-Service Investor Data and Foreign Tax Status Advice.zip

Connection details

Prior to establishing connection to the ITE1, the Issuer (Registry) acting as a Participant will need to generate and submit a Certificate Signing Request and acquire the ASX root / issuing CA public key (instructions are available on the FTP). The Issuer (Registry) acting as a Participant is also required to populate the CSV sample file above.

Note

CSV files submitted to the CSP must be encoded in UTF-8 not UTF-8-BOM. For further details refer here.

The below code snippet demonstrates how to establish connection to the Self-Service Tool:


Code Block
languagejava
titleSelf Service Tool
curl
    // Verbose output
    -v
                 
    // Informs recipients that the client is about to send a message body in this request and wishes to receive a 100 (continue) interim response
    -H "Expect: 100-continue"

    // ASX’s CA’s public keys in pem format
    --cacert /c/path/to/file.pem
                
    // File containing the certificate of the client machine
    --cert /c/path/to/file.cer
     
    // Private key of the client certificate provided in cert option
    --key /c/path/to/file.key
             
    // The URL of the Self-Service Tool
    "https://ite1-test-tool.asx.com.au:5000/xmlIngest/acct012" 
                 
    // Header option to accept json format (not the same as the CSV file)
    -H "accept: application/json"
                 
    // Header option to tell curl command that it will be form-data in other words file as input
    -H "Content-Type: multipart/form-data"
                 
    // The input CSV file to be sent as part of the request
    -F "file=@/c/path/to/file.csv"

In the above code fragment:  

  • URL: The URL for the Self-Service Tool is ite1-test-tool.asx.com.au. The local host DNS needs to be reconfigured to 203.4.179.146 to ensure correct routing.  
  • Port: The port number exposed for the Self-Service Tool.




Insert excerpt
Macro 1
Macro 1
nopaneltrue

Insert excerpt
Macro 2
Macro 2
nopaneltrue

Insert excerpt
Disclaimer
Disclaimer
nopaneltrue