POST api/account/client

Create new client account

Request Information

URI Parameters

None.

Body Parameters

ClientAccountCreation
NameDescriptionTypeAdditional information
NominatedBankAccounts

Nominated bank accounts. The list of funding nominated bank accounts for an account.

Collection of NominatedBankAccount

None.
CashAccounts

Cash accounts. A list of cash accounts that can be used for funding with direct access from TPP.

Collection of BankAccount

None.
InternationalBankAccounts

List of International Bank Accounts

Collection of InternationalBankAccount

None.
AdvisorID

Advisor ID

integer

None.
AdvisorRef

Advisor Reference ("Advisor Code"). This must match ExternalReference of existing Advisor account. If not set, will be associated with default Advisor account.

string

String length: inclusive between 0 and 100
BrokerRegistration

Broker registration details required for Broker Sponsored.

BrokerRegistrationCreation

None.
ThirdPartyRegistration

Third party registration details required for Margin Lending, DVP or "Custodian" accounts.

ThirdPartyRegistration

None.
IssuerSponsoredRegistration

Issuer sponsored registration details

IssuerSponsoredRegistration

None.
Persons

List of persons associated with the account. Must include primary holder (primary destination for contract pdfs and statements). Must include account holders to support broker and issuer sponsorship.

Collection of ClientPersonLink

None.
CompanyID

Company ID of account owner, or where trust / super / minor details are included this specifies the company that is the trustee

integer

None.
CompanyRef

An external company identifier that has been added to a Company via the External Reference field on the company creation endpoint

string

String length: inclusive between 0 and 100
Trust

Trust details of account holder. Required for broker and issuer sponsorship where account is owned by a trust.

TrustCreation

None.
Super

Superannuation details. Required for broker and issuer sponsorship where account is owned by a superannuation trust.

TrustCreation

None.
Minor

Minor Details. Required for broker and issuer sponsorship where account is owned by a minor.

Minor

None.
ContractNoteEmails

A list of email addresses that are sent contract PDFs (this is in addition to the primary account holder)

Collection of ContractNoteEmail

None.
ContractNoteAddresses

Contract note addresses

Collection of ContractNoteAddress

None.
ContractNoteComments

Default text that is to be displayed on the contract note PDFs sent to the client.

string

String length: inclusive between 0 and 100
BrokerageTemplateExternalRef

Brokerage template external reference. If specified, must match reference ('BrokerageCode') of brokerage template associated with the brand.

string

String length: inclusive between 0 and 100
ExternalRef

External reference. An identifer of account in front office systems.

string

String length: inclusive between 0 and 100
ApplicationMoney

Allow application money to be charged and collected on rights purchase by client

boolean

None.
Custodian

Reference to custodian of the account

Custodian

None.
ClientGroups

Client Groups. Can be used to tag accounts as 'Principal Trading'

Collection of ClientAccountCreation+enClientGroupPublicID

None.
PostContractNotes

If set to true then contract notes will be posted primary account holder. By default contract notes will be emailed.

boolean

None.
ClientName

Client Name

string

String length: inclusive between 0 and 255
ClientNameExtension

Client Name Extension

string

String length: inclusive between 0 and 255
GSTScheduleRef

Reference to GST Schedule to be applied to the client.

string

String length: inclusive between 0 and 100
ClassSuperAccess

Allow to enable the access of Class Super - HTTPS Interface Group

boolean

None.
PrincipalTrading

If specified and set to true, the client is flagged as a PrincipalTrading account

boolean

None.
BlockOrder

If specified and set to true, the client is blocked from order creation or amendment

boolean

None.
HouseAccount

Optional.If specified and set to true, the client is setup with no sponsorship

boolean

None.
ShortSell

Optional. If specified and set to true, short sell will be enabled for the client

boolean

None.
HINProtection

Optional. If specified and set to true, HINProtection will be enabled for the client

boolean

None.
PostalAddress

