SharesAccountPaginatedResponse

  • metadata
    Type: object · PaginationMetaData
    • limit
      Type: integer Format: int32

      Signed 32-bit integers (commonly used integer type).

    • links
      Type: object · Links
    • offset
      Type: integer Format: int32

      Signed 32-bit integers (commonly used integer type).

    • total
      Type: integer Format: int32

      Signed 32-bit integers (commonly used integer type).

  • results
    Type: array object[] | null · SharesAccount[]
    • accountDesignation
      Type: string | null
    • accountName
      Type: string | null
    • accountNumber
      Type: string | null
    • accountType
      Type: string · AccountTypeenum
      values
      • Unknown
      • Individual
      • Joint
      • Company
      • SoleTrader
    • addressLine1
      Type: string | null
    • addressLine2
      Type: string | null
    • addressLine3
      Type: string | null
    • advisorCode
      Type: string | null
    • advisorName
      Type: string | null
    • bankAccountName
      Type: string | null
    • bankAccountNumber
      Type: string | null
    • bankInstitutionCode
      Type: string | null
    • bankTransactionTypes
      Type: string | null
    • branchCode
      Type: string | null
    • bsb
      Type: string | null
    • chessRegistration
      Type: object · ChessRegistration
    • clientType
      Type: string · ClientTypeenum
      values
      • Normal
      • MarginLendingAnz
      • MarginLendingAustExecutor
      • MarginLendingCba
      • MarginLendingCitiCorpNoms
    • contractNoteEmailAddress
      Type: array string[] | null
    • countryCode
      Type: string | null
    • crossReference
      Type: string | null
    • dateCreated
      Type: string | null Format: date-time

      the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

    • emailAddress
      Type: string | null
    • equitiesBrokerageSchedule
      Type: string | null
    • exemptionCertificateExpiry
      Type: string | null Format: date

      full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

    • exemptionType
      Type: string · ExemptionTypeenum
      values
      • None
      • SophisticatedInvestor
      • ProfessionalInvestor
    • externalRef1
      Type: string | null
    • externalRef2
      Type: string | null
    • homePhone
      Type: string | null
    • individuals
      Type: array object[] | null · SharesAccountHolders[]
    • internationalTrading
      Type: boolean
    • mobilePhone
      Type: string | null
    • optionsBrokerageSchedule
      Type: string | null
    • optionsTrading
      Type: boolean
    • orderClass
      Type: string | null
    • organisationCode
      Type: string | null
    • pid
      Type: string | null
    • portfolioFrequency
      Type: string | null
    • postcode
      Type: string | null
    • primaryClient
      Type: string | null
    • status
      Type: string · Statusenum
      values
      • Active
      • Suspended
      • InActive
    • warrantsTrading
      Type: boolean
    • workPhone
      Type: string | null
Examples
{
  "metadata": {
    "links": {
      "self": "https://api.openmarkets.com.au/v1/accounts/?limit=10&offset=0",
      "next": "https://api.openmarkets.com.au/v1/accounts/?limit=10&offset=10",
      "previous": null
    },
    "limit": 10,
    "offset": 0,
    "total": 34
  },
  "results": [
    {
      "accountNumber": "111888",
      "accountName": "Ms Jane Marie Citizen",
      "organisationCode": "TPOMAL",
      "branchCode": "01",
      "advisorCode": "ADV1",
      "advisorName": "John Doe",
      "dateCreated": "2025-02-19T04:12:07Z",
      "status": "Active",
      "orderClass": "Standard",
      "chessRegistration": {
        "hin": "X0001234567",
        "name1": "MS JANE MARIE CITIZEN",
        "name2": null,
        "name3": null,
        "designation": null,
        "addressLine1": "LEVEL 8",
        "addressLine2": "350 COLLINS STREET",
        "addressLine3": "MELBOURNE VIC",
        "addressLine4": null,
        "postcode": "3000",
        "countryCode": "AU"
      },
      "pid": "20087",
      "crossReference": "CRM-4821",
      "accountType": "Individual",
      "clientType": "Normal",
      "portfolioFrequency": "Daily",
      "warrantsTrading": false,
      "exemptionType": "None",
      "exemptionCertificateExpiry": null,
      "optionsTrading": false,
      "internationalTrading": false,
      "equitiesBrokerageSchedule": "STD-EQ",
      "optionsBrokerageSchedule": null,
      "bankInstitutionCode": "CBA",
      "bsb": "063000",
      "bankAccountNumber": "12345678",
      "bankAccountName": "Jane Marie Citizen",
      "bankTransactionTypes": "Settlement",
      "accountDesignation": null,
      "emailAddress": "jane.citizen@example.com",
      "contractNoteEmailAddress": [
        "jane.citizen@example.com"
      ],
      "workPhone": "+61 3 9000 0000",
      "mobilePhone": "+61 400 000 000",
      "homePhone": null,
      "addressLine1": "Level 8, 350 Collins Street",
      "addressLine2": "Melbourne VIC",
      "addressLine3": null,
      "postcode": "3000",
      "countryCode": "AU",
      "externalRef1": "CRM-4821",
      "externalRef2": null,
      "primaryClient": "CL0009912",
      "individuals": [
        {
          "givenName": "Jane",
          "middleName": "Marie",
          "lastName": "Citizen",
          "title": "Ms",
          "alias": null,
          "dateOfBirth": "1985-04-12",
          "email": "jane.citizen@example.com",
          "mobilePhone": "+61 400 000 000",
          "homePhone": null,
          "workNumber": "+61 3 9000 0000",
          "countryOfCitizenship": "AU",
          "countryOfBirth": "AU",
          "townOfBirth": "Melbourne",
          "isPep": "No",
          "occupation": "Software engineer",
          "roles": "AccountHolder",
          "sourceOfWealth": "Salary",
          "addressLine1": "Level 8, 350 Collins Street",
          "addressLine2": null,
          "addressLine3": null,
          "suburb": "Melbourne",
          "state": "VIC",
          "postcode": "3000",
          "country": "AU",
          "gender": "Female",
          "isMainContact": true
        }
      ]
    }
  ]
}