CreateSubmissionRequest

Submit an account opening request to Openmarkets

accountType
Type: string enum
required

The type of account to be created
values
- Individual
- Joint
- Company
- IndividualSuperannuation
- CompanySuperannuation
- IndividualTrust
- CompanyTrust
adviserCode
Type: string
required

The Adviser Code provided by Openmarkets to identify the adviser this account gets assigned to
branchId
Type: string
required

The Branch Id provided by Openmarkets
brokerageCode
Type: string
required

The Brokerage Code provided by Openmarkets to set the default brokerage schedule for this account
data
Type: object · SubmissionData
required

Application Form Data
- chessDetails
  Type: object · ChessDetails
  required
  
  Details related to the CHESS registration for this account
- equitiesAccount
  Type: object · EquitiesAccountAction
  required
  
  Details about the EquitiesAccount that should be linked to this submission
- individuals
  Type: array object[] · Individual[]
  required
  
  List of any Individuals involved in this application
  
  Individual involved in this application
- acceptances
  Type: array object[] | null · Acceptance[]
  
  List of acceptances for any terms and conditions etc. against the application
  
  Record of acceptance for any terms and conditions etc. against the application
- bankAccounts
  Type: array object[] | null · BankAccount[]
  
  List of BankAccounts and how they relate to the Application. If setting up an equitiesAccount, then at least one bank account with purposes of ‘EquitySettlement’ should be provided. Additionally either dividend distribution can go to the same account (by adding ‘EquityDividends’) or to a separate account by providing a new account with purposes of ‘EquityDividends’
  
  An individual bank account
- clientType
  Type: string | null enum
  
  Indicator of non-retail account types
  
  values
  Retail
  OneOffSale
- companiesAsOwner
  Type: array object[] | null · CompanyAsOwner[]
  
  List of companies that own this application
- company
  Type: object · Company
  
  Details about the Company (for accountType of Company, CompanySuperannuation, CompanyTrust)
- designation
  Type: string | null
  
  Designation for the account, used for the CHESS registration. Prohibited keywords: "account, a/c, atf, trust, trustee, trustees, testamentary, act, acfo, test", whether in uppercase or lowercase. 'A/C' is automatically added. If left blank, the Trust name is used. Designation is required if Trust contains any prohibited keyword or if any of the individuals has a Minor role.
- expectedDocuments
  Type: integer Format: int32
  
  How many documents are expected to be uploaded against this submission
- hinDetails
  Type: object · HinDetails
  
  HIN details. Either create a new HIN, or provide details about transferring existing HIN, partial securities or SRN details
- isClientSignedSponsorshipAgreement
  Type: boolean
  
  Is the Sponsorship Agreement signed by the client?
- notes
  Type: array object[] | null · Note[]
  
  Optional notes attached to the application
  
  Optional notes attached to the application
- settlement
  Type: object | null · Settlement
  
  Represents a settlement configuration.
- tradeConfirmations
  Type: array object[] | null · TradeConfirmation[]
  
  List of Contact details for sending Contract Note confirmations. If left blank, any email addresses provided for individuals will be used for Contract Notes. If provided, this list will be used for Contract Notes, in place of the individual’s emails
  
  Contact details for sending Contract Note confirmations. If left blank, any email addresses provided for individuals will be used for Contract Notes. If provided, this list will be used for Contract Notes, in place of the individual’s emails
- trust
  Type: object · Trust
  
  Details about the Trust (for accountType of IndividualTrust, CompanyTrust) or Super fund (for accountType of IndividualSuperannuation, CompanySuperannuation)
organisationCode
Type: string
required

The Organisation Code provided by Openmarkets to identify the client this account belongs to
referenceId
Type: string | null

An optional external ReferenceId to link this submission to your system

Examples

{
  "referenceId": "CRM-4821",
  "organisationCode": "TPUAT",
  "adviserCode": "UAT",
  "brokerageCode": "NIL",
  "branchId": "UA",
  "accountType": "Individual",
  "data": {
    "individuals": [
      {
        "externalId": "CRM-4821",
        "individualType": "Applicant",
        "givenName": "James",
        "middleName": "Alan",
        "lastName": "Smith",
        "title": "Mr",
        "dateOfBirth": "1985-03-28",
        "email": "james.smith@example.com",
        "isMainContact": true,
        "mobileNumber": "0400000000",
        "homeNumber": "(03) 9000 0000",
        "workNumber": "(03) 9000 0001",
        "countryOfCitizenship": "AUS",
        "countryOfBirth": "AUS",
        "townOfBirth": "Melbourne",
        "isPep": false,
        "occupation": "Software engineer",
        "relations": [
          {
            "relatesTo": "Account",
            "role": "Owner"
          }
        ],
        "sourceOfWealth": "Employment",
        "addresses": [
          {
            "addressType": "Street",
            "propertyName": null,
            "unit": "12a",
            "streetNumber": "350",
            "streetName": "Collins",
            "streetType": "St",
            "suburb": "Melbourne",
            "postcode": "3000",
            "state": "VIC",
            "countryCode": "AUS"
          }
        ],
        "tax": {
          "australian": {
            "tfn": "865414088"
          }
        },
        "gender": "Male"
      }
    ],
    "hinDetails": {
      "action": "Create"
    },
    "chessDetails": {
      "emails": [
        {
          "email": "james.smith@example.com"
        }
      ],
      "electronicStatements": "AsxOnly",
      "address": {
        "addressType": "Postal",
        "propertyName": null,
        "unit": "12a",
        "streetNumber": "350",
        "streetName": "Collins",
        "streetType": "St",
        "suburb": "Melbourne",
        "postcode": "3000",
        "state": "VIC",
        "countryCode": "AUS"
      }
    },
    "bankAccounts": [
      {
        "action": "Link",
        "bankAccountType": "BankAccount",
        "provider": null,
        "name": "James Alan Smith",
        "bsb": "063000",
        "accountNumber": "12345678",
        "purposes": [
          "EquitySettlement",
          "EquityDividends"
        ]
      }
    ],
    "isClientSignedSponsorshipAgreement": true,
    "notes": [
      {
        "text": "Client is migrating from an existing broker."
      }
    ],
    "expectedDocuments": 2,
    "equitiesAccount": {
      "action": "Create"
    },
    "acceptances": [
      {
        "acceptanceId": "PrivacyFormVendor",
        "result": "Accepted"
      }
    ],
    "tradeConfirmations": [
      {
        "email": "james.smith@example.com",
        "attention": "Dear James",
        "isClientAddress": true
      }
    ],
    "clientType": "Retail"
  }
}