Postal address for the account. This will be displayed on contract PDFs and other statements. If not provided, will use address on principal contact / custodian / company address

Address

None.
ACHRegistration

ACH Registration details

ACHRegistration

None.
FATCACRS

Details of foreign tax residences for company and trust accounts

TIN

None.
LodgementReference

Direct debit entry reference value

string

String length: inclusive between 0 and 18

Request Formats

application/json, text/json

Sample: 
{
  "NominatedBankAccounts": [
    {
      "AccountName": "Account Name",
      "Bsb": "013986",
      "AccountNumber": "12345678",
      "AllowBuyFunding": true,
      "AllowSellFunding": true,
      "IsBuyFundingDefault": true,
      "IsSellFundingDefault": true,
      "IsETOFundingDefault": true,
      "IsDividendDefault": false
    }
  ],
  "CashAccounts": [
    {
      "AccountName": "Account Name",
      "Bsb": "182740",
      "AccountNumber": "12345678",
      "AllowBuyFunding": true,
      "AllowSellFunding": true,
      "IsBuyFundingDefault": true,
      "IsSellFundingDefault": true,
      "IsETOFundingDefault": true,
      "IsDividendDefault": false
    }
  ],
  "InternationalBankAccounts": [
    {
      "AccountNumber": "DE1234XXYYZZ9999999",
      "InternationalBankAccountID": 0,
      "InternationalBankName": "Intl Bank Name",
      "InternationalBankAddress": {
        "Address1": "Intl Bank Address 1",
        "Address2": "Intl Bank Address 2",
        "Address3": "Intl Bank Address 3",
        "Address4": "",
        "Suburb": "",
        "State": "",
        "Postcode": "12445",
        "Country": "GERMANY"
      },
      "BeneficiaryName": "Beneficiary Name",
      "BeneficiaryAddress": {
        "Address1": "Beneficiary Address 1",
        "Address2": "Beneficiary Address 2",
        "Address3": "Beneficiary Address 3",
        "Address4": "",
        "Suburb": "",
        "State": "",
        "Postcode": "12445",
        "Country": "GERMANY"
      },
      "CountryCode": "DEU",
      "SWIFTCode": "",
      "CurrencyCode": "EUR",
      "FeesBorneBy": 1,
      "AllowBuyFunding": false,
      "AllowSellFunding": false,
      "IsBuyFundingDefault": false,
      "IsSellFundingDefault": false,
      "IsDividendDefault": false,
      "IsETODefault": false,
      "IsFundsTransferDefault": true
    }
  ],
  "AdvisorID": 10000,
  "AdvisorRef": null,
  "BrokerRegistration": {
    "RegistrationAddress": {
      "RegAddress1": "Mr John Smith",
      "RegAddress2": "79 COLLINGWOOD STREET",
      "RegAddress3": "OSBORNE PARK WA",
      "RegAddress4": "",
      "RegAddress5": "",
      "RegAddress6": "                     6017"
    },
    "HINTransfer": {
      "PID": 2552,
      "HIN": "9900100856"
    },
    "SendBankAdvice": null
  },
  "ThirdPartyRegistration": {
    "PID": 2552,
    "FacilityId": "20012425",
    "SupplementaryFormat": "53951236",
    "ContactName": "Mr John Smith",
    "ContactNumber": "0355721888",
    "Status": 1,
    "SettlementProviderID": null
  },
  "IssuerSponsoredRegistration": {
    "RegistrationAddress": {
      "RegAddress1": "Mr John Smith",
      "RegAddress2": "79 COLLINGWOOD STREET",
      "RegAddress3": "OSBORNE PARK WA",
      "RegAddress4": "",
      "RegAddress5": "",
      "RegAddress6": "                     6017"
    }
  },
  "Persons": [
    {
      "PersonID": 10001,
      "AccessType": 1,
      "IsPrincipal": true,
      "OwnershipType": 1,
      "ClientRelationshipTypes": [
        1,
        3
      ],
      "CompanyRelationshipTypes": [
        2,
        1
      ]
    }
  ],
  "CompanyID": 41178,
  "CompanyRef": "",
  "Trust": {
    "TrustType": 1,
    "Designation": "CLEAR TRUST ACCOUNT",
    "TFN": "862793498",
    "TFNExemptionType": null,
    "ABN": "50673789893"
  },
  "Super": {
    "TrustType": 1,
    "Designation": "CLEAR SUPERANNUATION FUND",
    "TFN": "862793498",
    "TFNExemptionType": null,
    "ABN": "50673789893"
  },
  "Minor": {
    "MinorType": 1,
    "Designation": "CLEAR MINOR ACCOUNT",
    "TFN": "862793498",
    "ABN": "50673789893",
    "Salutation": "Mr",
    "FirstName": "John",
    "LastName": "Smith",
    "DOB": "1980-01-01T00:00:00"
  },
  "ContractNoteEmails": [
    {
      "EmailAddress": "testemail@testemail.com"
    }
  ],
  "ContractNoteAddresses": [
    {
      "Salutation": null,
      "Firstname": "John",
      "Middlename": "David",
      "Lastname": "Smith",
      "PostalAddress": {
        "Address1": "TPP PTY LTD,",
        "Address2": "LEVEL 20",
        "Address3": "GOVERNOR PHILIP TOWER",
        "Address4": "1 FARRER PLACE",
        "Suburb": "SYDNEY",
        "State": "NSW",
        "Postcode": "2000",
        "Country": "AUSTRALIA"
      }
    }
  ],
  "ContractNoteComments": "Comments to be displayed in client's contract note",
  "BrokerageTemplateExternalRef": "BPBRO",
  "ExternalRef": "BP101",
  "ApplicationMoney": false,
  "Custodian": {
    "CustodianRef": "BSCL",
    "RegisteredName": ""
  },
  "ClientGroups": [
    43
  ],
  "PostContractNotes": false,
  "ClientName": "CLEARING PTE LTD",
  "ClientNameExtension": "",
  "GSTScheduleRef": "GST",
  "ClassSuperAccess": false,
  "PrincipalTrading": true,
  "BlockOrder": false,
  "HouseAccount": false,
  "ShortSell": false,
  "HINProtection": false,
  "PostalAddress": {
    "Address1": "123 DOWN STREET",
    "Address2": "WILLOW LANE",
    "Address3": "",
    "Address4": "",
    "Suburb": "LOWTOWN",
    "State": "WA",
    "Postcode": "12445",
    "Country": "AUSTRALIA"
  },
  "ACHRegistration": {
    "AccID": "ACH100500"
  },
  "FATCACRS": {
    "FATCACountryDetails": [
      {
        "Country": "MYS",
        "TIN": null,
        "TINExemption": 1
      },
      {
        "Country": "HKG",
        "TIN": "456789",
        "TINExemption": null
      }
    ],
    "TaxStatus": 3,
    "GIIN": "789101",
    "FATCACRSStatus": 1
  },
  "LodgementReference": "BP1000"
}

