The Self-Service Bulk Account Creation Tool is provided to the 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 Account Creation Request (acct_001) message in the CSV file, developers are able to perform different account creation test scenarios in bulk.
This service allows developers to submit a fixed CSV file containing the account creation information using a cURL command to a REST endpoint. The templates in the CSV file allow more than one record to be provided.
The REST endpoint translates the CSV file to a ISO XML message (Account Creation Request (acct_001)) which is then submitted to the CSP.
The maximum CSV file size is 50 kB andber of records accepted by the Self-Service Tool input via a CSV file is 50 records. The CSV file will be rejected if both or either of parameters are exceeded.
The Self-Service Tool will parse the entire CSV file and ensure a summary of error/s is available to the CHESS . If a single record is invalid due to errors in the file format, business validity or schema validity, the entire CSV file will be rejected.
The Self-Service Tool will be provided to the Issuer (Registries) to act as a Participant to perform the following initiated requests:
- Create Sponsored, Direct, Settlement Entrepot, Accumulation and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Company”;
- Create Sponsored and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Individual”; and
- Create Sponsored Accounts of Ownership Type “Joint” and Holder Type “Company” or ”Individual”
The sponsoring participant used is ‘20000’. To obtain the HIN or RGID response a developer must retrieve the Account Notification (acct_002) on that UIC to obtain the HIN or RGID.
The Self-Service Tool will allow the Issuer (Registries) to act as a Participant to facilitate and manage their own internal test use cases acting on behalf of a Participant. This can be achieved by the following:
Upload 'CSV' file/s to create Sponsored, Direct, Settlement Entrepot, Accumulation and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Company”;
Upload 'CSV' file/s to create Sponsored and Registration Identifier Accounts of Ownership Type “Single” and Holder Type “Individual”; and
- Upload 'CSV' file/s to create Sponsored Accounts of Ownership Type “Joint” and Holder Type “Company” or ”Individual”.
On success, an Account Notification (account_002) will be sent by the CSP to the Participant for which the account was created for.
CDE10 introduces an enhancement to the Self-Service Tool for Bulk Account Creation. For each Account successfully created via the Bulk Account Creation Self-Service Tool, the corresponding Account Type, Account Identifier and Holder Id is returned in the response.
If the CSV submitted by the Issuer (Registry) is invalid due to errors in the business validity, an Invalid Transaction (comm_808) is received.
If the CSV submitted by the Issuer (Registry) 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 Account Creation Overview and Account and Holder Creation Functional Specification.
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:
Prior to establishing connection to the CDE, the Issuer (Registries) 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 (Registries) also the CSV sample file above.
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 Bulk Account Creation:
// Verbose output
// ASX’s CA’s public keys in pem format
// File containing the certificate of the client machine
// Private key of the client certificate provided in cert option
// The URL of Issuer (Registries) self-service bulk account creation
// For single bulk account creation, the message name following /xmlIngest/ will be acct001Single.
// For joint bulk account creation, the message name following /xmlIngest/ will be acct001Joint.
// 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
In the above code fragment:
- URL: The URL for Self-Service Bulk Account Creation is the same as the Trade Ingest API, cde-trade-ingest.asx.com.au. The local host DNS needs to be reconfigured to 184.108.40.206 to ensure correct routing.
- Port: The port number exposed for the Self-Service tool. The port will take the format of 5XXX and will be provided to the Issuer (Registries) via email.