application/xml, text/xml

Sample: 
<ClientAccountCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ACHRegistration>
    <AccID>ACH100500</AccID>
  </ACHRegistration>
  <AdvisorID>10000</AdvisorID>
  <AdvisorRef i:nil="true" />
  <ApplicationMoney>false</ApplicationMoney>
  <BlockOrder>false</BlockOrder>
  <BrokerRegistration>
    <HINTransfer>
      <HIN>9900100856</HIN>
      <PID>2552</PID>
    </HINTransfer>
    <RegistrationAddress>
      <RegAddress1>Mr John Smith</RegAddress1>
      <RegAddress2>79 COLLINGWOOD STREET</RegAddress2>
      <RegAddress3>OSBORNE PARK WA</RegAddress3>
      <RegAddress4></RegAddress4>
      <RegAddress5></RegAddress5>
      <RegAddress6>                     6017</RegAddress6>
    </RegistrationAddress>
    <SendBankAdvice i:nil="true" />
  </BrokerRegistration>
  <BrokerageTemplateExternalRef>BPBRO</BrokerageTemplateExternalRef>
  <CashAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
    <d2p1:BankAccount>
      <d2p1:AccountName>Account Name</d2p1:AccountName>
      <d2p1:AccountNumber>12345678</d2p1:AccountNumber>
      <d2p1:AllowBuyFunding>true</d2p1:AllowBuyFunding>
      <d2p1:AllowSellFunding>true</d2p1:AllowSellFunding>
      <d2p1:Bsb>182740</d2p1:Bsb>
      <d2p1:IsBuyFundingDefault>true</d2p1:IsBuyFundingDefault>
      <d2p1:IsDividendDefault>false</d2p1:IsDividendDefault>
      <d2p1:IsETOFundingDefault>true</d2p1:IsETOFundingDefault>
      <d2p1:IsSellFundingDefault>true</d2p1:IsSellFundingDefault>
    </d2p1:BankAccount>
  </CashAccounts>
  <ClassSuperAccess>false</ClassSuperAccess>
  <ClientGroups>
    <ClientAccountCreation.enClientGroupPublicID>PrincipalTrading</ClientAccountCreation.enClientGroupPublicID>
  </ClientGroups>
  <ClientName>CLEARING PTE LTD</ClientName>
  <ClientNameExtension></ClientNameExtension>
  <CompanyID>41178</CompanyID>
  <CompanyRef></CompanyRef>
  <ContractNoteAddresses>
    <ContractNoteAddress xmlns="">
      <Salutation i:nil="true" />
      <Firstname>John</Firstname>
      <Middlename>David</Middlename>
      <Lastname>Smith</Lastname>
      <PostalAddress>
        <Address1>TPP PTY LTD,</Address1>
        <Address2>LEVEL 20</Address2>
        <Address3>GOVERNOR PHILIP TOWER</Address3>
        <Address4>1 FARRER PLACE</Address4>
        <Suburb>SYDNEY</Suburb>
        <State>NSW</State>
        <Postcode>2000</Postcode>
        <Country>AUSTRALIA</Country>
      </PostalAddress>
    </ContractNoteAddress>
  </ContractNoteAddresses>
  <ContractNoteComments>Comments to be displayed in client's contract note</ContractNoteComments>
  <ContractNoteEmails>
    <contractNoteEmail xmlns="">
      <EmailAddress>testemail@testemail.com</EmailAddress>
    </contractNoteEmail>
  </ContractNoteEmails>
  <Custodian>
    <CustodianRef>BSCL</CustodianRef>
    <RegisteredName></RegisteredName>
  </Custodian>
  <ExternalRef>BP101</ExternalRef>
  <FATCACRS>
    <FATCACRSStatus>DeemedCompliantFinancialInstitution</FATCACRSStatus>
    <FATCACountryDetails>
      <FATCACountryDetail>
        <Country>MYS</Country>
        <TIN i:nil="true" />
        <TINExemption>CountryDoesNotIssueTIN</TINExemption>
      </FATCACountryDetail>
      <FATCACountryDetail>
        <Country>HKG</Country>
        <TIN>456789</TIN>
        <TINExemption i:nil="true" />
      </FATCACountryDetail>
    </FATCACountryDetails>
    <GIIN>789101</GIIN>
    <TaxStatus>Active</TaxStatus>
  </FATCACRS>
  <GSTScheduleRef>GST</GSTScheduleRef>
  <HINProtection>false</HINProtection>
  <HouseAccount>false</HouseAccount>
  <InternationalBankAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
    <d2p1:InternationalBankAccount>
      <d2p1:AccountNumber>DE1234XXYYZZ9999999</d2p1:AccountNumber>
      <d2p1:AllowBuyFunding>false</d2p1:AllowBuyFunding>
      <d2p1:AllowSellFunding>false</d2p1:AllowSellFunding>
      <d2p1:BeneficiaryAddress>
        <Address1 xmlns="">Beneficiary Address 1</Address1>
        <Address2 xmlns="">Beneficiary Address 2</Address2>
        <Address3 xmlns="">Beneficiary Address 3</Address3>
        <Address4 xmlns=""></Address4>
        <Suburb xmlns=""></Suburb>
        <State xmlns=""></State>
        <Postcode xmlns="">12445</Postcode>
        <Country xmlns="">GERMANY</Country>
      </d2p1:BeneficiaryAddress>
      <d2p1:BeneficiaryName>Beneficiary Name</d2p1:BeneficiaryName>
      <d2p1:CountryCode>DEU</d2p1:CountryCode>
      <d2p1:CurrencyCode>EUR</d2p1:CurrencyCode>
      <d2p1:FeesBorneBy>1</d2p1:FeesBorneBy>
      <d2p1:InternationalBankAccountID>0</d2p1:InternationalBankAccountID>
      <d2p1:InternationalBankAddress>
        <Address1 xmlns="">Intl Bank Address 1</Address1>
        <Address2 xmlns="">Intl Bank Address 2</Address2>
        <Address3 xmlns="">Intl Bank Address 3</Address3>
        <Address4 xmlns=""></Address4>
        <Suburb xmlns=""></Suburb>
        <State xmlns=""></State>
        <Postcode xmlns="">12445</Postcode>
        <Country xmlns="">GERMANY</Country>
      </d2p1:InternationalBankAddress>
      <d2p1:InternationalBankName>Intl Bank Name</d2p1:InternationalBankName>
      <d2p1:IsBuyFundingDefault>false</d2p1:IsBuyFundingDefault>
      <d2p1:IsDividendDefault>false</d2p1:IsDividendDefault>
      <d2p1:IsETODefault>false</d2p1:IsETODefault>
      <d2p1:IsFundsTransferDefault>true</d2p1:IsFundsTransferDefault>
      <d2p1:IsSellFundingDefault>false</d2p1:IsSellFundingDefault>
      <d2p1:SWIFTCode></d2p1:SWIFTCode>
    </d2p1:InternationalBankAccount>
  </InternationalBankAccounts>
  <IssuerSponsoredRegistration>
    <RegistrationAddress>
      <RegAddress1>Mr John Smith</RegAddress1>
      <RegAddress2>79 COLLINGWOOD STREET</RegAddress2>
      <RegAddress3>OSBORNE PARK WA</RegAddress3>
      <RegAddress4></RegAddress4>
      <RegAddress5></RegAddress5>
      <RegAddress6>                     6017</RegAddress6>
    </RegistrationAddress>
  </IssuerSponsoredRegistration>
  <LodgementReference>BP1000</LodgementReference>
  <Minor>
    <ABN>50673789893</ABN>
    <DOB>1980-01-01T00:00:00</DOB>
    <Designation>CLEAR MINOR ACCOUNT</Designation>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <MinorType>Company</MinorType>
    <Salutation xmlns:d3p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" />
    <TFN>862793498</TFN>
  </Minor>
  <NominatedBankAccounts xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Account">
    <d2p1:NominatedBankAccount>
      <d2p1:AccountName>Account Name</d2p1:AccountName>
      <d2p1:AccountNumber>12345678</d2p1:AccountNumber>
      <d2p1:AllowBuyFunding>true</d2p1:AllowBuyFunding>
      <d2p1:AllowSellFunding>true</d2p1:AllowSellFunding>
      <d2p1:Bsb>013986</d2p1:Bsb>
      <d2p1:IsBuyFundingDefault>true</d2p1:IsBuyFundingDefault>
      <d2p1:IsDividendDefault>false</d2p1:IsDividendDefault>
      <d2p1:IsETOFundingDefault>true</d2p1:IsETOFundingDefault>
      <d2p1:IsSellFundingDefault>true</d2p1:IsSellFundingDefault>
    </d2p1:NominatedBankAccount>
  </NominatedBankAccounts>
  <Persons>
    <ClientPersonLink>
      <AccessType>NormalAccess</AccessType>
      <ClientRelationshipTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities">
        <d4p1:enClientRelationshipType>Trustee</d4p1:enClientRelationshipType>
        <d4p1:enClientRelationshipType>Beneficiary</d4p1:enClientRelationshipType>
      </ClientRelationshipTypes>
      <CompanyRelationshipTypes xmlns:d4p1="http://schemas.datacontract.org/2004/07/TPP.Utilities">
        <d4p1:enCompanyRelationshipType>Director</d4p1:enCompanyRelationshipType>
        <d4p1:enCompanyRelationshipType>Secretary</d4p1:enCompanyRelationshipType>
      </CompanyRelationshipTypes>
      <IsPrincipal>true</IsPrincipal>
      <OwnershipType>AccountHolder</OwnershipType>
      <PersonID>10001</PersonID>
    </ClientPersonLink>
  </Persons>
  <PostContractNotes>false</PostContractNotes>
  <PostalAddress>
    <Address1>123 DOWN STREET</Address1>
    <Address2>WILLOW LANE</Address2>
    <Address3></Address3>
    <Address4></Address4>
    <Country>AUSTRALIA</Country>
    <Postcode>12445</Postcode>
    <State>WA</State>
    <Suburb>LOWTOWN</Suburb>
  </PostalAddress>
  <PrincipalTrading>true</PrincipalTrading>
  <ShortSell>false</ShortSell>
  <Super>
    <ABN>50673789893</ABN>
    <Designation>CLEAR SUPERANNUATION FUND</Designation>
    <TFN>862793498</TFN>
    <TFNExemptionType i:nil="true" />
    <TrustType>Company</TrustType>
  </Super>
  <ThirdPartyRegistration>
    <ContactName>Mr John Smith</ContactName>
    <ContactNumber>0355721888</ContactNumber>
    <FacilityId>20012425</FacilityId>
    <PID>2552</PID>
    <SettlementProviderID i:nil="true" />
    <Status>Active</Status>
    <SupplementaryFormat>53951236</SupplementaryFormat>
  </ThirdPartyRegistration>
  <Trust>
    <ABN>50673789893</ABN>
    <Designation>CLEAR TRUST ACCOUNT</Designation>
    <TFN>862793498</TFN>
    <TFNExemptionType i:nil="true" />
    <TrustType>Company</TrustType>
  </Trust>
</ClientAccountCreation>

Response Information

Resource Description

ClientAccountCreationResult
NameDescriptionTypeAdditional information
ClientID

An identifier of new created client

integer

None.
ClientName

Name of newly created client

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ClientID": 100500,
  "ClientName": "John Depp"
}

application/xml, text/xml

Sample: 
<ClientAccountCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
  <ClientID>100500</ClientID>
  <ClientName>John Depp</ClientName>
</ClientAccountCreationResult>

Error Response Information

Resource Description

BadRequestResult
NameDescriptionTypeAdditional information
Errors

Collection of Error

None.

Error Response Formats

application/json, text/json

Sample: 
{
  "Errors": [
    {
      "Code": 10003,
      "Description": "sample string 1"
    },
    {
      "Code": 10003,
      "Description": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<BadRequestResultOfenClientCreationErrorYd1IcMMv xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.ErrorResponse">
  <Errors>
    <ErrorOfenClientCreationErrorYd1IcMMv>
      <Code>DoB</Code>
      <Description>sample string 1</Description>
    </ErrorOfenClientCreationErrorYd1IcMMv>
    <ErrorOfenClientCreationErrorYd1IcMMv>
      <Code>DoB</Code>
      <Description>sample string 1</Description>
    </ErrorOfenClientCreationErrorYd1IcMMv>
  </Errors>
</BadRequestResultOfenClientCreationErrorYd1IcMMv>