Introduction

The Praemium Application Programming Interface (API) enables your organisation to access account, investment, investor or model information from our systems securely and on demand. This can be used in a batch or real-time nature depending on your needs and data lifecycle.

This site provides you with full details of each of the endpoints in the API, including parameters, validation tips, and what to expect in our response.

If you are interested in using our API please contact your relationship manager or support team. They can answer any queries you may have and ensure all our compliance and contractual requirements are met. If you are not currently a customer, please register your interest with our sales team by visiting your local contact page https://www.praemium.com/

After your request to use our API has been approved, you're ready to start developing, please contact our Client Services team to obtain credentials that allows access to our test environment. Once your application is fully developed, you can request credentials for the Production environment. We have a number of different endpoints available, below is a summary of the endpoint availability based on our products, roles and regions:

	Read	Read/Create	Enterprise
Account - AUS only	✔	✔	✔
Performance - AUS only	✔	✔	✔
Tax - AUS only	✔	✔	✔
Transactions - AUS only	✔	✔	✔
Income - AUS only	✔	✔	✔
Expenses - AUS only	✔	✔	✔
Reports and Files - AUS only	✔	✔	✔
Single Sign On (SSO)	✔	✔	✔
Product Information (PDS)		✔	✔
User Management		✔	✔
Linking Users		✔	✔
Draft Applications		✔	✔
Bulk and Bespoke Routes			✔

If there are any endpoints that you require and we have not listed, please contact for further information. Alternatively our Upload Centre and automatic file/data exchange (via SFTP or other supported protocols) is available for the bulk collection of data or management of users, accounts or settings.

	Investment Manager specific API functionality
Investment Models
Investment Model management

Investment or Model Managers can access and manage their models within the system via a specialised set of APIs. This includes the setting or updating of investment selection, accessing model FUM, Performance and other information.

Versioning

Specifying a Version

The API is versioned so that we can continually release new features and improvements without affecting existing implementations.

To specify the API version, simply add the HTTP header x-pps-api-version to each request as shown below:

x-pps-api-version: v1

Documentation related to previous versions can be found here.

Product Subscription

Product subscription key is required for accessing corresponding endpoints and should be added to your request as below:

x-pps-subscription-key: d3e30ecd1ab345...

Please log into our developer portal to subscribe to a product and generate corresponding product subscription key.

Authorisation

In order to access the Premium API, you will need to be granted a OAuth 2.0 client to authenticate and authorise your application.

Applications that try to access the API without a valid access token will receive a 403 (Forbidden) response.

To make calls to the API, get access token via our token endpoint and add access token as the Authorization header value in each HTTP request.

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...

POST Access Token

Definition: https://api.onpraemium.com/api/token

Header Examples

Content-Type: application/x-www-form-urlencoded

Header Parameters

Parameter	Type	Description
Content-Typerequired	string	Must be application/x-www-form-urlencoded

Request Parameter - Body Examples

client_id=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&client_secret=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Request Parameter - Body

Parameter	Type	Description
Client_idrequired	string	OAuth 2.0 client ID provided by Praemium.
Client_secretrequired	string	OAuth 2.0 client secret provided by Praemium.

Response Examples

# 200 - OK
{
    "token_type": "Bearer",
    "expires_in": 3599,
    "ext_expires_in": 3599,
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGc..."
}

Response Parameters

Parameter	Type	Description
token_type	string
expires_in	integer
ext_expires_in	integer
access_token	string

PDS

GET PDS

Definition: https://api.onpraemium.com/api/pds

This endpoint returns the PDS details for the service.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Response Examples

# 200 - OK (AU response)
[
  {
    "Id": "AU1",
    "Name": "Praemium Managed Accounts",
    "MaxNoOfBankAccounts": 5,
    "IsSuperSma": false,
    "Status": "Active",
    "Region": "Australia",
    "Models": [
      {
        "Id": "AU2710",
        "Name": "CKI HOLDINGS ORD",
        "Style": "",
        "Code": "1038.HKG"
      }
    ],
    "Fees": [
      {
        "Type": "Establishment",
        "Class": "Adviser",
        "Name": "Establishment Fee",
        "DollarOverwriteSettings": {
          "MinAmount": 0.0,
          "MaxAmount": 90909.0909,
          "MinAmountWithTax": 0.0,
          "MaxAmountWithTax": 100000.0
        },
        "DefaultValue": 0.0,
        "DefaultValueWithTax": 0.0,
        "DefaultType": "Dollar"
      }
      {
        "Id": "AU32",
        "Type": "FeeTable",
        "Class": "NonAdviser",
        "Name": "SMA Administration Fee",
        "Tiers": [
          {
            "ValueAppliedFrom": 0.0,
            "FeePercent": 0.336364,
            "FeePercentWithTax": 0.37
          },
          {
            "ValueAppliedFrom": 250001.0,
            "FeePercent": 0.272727,
            "FeePercentWithTax": 0.3
          },
          {
            "ValueAppliedFrom": 500001.0,
            "FeePercent": 0.181818,
            "FeePercentWithTax": 0.2
          },
          {
            "ValueAppliedFrom": 1000001.0,
            "FeePercent": 1E-10,
            "FeePercentWithTax": 0.0
          }
        ],
        "DefaultValue": 0.336364,
        "DefaultValueWithTax": 0.37,
        "DefaultType": "Percent",
        "IndexationSettings": {
          "Type": "Both",
          "TypeAllowed": "Both",
          "Value": 0.0,
          "ValueMax": 0.0
        }
      }
    ],
    "BankAccountUsages": [
      {
        "Usage": "SMAFEE",
        "Description": "Fee offset",
        "IsMandatory": false,
        "HelpText": "If no bank account is selected, fees will be deducted from your cash holding."
      }
    ],
    "TaxOptions": [
      {
        "Code": "WTFN",
        "Description": "Resident with TFN"
      }
    ]
  }
]

# 200 - OK (UK response)
[
  {
    "Id": "UK87",
    "Name": "Westminster - US GBP",
    "MaxNoOfBankAccounts": 0,
    "DisableCustomisations": false,
    "IsSuperSma": false,
    "ServiceId": "UK1000000112",
    "ServiceName": "PIL  DPS GBP",
    "Region": "International",
    "Models": [
      {
        "Id": "UK1000001282",
        "Name": "LGT Vestra US Ethical",
        "Style": "MAM",
        "Code": "LGT Vestra Ethical",
        "ManagerName": "Model Manager Firm 5192",
        "FeeOverride": {
          "Value": 0.0,
          "IsTiered": false
        }
      }
    ],
    "Fees": [
      {
        "Id": "UK1",
        "Type": "Establishment",
        "Class": "Adviser",
        "Name": "Initial Investment",
        "DollarOverwriteSettings": {
          "MinAmount": 0.0,
          "MaxAmount": 0.5,
          "MinAmountWithTax": 0.0,
          "MaxAmountWithTax": 0.5
        },
        "PercentOverwriteSettings": {
          "MinAmount": 0.0,
          "MaxAmount": 0.5,
          "MinAmountWithTax": 0.0,
          "MaxAmountWithTax": 0.5
        },
        "DefaultValue": 0.0,
        "DefaultValueWithTax": 0.0,
        "DefaultType": "Percent"
      }
    ],
    "BankAccountUsages": [
      {
        "Usage": "CASHCON",
        "Description": "Initial Contribution",
        "IsMandatory": false,
        "HelpText": "This is bank account we will user for your initial payment."
      }
    ],
    "TaxOptions": [
      {
        "Code": "Standard Income Bracket",
        "Description": "The standard income bracket for most investors."
      }
    ],
    "CurrencyCode": "GBP",
    "AvailableAccountTypes": [
      "Sipp",
      "OffshoreBond",
      "RtsRats",
      "Standard",
      "Qrops",
      "PersonalPension",
      "Isa",
      "GroupSipp",
      "Pra",
      "Pera",
      "Jisa",
      "Gia"
    ],
    "Products": [
      {
        "Id": "UK1",
        "IsSingleBankAccount": false,
        "ProductProviderName": "Talbot & Muir",
        "ProductName": "TM SIPP",
        "TaxWrapperId": 9,
        "AvailableModelCodes": [
          "LGT Vestra Ethical",
          "LGT VUSHRGBP",
          "LGT VUSISA",
          "LGT VUSLRGBP",
          "LGT VUSMRGBP",
          "Managed Account Cash GBP",
          "WavertonUSBalPortGBP",
          "WavertonUSCauPortGBP",
          "WavertonUSGroPortGBP",
          "WavertonUSISA"
        ],
        "DisableAdviserFeesUk": false,
        "DisableAdviserFeesInternational": false
      }
    ]
  }
]

Response Parameters

Parameter	Type	Description
Id	string	ID of the PDS.
Name	string	Name of the PDS.
MaxNoOfBankAccounts	integer	Maximum number of bank accounts allowed by the PDS.
IsSuperSma	boolean	If the PDS is specific to SuperSMA.
Status	string	Status of the PDS, active = 1, closed = 2.
ServiceId	string	Service Id.
ServiceName	string	Service Name.
Region	integer	Region of the PDS.
CurrencyCode	string	Currency code for the PDS.
Fees	array	Fees associated to the PDS.
Fees.Id	string	Id of fee.
Fees.Type	enum	FeeTable = 0, Contribution = 1, Establishment = 2, Termination = 3, Withdrawal = 4, Ongoing = 5.
Fees.Class	enum	Adviser = 1, NonAdviser = 2.
Fees.Name	string	Name of fee.
Fees.Tiers	array	Tiers of fee.
Fees.Tiers.ValueAppliedFrom	double	Date the value is applied from.
Fees.Tiers.FeePercent	double	Fee percent.
Fees.Tiers.FeePercentWithTax	double	Fee percent with tax.
Fees.DollarOverwriteSettings	object	Dollar overwrite settings.
Fees.DollarOverwriteSettings.MinAmount	double	Fee overwrite minimum amount.
Fees.DollarOverwriteSettings.MaxAmount	double	Fee overwrite maximum amount.
Fees.DollarOverwriteSettings.MinAmountWithTax	double	Fee overwrite minimum amount with tax.
Fees.DollarOverwriteSettings.MaxAmountWithTax	double	Fee overwrite maximum amount with tax.
Fees.PercentOverwriteSettings	object	Percent overwrite settings.
Fees.PercentOverwriteSettings.MinAmount	double	Fee overwrite minimum amount.
Fees.PercentOverwriteSettings.MaxAmount	double	Fee overwrite maximum amount.
Fees.PercentOverwriteSettings.MinAmountWithTax	double	Fee overwrite minimum amount with tax.
Fees.PercentOverwriteSettings.MaxAmountWithTax	double	Fee overwrite maximum amount with tax.
Fees.DefaultValue	double	Default value of overwrite.
Fees.DefaultValueWithTax	double	Default value of overwrite with tax.
Fees.DefaultType	enum	Dollar = 1, Percent = 2.
Fees.IndexationSettings	object	Indexation settings.
Fees.IndexationSettings.Type	enum	None = 0, Both = 0, Cpi = 1, Custom = 2.
Fees.IndexationSettings.TypeAllowed	enum	None = 0, Both = 0, Cpi = 1, Custom = 2.
Fees.IndexationSettings.Value	double	Fee indexation value.
Fees.IndexationSettings.ValueMax	double	Fee indexation maximum value.
BankAccountUsages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
BankAccountUsages.Usage	string	This allows you to define a regular cash addition or withdrawal from the account.
BankAccountUsages.Description	string	This will advise the bank account usage.
BankAccountUsages.IsMandatory	boolean	If the bank account is mandatory, true or false.
BankAccountUsages.HelpText	string	Help text with regards to the bank account.
TaxOptions	array	Tax options for the PDS.
TaxOptions.Code	string	Tax Option code.
TaxOptions.Description	string	Tax option description.
Models	array	List of available models.
Models.Id	string	ModelId as returned by the Models endpoint.
Models.Name	string	Model name.
Models.Style	string	Model style.
Models.Code	string	Model code.
Models.ManagerName	string	Model Manager name.
Models.FeeOverride	object	Fee override.
Models.FeeOverride.Name	string	Name of the fee override.
Models.FeeOverride.Id	string	Fee override Id.
Models.FeeOverride.Value	double	Fee override value.
Models.FeeOverride.IsTiered	boolean	If the fee override is tiered.
Models.FeeOverride.Tiers	array	The fee override tier if applicable.
Models.FeeOverride.Tiers.From	double	Date from when the fee tier is applicable.
Models.FeeOverride.Tiers.Percentage	double	Fee percentage.
AvailableAccountTypes	integer	Type of account you would like to ope such as Isa/Sipp/RtsRats/Qrops/OffshoreBond.
Products	array	Products for the PDS.
Products.Id	string	Product Id.
Products.IsSingleBankAccount	boolean	Is a single bank account, true or false.
Products.ProductProviderName	string	Product provider name.
Products.ProductName	string	Product name.
Products.TaxWrapperId	integer	Tax wrapper Id.
Products.AvailableModelCodes	array	List of available model codes.
Products.DisableAdviserFeesUk	boolean	Disable adviser fees UK.
Products.DisableAdviserFeesInternational	boolean	Disable adviser fees International.

Applications

POST Individual Applicant & Individual Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "HomeAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "Identifications": [
          {
            "Type": 0,
            "Value": "123456789"
          },
          {
            "MissingReason": 1,
            "MissingReasonText": "test"
          }
        ],
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 14,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      }
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.IndividualDetails.TaxResidenceCountryCode	string	Tax residence country code.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.Identifications	array	Array of TFN / ABN.
Applicants.IndividualDetails.Identifications.Type	enum	Tfn = 0, Tin = 2.
Applicants.IndividualDetails.Identifications.Value	string	Identification value of applicant.
Applicants.IndividualDetails.Identifications.MissingReason	enum	CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99.
Applicants.IndividualDetails.Identifications.MissingReasonText	string	Reason identification of applicant is missing.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Individual = 14.
Accounts.PdsId	string	PDS ID of account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1.

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Corporate Applicant & Company Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 1,
      "CorporateDetails": {
        "Name": "Smith & Smith",
        "BusinessAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "ContactIsSignatory": false,
        "Contact": {
          "Title": "Mr",
          "FirstName": "John",
          "LastName": "Smith",
          "Phone": "012489235",
          "Email": "j.smith@example.com"
        },
        "Signatories": [
          {
            "Title": "Mr",
            "FirstName": "John",
            "LastName": "Smith",
            "Email": "j.smith@example.com",
            "Capacity": 0,
            "IsPoliticallyExposedPerson": false
          }
        ],
        "Identifications": [
          {
            "Type": 1,
            "Value": "123456789"
          }
        ]
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Test company",
      "RegisteredName": "Test company",
      "ShortName": "TC",
      "AccountType": 13,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      }
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Corporate = 1.
Applicants.CorporateDetails	object	Used for Corporate applicants.
Applicants.CorporateDetails.Name	string	Name of the corporate applicant.
Applicants.CorporateDetails.TradingName	string	Trading name of the corporate applicant.
Applicants.CorporateDetails.Identifications		Array of TFN / ABN
Applicants.CorporateDetails.Identifications.Type	enum	Tfn = 0, Abn = 1.
Applicants.CorporateDetails.Identifications.Value	string	Identification value of applicant.
Applicants.CorporateDetails.BusinessAddress	object	Business address.
Applicants.CorporateDetails.BusinessAddress.Street	string	Address line 1.
Applicants.CorporateDetails.BusinessAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.BusinessAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.BusinessAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.BusinessAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.BusinessAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.BusinessAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.MailingAddress	object	Mailing address.
Applicants.CorporateDetails.MailingAddress.Street	string	Address line 1.
Applicants.CorporateDetails.MailingAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.MailingAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.ContactIsSignatory		Whether the contact is a signatory on the account.
Applicants.CorporateDetails.Contact	object	Primary contact.
Applicants.CorporateDetails.Contact.Title	string	Title of Contact.
Applicants.CorporateDetails.Contact.FirstName	string	First name of Contact.
Applicants.CorporateDetails.Contact.LastName	string	Last name of Contact.
Applicants.CorporateDetails.Contact.Email	string	Email of Contact.
Applicants.CorporateDetails.Contact.Phone	string	Phone Number of Contact.
Applicants.CorporateDetails.Signatories	array	Corporate signatories.
Applicants.CorporateDetails.Signatories.Title	string	Title of signatory.
Applicants.CorporateDetails.Signatories.FirstName	string	First name of signatory.
Applicants.CorporateDetails.Signatories.LastName	string	Last name of signatory.
Applicants.CorporateDetails.Signatories.DateOfBirth	date-time	Date of birth of signatory.
Applicants.CorporateDetails.Signatories.Email	string	Email address of signatory.
Applicants.CorporateDetails.Signatories.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.CorporateDetails.Signatories.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.CorporateDetails.Signatories.Capacity	enum	Director = 0, SoleDirector = 1, CompanySecretary = 2.
Applicants.CorporateDetails.Signatories.TaxNumber	string	TaxNumber of signatory.
Applicants.CorporateDetails.Signatories.CountryOfBirth	string	Country of Birth of signatory.
Applicants.CorporateDetails.Signatories.Address	object	Address of signatory.
Applicants.CorporateDetails.Signatories.Address.Street	string	Address line 1.
Applicants.CorporateDetails.Signatories.Address.Line2	string	Address line 2.
Applicants.CorporateDetails.Signatories.Address.Line3	string	Address line 3.
Applicants.CorporateDetails.Signatories.Address.Postcode	string	Postcode of address.
Applicants.CorporateDetails.Signatories.Address.Suburb	string	Suburb of address.
Applicants.CorporateDetails.Signatories.Address.CountryCode	string	Country code of address.
Applicants.CorporateDetails.Signatories.Address.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Company = 13.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & Trust Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "HomeAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "Identifications": [
          {
            "Type": 0,
            "Value": "123456789"
          },
          {
            "MissingReason": 1,
            "MissingReasonText": "test"
          }
        ],
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 14,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "TrustOrFundDetails": {
        "Name": "Fund name",
        "Abn": "12345678",
        "Tfn": "12345678"
      },
      "TargetAllocation": {
        "Fees": [
          {
            "Code": "AB0101",
            "Percentage": 100
          }
        ],
        "Income": []
      }
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.IndividualDetails.TaxResidenceCountryCode	string	Tax residence country code.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.Identifications	array	Array of TFN / ABN.
Applicants.IndividualDetails.Identifications.Type	enum	Tfn = 0, Tin = 2.
Applicants.IndividualDetails.Identifications.Value	string	Identification value of applicant.
Applicants.IndividualDetails.Identifications.MissingReason	enum	CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99.
Applicants.IndividualDetails.Identifications.MissingReasonText	string	Reason identification of applicant is missing.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Trust = 15.
Accounts.PdsId	string	PDS ID of account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1.
Accounts.TrustOrFundDetails	object	Trust or Fund details.
Accounts.TrustOrFundDetails.Name	string	Name of the Trust or Fund.
Accounts.TrustOrFundDetails.Abn	string	ABN of the Super Fund (rather than the corporate trustee) for corporate applicants.
Accounts.TrustOrFundDetails.Tfn	string	TFN for an individual trustee.
Accounts.TargetAllocation	object
Accounts.TargetAllocation.Fees	array
Accounts.TargetAllocation.Fees.Code	string
Accounts.TargetAllocation.Fees.Percentage	double
Accounts.TargetAllocation.Income	array
Accounts.TargetAllocation.Income.Code	string
Accounts.TargetAllocation.Income.Percentage	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Corporate Applicant & Company Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 1,
      "CorporateDetails": {
        "Name": "Smith & Smith",
        "BusinessAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "ContactIsSignatory": false,
        "Contact": {
          "Title": "Mr",
          "FirstName": "John",
          "LastName": "Smith",
          "Phone": "012489235",
          "Email": "j.smith@example.com"
        },
        "Signatories": [
          {
            "Title": "Mr",
            "FirstName": "John",
            "LastName": "Smith",
            "Email": "j.smith@example.com",
            "Capacity": 0,
            "IsPoliticallyExposedPerson": false
          }
        ],
        "Identifications": [
          {
            "Type": 1,
            "Value": "123456789"
          }
        ]
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Test company",
      "RegisteredName": "Test company",
      "ShortName": "TC",
      "AccountType": 13,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "TrustOrFundDetails": {
        "Name": "Fund name",
        "Abn": "12345678",
        "Tfn": "12345678"
      },
      "TargetAllocation": {
        "Fees": [
          {
            "Code": "AB0101",
            "Percentage": 100
          }
        ],
        "Income": []
      }
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Corporate = 1.
Applicants.CorporateDetails	object	Used for Corporate applicants.
Applicants.CorporateDetails.Name	string	Name of the corporate applicant.
Applicants.CorporateDetails.TradingName	string	Trading name of the corporate applicant.
Applicants.CorporateDetails.Identifications		Array of TFN / ABN
Applicants.CorporateDetails.Identifications.Type	enum	Tfn = 0, Abn = 1.
Applicants.CorporateDetails.Identifications.Value	string	Identification value of applicant.
Applicants.CorporateDetails.BusinessAddress	object	Business address.
Applicants.CorporateDetails.BusinessAddress.Street	string	Address line 1.
Applicants.CorporateDetails.BusinessAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.BusinessAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.BusinessAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.BusinessAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.BusinessAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.BusinessAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.MailingAddress	object	Mailing address.
Applicants.CorporateDetails.MailingAddress.Street	string	Address line 1.
Applicants.CorporateDetails.MailingAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.MailingAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.ContactIsSignatory		Whether the contact is a signatory on the account.
Applicants.CorporateDetails.Contact	object	Primary contact.
Applicants.CorporateDetails.Contact.Title	string	Title of Contact.
Applicants.CorporateDetails.Contact.FirstName	string	First name of Contact.
Applicants.CorporateDetails.Contact.LastName	string	Last name of Contact.
Applicants.CorporateDetails.Contact.Email	string	Email of Contact.
Applicants.CorporateDetails.Contact.Phone	string	Phone Number of Contact.
Applicants.CorporateDetails.Signatories	array	Corporate signatories.
Applicants.CorporateDetails.Signatories.Title	string	Title of signatory.
Applicants.CorporateDetails.Signatories.FirstName	string	First name of signatory.
Applicants.CorporateDetails.Signatories.LastName	string	Last name of signatory.
Applicants.CorporateDetails.Signatories.DateOfBirth	date-time	Date of birth of signatory.
Applicants.CorporateDetails.Signatories.Email	string	Email address of signatory.
Applicants.CorporateDetails.Signatories.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.CorporateDetails.Signatories.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.CorporateDetails.Signatories.Capacity	enum	Director = 0, SoleDirector = 1, CompanySecretary = 2.
Applicants.CorporateDetails.Signatories.TaxNumber	string	TaxNumber of signatory.
Applicants.CorporateDetails.Signatories.CountryOfBirth	string	Country of Birth of signatory.
Applicants.CorporateDetails.Signatories.Address	object	Address of signatory.
Applicants.CorporateDetails.Signatories.Address.Street	string	Address line 1.
Applicants.CorporateDetails.Signatories.Address.Line2	string	Address line 2.
Applicants.CorporateDetails.Signatories.Address.Line3	string	Address line 3.
Applicants.CorporateDetails.Signatories.Address.Postcode	string	Postcode of address.
Applicants.CorporateDetails.Signatories.Address.Suburb	string	Suburb of address.
Applicants.CorporateDetails.Signatories.Address.CountryCode	string	Country code of address.
Applicants.CorporateDetails.Signatories.Address.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Trust = 15.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.TrustOrFundDetails	object	Trust or Fund details.
Accounts.TrustOrFundDetails.Name	string	Name of the Trust or Fund.
Accounts.TrustOrFundDetails.Abn	string	ABN of the Super Fund (rather than the corporate trustee) for corporate applicants.
Accounts.TrustOrFundDetails.Tfn	string	TFN for an individual trustee.
Accounts.TargetAllocation	object
Accounts.TargetAllocation.Fees	array
Accounts.TargetAllocation.Fees.Code	string
Accounts.TargetAllocation.Fees.Percentage	double
Accounts.TargetAllocation.Income	array
Accounts.TargetAllocation.Income.Code	string
Accounts.TargetAllocation.Income.Percentage	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & SuperSMA Accumulation Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "HomeAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "Identifications": [
          {
            "Type": 0,
            "Value": "123456789"
          },
          {
            "MissingReason": 1,
            "MissingReasonText": "test"
          }
        ],
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 16,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "TargetAllocation": {
        "Fees": [
          {
            "Code": "AB0101",
            "Percentage": 100
          }
        ],
        "Income": []
      },
      "InitialInvestmentSuper": {
        "ContributionSources": [
          {
            "MemberNumber": "test member number",
            "SourceOfContribution": {
              "ProductName": "test product name",
              "Usi": "test usi"
            },
            "EntireBalance": true,
            "ExpectedAmount": 35234.43543
          }
        ]
      },
      "Beneficiaries": [
          {
            "FullName": "Mr. John Smith",
            "Relationship": 2,
            "DateOfBirth": "2000-01-01",
            "Proportion": 100.0,
            "Address": {
                "Street": "123 Test St",
                "Line2": "",
                "Line3": "",
                "Postcode": "3000",
                "Suburb": "Melbourne",
                "State": "VIC",
                "CountryCode": "AUS"
            },
          }
      ],
      "IsBindingNomination": false,
      "IsEmployerContributing": false
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.IndividualDetails.TaxResidenceCountryCode	string	Tax residence country code.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.Identifications	array	Array of TFN / ABN.
Applicants.IndividualDetails.Identifications.Type	enum	Tfn = 0, Tin = 2.
Applicants.IndividualDetails.Identifications.Value	string	Identification value of applicant.
Applicants.IndividualDetails.Identifications.MissingReason	enum	CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99.
Applicants.IndividualDetails.Identifications.MissingReasonText	string	Reason identification of applicant is missing.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		SuperSmaAccumulation = 16.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Coderequired	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Coderequired	string	Security code of the security.
Accounts.Exclusions.Security.Exchangerequired	string	Exchange code of the security.
Accounts.TargetAllocation	object
Accounts.TargetAllocation.Fees	array
Accounts.TargetAllocation.Fees.Code	string
Accounts.TargetAllocation.Fees.Percentage	double
Accounts.TargetAllocation.Income	array
Accounts.TargetAllocation.Income.Code	string
Accounts.TargetAllocation.Income.Percentage	double
Accounts.InitialInvestmentSuper	object
Accounts.InitialInvestmentSuper.ContributionSources	array
Accounts.InitialInvestmentSuper.ContributionSources.MemberNumber	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution	object
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.ProductName	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.Usi	string
Accounts.InitialInvestmentSuper.ContributionSources.EntireBalance	boolean
Accounts.InitialInvestmentSuper.ContributionSources.ExpectedAmount	double
Accounts.InitialInvestmentSuper.Transfers	array
Accounts.InitialInvestmentSuper.Transfers.AccountId	integer
Accounts.InitialInvestmentSuper.Transfers.TransferMethod	enum	WholeAmountWithClose = 0, WholeAmountKeepOpen = 1, SpecifiedAmount = 2 - whether the source account will be kept open.
Accounts.InitialInvestmentSuper.Transfers.Amount	double
Accounts.InitialInvestmentSuper.OtherContributions	array
Accounts.InitialInvestmentSuper.OtherContributions.ContributionType	enum	NonConcessional_Personal = 21, NonConcessional_Spouse = 22, NonConcessional_Child = 24, Downsizer = 43.
Accounts.InitialInvestmentSuper.OtherContributions.ExpectedAmount	double
Accounts.InitialInvestmentSuper.AccumContribution	object
Accounts.InitialInvestmentSuper.AccumContribution.ContributionType	enum	NonConcessional_Personal = 21, NonConcessional_Spouse = 22.
Accounts.InitialInvestmentSuper.AccumContribution.ExpectedAmount	double
Accounts.Beneficiaries	array
Accounts.Beneficiaries.Proportion	double
Accounts.Beneficiaries.Address	object
Accounts.Beneficiaries.Address.Streetrequired	string
Accounts.Beneficiaries.Address.Line2	string
Accounts.Beneficiaries.Address.Line3	string
Accounts.Beneficiaries.Address.Postcode	string
Accounts.Beneficiaries.Address.Suburb	string
Accounts.Beneficiaries.Address.CountryCode	string
Accounts.Beneficiaries.Address.IsRegistered	boolean
Accounts.Beneficiaries.FullName	string
Accounts.Beneficiaries.Relationship	enum	Spouse = 1, Child = 2, Other = 3, PersonalLegalRepresentative = 8.
Accounts.Beneficiaries.DateOfBirth	date-time
Accounts.IsBindingNomination	boolean
Accounts.IsEmployerContributing	boolean

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & SuperSMA Account-Based-Pensions Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "HomeAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "Identifications": [
          {
            "Type": 0,
            "Value": "123456789"
          },
          {
            "MissingReason": 1,
            "MissingReasonText": "test"
          }
        ],
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 16,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestmentSuper": {
        "ContributionSources": [
          {
            "MemberNumber": "test member number",
            "SourceOfContribution": {
              "ProductName": "test product name",
              "Usi": "test usi"
            },
            "EntireBalance": true,
            "ExpectedAmount": 35234.43543
          }
        ]
      },
      "PensionPayment": {
        "Type": 0,
        "Amount": 100.0,
        "CommencementDate": "2021-01",
        "Frequency": 0
      },
      "TargetAllocation": {
        "Fees": [
          {
            "Code": "AB0101",
            "Percentage": 100
          }
        ],
        "Income": [],
        "Payments": []
      },
      "ReversionaryBeneficiary": {
        "FullName": "Mr. John Smith",
        "Sex": 1,
        "Relationship": 2,
        "DateOfBirth": "2000-01-01"
      },
      "Beneficiaries": [],
      "IsBindingNomination": false
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.IndividualDetails.TaxResidenceCountryCode	string	Tax residence country code.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.Identifications	array	Array of TFN / ABN.
Applicants.IndividualDetails.Identifications.Type	enum	Tfn = 0, Tin = 2.
Applicants.IndividualDetails.Identifications.Value	string	Identification value of applicant.
Applicants.IndividualDetails.Identifications.MissingReason	enum	CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99.
Applicants.IndividualDetails.Identifications.MissingReasonText	string	Reason identification of applicant is missing.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		SuperSmaPensionAbp = 17.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Coderequired	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Coderequired	string	Security code of the security.
Accounts.Exclusions.Security.Exchangerequired	string	Exchange code of the security.
Accounts.TargetAllocation	object
Accounts.TargetAllocation.Fees	array
Accounts.TargetAllocation.Fees.Code	string
Accounts.TargetAllocation.Fees.Percentage	double
Accounts.TargetAllocation.Income	array
Accounts.TargetAllocation.Income.Code	string
Accounts.TargetAllocation.Income.Percentage	double
Accounts.TargetAllocation.Payments	array
Accounts.TargetAllocation.Payments.Code	string
Accounts.TargetAllocation.Payments.Percentage	double
Accounts.PensionPayment	object
Accounts.PensionPayment.Type	enum	Specified = 0, Minimum = 1.
Accounts.PensionPayment.Amount	double
Accounts.PensionPayment.Frequency	enum	Monthly = 0, Quarterly = 1, SemiAnnually = 2, Annually = 3.
Accounts.PensionPayment.CommencementDate	date-time
Accounts.InitialInvestmentSuper	object
Accounts.InitialInvestmentSuper.ContributionSources	array
Accounts.InitialInvestmentSuper.ContributionSources.MemberNumber	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution	object
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.ProductName	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.Usi	string
Accounts.InitialInvestmentSuper.ContributionSources.EntireBalance	boolean
Accounts.InitialInvestmentSuper.ContributionSources.ExpectedAmount	double
Accounts.InitialInvestmentSuper.Transfers	array
Accounts.InitialInvestmentSuper.Transfers.AccountId	integer
Accounts.InitialInvestmentSuper.Transfers.TransferMethod	enum	WholeAmountWithClose = 0, WholeAmountKeepOpen = 1, SpecifiedAmount = 2 - whether the source account will be kept open.
Accounts.InitialInvestmentSuper.Transfers.Amount	double
Accounts.InitialInvestmentSuper.OtherContributions	array
Accounts.InitialInvestmentSuper.OtherContributions.ContributionType	enum	NonConcessional_Personal = 21, NonConcessional_Spouse = 22, NonConcessional_Child = 24, Downsizer = 43.
Accounts.InitialInvestmentSuper.OtherContributions.ExpectedAmount	double
Accounts.ReversionaryBeneficiary	object
Accounts.ReversionaryBeneficiary.Sex	enum	Male = 1, Female = 2.
Accounts.ReversionaryBeneficiary.FullName	string
Accounts.ReversionaryBeneficiary.Relationship	enum	Spouse = 1, Child = 2, Other = 3.
Accounts.ReversionaryBeneficiary.DateOfBirth	date-time
Accounts.Beneficiaries	array
Accounts.Beneficiaries.Proportion	double
Accounts.Beneficiaries.Address	object
Accounts.Beneficiaries.Address.Streetrequired	string
Accounts.Beneficiaries.Address.Line2	string
Accounts.Beneficiaries.Address.Line3	string
Accounts.Beneficiaries.Address.Postcode	string
Accounts.Beneficiaries.Address.Suburb	string
Accounts.Beneficiaries.Address.CountryCode	string
Accounts.Beneficiaries.Address.IsRegistered	boolean
Accounts.Beneficiaries.FullName	string
Accounts.Beneficiaries.Relationship	enum	Spouse = 1, Child = 2, Other = 3, PersonalLegalRepresentative = 8.
Accounts.Beneficiaries.DateOfBirth	date-time
Accounts.IsBindingNomination	boolean

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & SuperSMA Transition-To-Retirement Account - AU

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "HomeAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "Identifications": [
          {
            "Type": 0,
            "Value": "123456789"
          },
          {
            "MissingReason": 1,
            "MissingReasonText": "test"
          }
        ],
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 16,
      "PdsId": "AU5",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "Bsb": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1",
          "Usages": [
            "Income",
            "CashContribution"
          ]
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestmentSuper": {
        "ContributionSources": [
          {
            "MemberNumber": "test member number",
            "SourceOfContribution": {
              "ProductName": "test product name",
              "Usi": "test usi"
            },
            "EntireBalance": true,
            "ExpectedAmount": 35234.43543
          }
        ]
      },
      "PensionPayment": {
        "Type": 0,
        "Amount": 100.0,
        "CommencementDate": "2021-01",
        "Frequency": 0
      },
      "TargetAllocation": {
        "Fees": [
          {
            "Code": "AB0101",
            "Percentage": 100
          }
        ],
        "Income": [],
        "Payments": []
      },
      "ReversionaryBeneficiary": {
        "FullName": "Mr. John Smith",
        "Sex": 1,
        "Relationship": 2,
        "DateOfBirth": "2000-01-01"
      },
      "Beneficiaries": [],
      "IsBindingNomination": false
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.IndividualDetails.TaxResidenceCountryCode	string	Tax residence country code.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.Identifications	array	Array of TFN / ABN.
Applicants.IndividualDetails.Identifications.Type	enum	Tfn = 0, Tin = 2.
Applicants.IndividualDetails.Identifications.Value	string	Identification value of applicant.
Applicants.IndividualDetails.Identifications.MissingReason	enum	CountryDoesntIssue = 1, DontNeedOne = 2, Other = 99.
Applicants.IndividualDetails.Identifications.MissingReasonText	string	Reason identification of applicant is missing.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		SuperSmaPensionTtr = 18.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Coderequired	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.Bsb	string	Bank account BSB.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Usages	array	This allows you to define a regular cash addition or withdrawal from the SMA or SuperSMA.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Coderequired	string	Security code of the security.
Accounts.Exclusions.Security.Exchangerequired	string	Exchange code of the security.
Accounts.TargetAllocation	object
Accounts.TargetAllocation.Fees	array
Accounts.TargetAllocation.Fees.Code	string
Accounts.TargetAllocation.Fees.Percentage	double
Accounts.TargetAllocation.Income	array
Accounts.TargetAllocation.Income.Code	string
Accounts.TargetAllocation.Income.Percentage	double
Accounts.TargetAllocation.Payments	array
Accounts.TargetAllocation.Payments.Code	string
Accounts.TargetAllocation.Payments.Percentage	double
Accounts.PensionPayment	object
Accounts.PensionPayment.Type	enum	Specified = 0, Minimum = 1.
Accounts.PensionPayment.Amount	double
Accounts.PensionPayment.Frequency	enum	Monthly = 0, Quarterly = 1, SemiAnnually = 2, Annually = 3.
Accounts.PensionPayment.CommencementDate	date-time
Accounts.InitialInvestmentSuper	object
Accounts.InitialInvestmentSuper.ContributionSources	array
Accounts.InitialInvestmentSuper.ContributionSources.MemberNumber	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution	object
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.ProductName	string
Accounts.InitialInvestmentSuper.ContributionSources.SourceOfContribution.Usi	string
Accounts.InitialInvestmentSuper.ContributionSources.EntireBalance	boolean
Accounts.InitialInvestmentSuper.ContributionSources.ExpectedAmount	double
Accounts.InitialInvestmentSuper.Transfers	array
Accounts.InitialInvestmentSuper.Transfers.AccountId	integer
Accounts.InitialInvestmentSuper.Transfers.TransferMethod	enum	WholeAmountWithClose = 0, WholeAmountKeepOpen = 1, SpecifiedAmount = 2 - whether the source account will be kept open.
Accounts.InitialInvestmentSuper.Transfers.Amount	double
Accounts.InitialInvestmentSuper.OtherContributions	array
Accounts.InitialInvestmentSuper.OtherContributions.ContributionType	enum	NonConcessional_Personal = 21, NonConcessional_Spouse = 22, NonConcessional_Child = 24, Downsizer = 43.
Accounts.InitialInvestmentSuper.OtherContributions.ExpectedAmount	double
Accounts.ReversionaryBeneficiary	object
Accounts.ReversionaryBeneficiary.Sex	enum	Male = 1, Female = 2.
Accounts.ReversionaryBeneficiary.FullName	string
Accounts.ReversionaryBeneficiary.Relationship	enum	Spouse = 1, Child = 2, Other = 3.
Accounts.ReversionaryBeneficiary.DateOfBirth	date-time
Accounts.Beneficiaries	array
Accounts.Beneficiaries.Proportion	double
Accounts.Beneficiaries.Address	object
Accounts.Beneficiaries.Address.Streetrequired	string
Accounts.Beneficiaries.Address.Line2	string
Accounts.Beneficiaries.Address.Line3	string
Accounts.Beneficiaries.Address.Postcode	string
Accounts.Beneficiaries.Address.Suburb	string
Accounts.Beneficiaries.Address.CountryCode	string
Accounts.Beneficiaries.Address.IsRegistered	boolean
Accounts.Beneficiaries.FullName	string
Accounts.Beneficiaries.Relationship	enum	Spouse = 1, Child = 2, Other = 3, PersonalLegalRepresentative = 8.
Accounts.Beneficiaries.DateOfBirth	date-time
Accounts.IsBindingNomination	boolean

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & GIA Account - UK

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "BirthCountryCode": "AUS",
        "DualNationality": false,
        "UsPerson": true,
        "Profession": "Software engineer",
        "SourceOfWealth": "Secret source",
        "TaxResidences": [
          {
            "CountryCode": "CAN",
            "From": "2020-10-01T00:00:00Z",
            "To": "2020-10-01T00:00:00Z",
            "Identification": "ui9089",
            "NoDocument": false
          }
        ],
        "HomeAddress": {
          "Addressee": "Yoki individual",
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Addressee": "Yoki individual",
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "NationalIdentifier": {
          "CountryOfNationality": "USA",
          "IdentifierType": 0,
          "IdentifierCode": "",
          "NoNationalIdentifier": true
        },
        "ReceiveCommunicationByPost": true,
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 1,
      "PdsId": "AU5",
      "SourceOfFunds": "Loan",
      "AdviserReference": "123123",
      "OngoingFeeAmount": 2.5,
      "ReinvestIncome": false,
      "ProductId": "UK96",
      "ProductProviderReference": "Praemium International Limited",
      "RegularContribution": {
        "Amount": 0,
        "Method": 3,
        "Frequency": 0
      },
      "RegularWithdrawal": {
        "Amount": 120,
        "Method": 2,
        "Frequency": 0
      },
      "Region": 2,
      "CurrencyCode": "GBP",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "SortCode": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1"
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "IllustrationData": {
        "CostsAndCharges": [
          {
            "Type": 0,
            "Amount": 123.123
          },
          {
            "Type": 1,
            "Amount": 321.123
          },
          {
            "Type": 2,
            "Amount": 123.123
          }
        ]
      },
      "InSpecieCashStockTransfers": [
        {
          "TransferType": 0,
          "CedingPartyId": "UK29821",
          "CedingAccountNumber": "123456",
          "InSpecieCashStockTransferDetails": [
            {
              "SecurityIsin": "AU000000ROC4",
              "Quantity": 123.123,
              "BookCost": 3242.32432
            }
          ]
        }
      ],
      "IsTradeFreezeOn": true,
      "TradeFreezeReason": 4,
      "TradeFreezeNote": "just freeze it"
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.BirthCountryCode	string	Birth country code.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Addressee	string	Addressee.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Addressee	string	Addressee.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.TaxResidences	array	Applicant's tax residence.
Applicants.IndividualDetails.TaxResidences.CountryCode	string	Applicant's tax residence country code.
Applicants.IndividualDetails.TaxResidences.From	date-time	From date that applicant held tax residence in that country.
Applicants.IndividualDetails.TaxResidences.To	date-time	To date that applicant held tax residence in that country.
Applicants.IndividualDetails.TaxResidences.Identification	string	Applicant's tax residence identification.
Applicants.IndividualDetails.TaxResidences.NoDocument	boolean	If the applicant does not hold a identification document.
Applicants.IndividualDetails.UsPerson	boolean	Select if applicant is from the US.
Applicants.IndividualDetails.SourceOfWealth	string	Provide the applicant's source of wealth.
Applicants.IndividualDetails.Profession	string	Provide the applicant's profession.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.NationalIdentifier	object	Individual's national identifier.
Applicants.IndividualDetails.NationalIdentifier.CountryOfNationality	string	Applicant's country of national identifier.
Applicants.IndividualDetails.NationalIdentifier.IdentifierType	enum	NoDocument = 0, NationalId = 1, Passport = 2, TaxNumber = 3, LEI = 4.
Applicants.IndividualDetails.NationalIdentifier.IdentifierCode	string	Applicant's national identifier code.
Applicants.IndividualDetails.ReceiveCommunicationByPost	boolean	If you would like to opt out of electronic communications.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Gia = 1.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.SortCode	string	Bank account sort code.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Bic	string	Bank Identifier Code (BIC) of your banking institution.
Accounts.BankAccounts.Iban	string	International Bank Account Number (IBAN) of your banking institution.
Accounts.BankAccounts.RoutingNumber	string	Routing number of banking institution.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1, ElectronicTransfer = 2, Cheque = 3.
Accounts.SourceOfFunds	string	Contribution source.
Accounts.OngoingFeeAmount	double	Ongoing fee amount.
Accounts.ReinvestIncome	boolean	Reinvest income.
Accounts.ProductId	string	Product Id.
Accounts.ProductProviderReference	string	Product provider reference.
Accounts.RegularContribution		Regular cash contributions to the account.
Accounts.RegularWithdrawal		Regular cash withdrawals from the account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Region	enum	Region.
Accounts.CurrencyCode	string	The currency code of the account.
Accounts.AdviserReference	string
Accounts.InSpecieCashStockTransfers	array
Accounts.InSpecieCashStockTransfers.TransferTyperequired	enum	StockAndCash = 0, CashOnly = 1.
Accounts.InSpecieCashStockTransfers.CedingPartyId	string
Accounts.InSpecieCashStockTransfers.CedingAccountNumber	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails	array
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.SecurityIsinrequired	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.Quantity	double
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.BookCost	double
Accounts.InSpecieCashStockTransfers.CashTransferAmount	double
Accounts.InSpecieCashStockTransfers.AmountUsedThisYear	double
Accounts.InSpecieCashStockTransfers.FeeAmount	double
Accounts.InSpecieCashStockTransfers.FeePercent	double
Accounts.IsTradeFreezeOn	boolean
Accounts.TradeFreezeReason	enum	TransferIn = 0, TransferOut = 1, Incident = 2, Deceased = 3, RemovalOfAdviser = 4, AdviserInstructed = 5, Bespoke = 6.
Accounts.TradeFreezeNote	string
Accounts.IllustrationData	object
Accounts.IllustrationData.CostsAndCharges	array
Accounts.IllustrationData.CostsAndCharges.Type	enum	OneOffCharges = 0, OngoingCharges = 1, TransactionCharges = 2, IncidentalCharges = 3, ThirdPartyPayment = 4.
Accounts.IllustrationData.CostsAndCharges.Amount	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Corporate Applicant & GIA Account - UK

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 1,
      "CorporateDetails": {
        "Name": "Test company",
        "TradingName": "Test company",
        "BusinessAddress": {
          "Addressee": "Test company",
          "Street": "Street A",
          "Postcode": "518000",
          "Suburb": "Kingston",
          "CountryCode": "CHN",
          "IsRegistered": true
        },
        "MailingAddress": {
          "Addressee": "Test company",
          "Street": "test street",
          "Line2": null,
          "Line3": null,
          "Postcode": "2050",
          "Suburb": "dd",
          "CountryCode": "GBR",
          "IsRegistered": false
        },
        "Contact": {
          "Title": "Ms",
          "FirstName": "Test",
          "LastName": "individual",
          "FullName": null,
          "DateOfBirth": "2002-10-15",
          "Email": "111@test.com",
          "Phone": "88900",
          "PhoneOther": null,
          "NationalIdentifier": null,
          "ReceiveCommunicationByPost": true,
          "IsPoliticallyExposedPerson": false
        },
        "Signatories": [
          {
            "Capacity": 0,
            "Address": {
              "Addressee": "111 222",
              "Street": "Home",
              "Line2": null,
              "Line3": null,
              "Postcode": "u090",
              "Suburb": "Kingston",
              "CountryCode": "HKG",
              "IsRegistered": false
            },
            "TaxNumber": "ji000",
            "CountryOfBirth": "",
            "Title": "Miss",
            "FirstName": "111",
            "LastName": "222",
            "FullName": null,
            "DateOfBirth": "1998-12-01T00:00:00Z",
            "Email": "test@praemium.com",
            "Phone": "12345678",
            "NationalIdentifier": {
              "CountryOfNationality": "",
              "IdentifierType": 0,
              "IdentifierCode": "",
              "NoNationalIdentifier": true
            },
            "ReceiveCommunicationByPost": false,
            "IsPoliticallyExposedPerson": false
          },
          {
            "Capacity": 0,
            "Address": {
              "Addressee": "Test individual",
              "Street": "Test street",
              "Line2": null,
              "Line3": null,
              "Postcode": "518000",
              "Suburb": "SZ",
              "CountryCode": "CHN",
              "IsRegistered": false
            },
            "TaxNumber": "ui9089",
            "CountryOfBirth": "JPN",
            "Title": "Ms.",
            "FirstName": "Test",
            "LastName": "individual",
            "FullName": null,
            "DateOfBirth": "2002-10-15",
            "Email": "111@test.com",
            "Phone": "34313",
            "PhoneOther": "88900",
            "NationalIdentifier": {
              "CountryOfNationality": "USA",
              "IdentifierType": 0,
              "IdentifierCode": "",
              "NoNationalIdentifier": true
            },
            "ReceiveCommunicationByPost": true,
            "IsPoliticallyExposedPerson": true
          }
        ],
        "CompanyRegistrationNumber": "689",
        "TaxId": "6i87899",
        "Lei": "689",
        "CountryOfIncorporation": "AND",
        "DateOfIncorporation": "2020-10-07",
        "NatureOfActivities": "activity",
        "BearerSharesAreInIssue": false,
        "NameOfRegulator": "test regulator",
        "RegulatorReferenceNumber": "12345678",
        "ContactIsDirectorOrSignificantShareholder": false
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 1,
      "PdsId": "AU5",
      "SourceOfFunds": "Loan",
      "AdviserReference": "123123",
      "OngoingFeeAmount": 2.5,
      "ReinvestIncome": false,
      "ProductId": "UK96",
      "ProductProviderReference": "Praemium International Limited",
      "RegularContribution": {
        "Amount": 0,
        "Method": 3,
        "Frequency": 0
      },
      "RegularWithdrawal": {
        "Amount": 120,
        "Method": 2,
        "Frequency": 0
      },
      "Region": 2,
      "CurrencyCode": "GBP",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "SortCode": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1"
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "IllustrationData": {
        "CostsAndCharges": [
          {
            "Type": 0,
            "Amount": 123.123
          },
          {
            "Type": 1,
            "Amount": 321.123
          },
          {
            "Type": 2,
            "Amount": 123.123
          }
        ]
      },
      "InSpecieCashStockTransfers": [
        {
          "TransferType": 0,
          "CedingPartyId": "UK29821",
          "CedingAccountNumber": "123456",
          "InSpecieCashStockTransferDetails": [
            {
              "SecurityIsin": "AU000000ROC4",
              "Quantity": 123.123,
              "BookCost": 3242.32432
            }
          ]
        }
      ],
      "IsTradeFreezeOn": true,
      "TradeFreezeReason": 4,
      "TradeFreezeNote": "just freeze it"
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Corporate = 1.
Applicants.CorporateDetails	object	Used for Corporate applicants.
Applicants.CorporateDetails.Name	string	Name of the corporate applicant.
Applicants.CorporateDetails.TradingName	string	Trading name of the corporate applicant.
Applicants.CorporateDetails.BusinessAddress	object	Business address.
Applicants.CorporateDetails.BusinessAddress.Addressee	string	Addressee.
Applicants.CorporateDetails.BusinessAddress.Street	string	Address line 1.
Applicants.CorporateDetails.BusinessAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.BusinessAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.BusinessAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.BusinessAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.BusinessAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.BusinessAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.MailingAddress	object	Mailing address.
Applicants.CorporateDetails.MailingAddress.Addressee	string	Addressee.
Applicants.CorporateDetails.MailingAddress.Street	string	Address line 1.
Applicants.CorporateDetails.MailingAddress.Line2	string	Address line 2.
Applicants.CorporateDetails.MailingAddress.Line3	string	Address line 3.
Applicants.CorporateDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.CorporateDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.CorporateDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.CorporateDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.ContactIsDirectorOrSignificantShareholder	boolean	Whether the contact is a director or significant shareholder on the account.
Applicants.CorporateDetails.Contact	object	Primary contact.
Applicants.CorporateDetails.Contact.Title	string	Title of Contact.
Applicants.CorporateDetails.Contact.FirstName	string	First name of Contact.
Applicants.CorporateDetails.Contact.LastName	string	Last name of Contact.
Applicants.CorporateDetails.Contact.DateOfBirth	date-time	Date of birth of Contact.
Applicants.CorporateDetails.Contact.Email	string	Email of Contact.
Applicants.CorporateDetails.Contact.Phone	string	Phone Number of Contact.
Applicants.CorporateDetails.Contact.PhoneOther	string	Secondary contact number of Contact.
Applicants.CorporateDetails.Contact.NationalIdentifier	object	National identifier.
Applicants.CorporateDetails.Contact.NationalIdentifier.CountryOfNationality	string	Applicant's country of national identifier.
Applicants.CorporateDetails.Contact.NationalIdentifier.IdentifierType	enum	NoDocument = 0, NationalId = 1, Passport = 2, TaxNumber = 3, LEI = 4.
Applicants.CorporateDetails.Contact.NationalIdentifier.IdentifierCode	string	Applicant's national identifier code.
Applicants.CorporateDetails.Contact.ReceiveCommunicationByPost	boolean	If you would like to opt out of electronic communications.
Applicants.CorporateDetails.Contact.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.CorporateDetails.Contact.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.CorporateDetails.Signatories	array	Corporate signatories.
Applicants.CorporateDetails.Signatories.Capacity	enum	Director = 0, SignificantShareholder = 6.
Applicants.CorporateDetails.Signatories.TaxNumber	string	TaxNumber of signatory.
Applicants.CorporateDetails.Signatories.CountryOfBirth	string	Country of Birth of signatory.
Applicants.CorporateDetails.Signatories.Address	object	Address of signatory.
Applicants.CorporateDetails.Signatories.Address.Addressee	string	Addressee.
Applicants.CorporateDetails.Signatories.Address.Street	string	Address line 1.
Applicants.CorporateDetails.Signatories.Address.Line2	string	Address line 2.
Applicants.CorporateDetails.Signatories.Address.Line3	string	Address line 3.
Applicants.CorporateDetails.Signatories.Address.Postcode	string	Postcode of address.
Applicants.CorporateDetails.Signatories.Address.Suburb	string	Suburb of address.
Applicants.CorporateDetails.Signatories.Address.CountryCode	string	Country code of address.
Applicants.CorporateDetails.Signatories.Address.IsRegistered	boolean	Whether address is registered.
Applicants.CorporateDetails.Signatories.Title	string	Title of signatory.
Applicants.CorporateDetails.Signatories.FirstName	string	First name of signatory.
Applicants.CorporateDetails.Signatories.LastName	string	Last name of signatory.
Applicants.CorporateDetails.Signatories.DateOfBirth	date-time	Date of birth of signatory.
Applicants.CorporateDetails.Signatories.Email	string	Email address of signatory.
Applicants.CorporateDetails.Signatories.Phone	string	Phone number of signatory.
Applicants.CorporateDetails.Signatories.PhoneOther	string	Secondary contact number of signatory.
Applicants.CorporateDetails.Signatories.NationalIdentifier	object	Signatory's national identifier.
Applicants.CorporateDetails.Signatories.NationalIdentifier.CountryOfNationality	string	Applicant's country of national identifier.
Applicants.CorporateDetails.Signatories.NationalIdentifier.IdentifierType	enum	NoDocument = 0, NationalId = 1, Passport = 2, TaxNumber = 3, LEI = 4.
Applicants.CorporateDetails.Signatories.NationalIdentifier.IdentifierCode	string	Applicant's national identifier code.
Applicants.CorporateDetails.Signatories.ReceiveCommunicationByPost	boolean	If you would like to opt out of electronic communications.
Applicants.CorporateDetails.Signatories.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.CorporateDetails.Signatories.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.CorporateDetails.CompanyRegistrationNumber	string	Register number of the company.
Applicants.CorporateDetails.TaxId	string	Tax Identity of the company.
Applicants.CorporateDetails.Lei	string	LEI of the Company.
Applicants.CorporateDetails.CountryOfIncorporation	string	Country of Incorporation of the Company.
Applicants.CorporateDetails.DateOfIncorporation	date-time	Date of Incorporation of the Company.
Applicants.CorporateDetails.NatureOfActivities	string	Nature of activities that the Company performs.
Applicants.CorporateDetails.BearerSharesAreInIssue	boolean
Applicants.CorporateDetails.NameOfRegulator	string	Name of regulator.
Applicants.CorporateDetails.RegulatorReferenceNumber	string	Regulator reference number.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Gia = 1.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.SortCode	string	Bank account sort code.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Bic	string	Bank Identifier Code (BIC) of your banking institution.
Accounts.BankAccounts.Iban	string	International Bank Account Number (IBAN) of your banking institution.
Accounts.BankAccounts.RoutingNumber	string	Routing number of banking institution.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1, ElectronicTransfer = 2, Cheque = 3.
Accounts.SourceOfFunds	string	Contribution source.
Accounts.OngoingFeeAmount	double	Ongoing fee amount.
Accounts.ReinvestIncome	boolean	Reinvest income.
Accounts.ProductId	string	Product Id.
Accounts.ProductProviderReference	string	Product provider reference.
Accounts.RegularContribution		Regular cash contributions to the account.
Accounts.RegularWithdrawal		Regular cash withdrawals from the account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Region	enum	Region.
Accounts.CurrencyCode	string	The currency code of the account.
Accounts.AdviserReference	string
Accounts.InSpecieCashStockTransfers	array
Accounts.InSpecieCashStockTransfers.TransferTyperequired	enum	StockAndCash = 0, CashOnly = 1.
Accounts.InSpecieCashStockTransfers.CedingPartyId	string
Accounts.InSpecieCashStockTransfers.CedingAccountNumber	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails	array
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.SecurityIsinrequired	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.Quantity	double
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.BookCost	double
Accounts.InSpecieCashStockTransfers.CashTransferAmount	double
Accounts.InSpecieCashStockTransfers.AmountUsedThisYear	double
Accounts.InSpecieCashStockTransfers.FeeAmount	double
Accounts.InSpecieCashStockTransfers.FeePercent	double
Accounts.IsTradeFreezeOn	boolean
Accounts.TradeFreezeReason	enum	TransferIn = 0, TransferOut = 1, Incident = 2, Deceased = 3, RemovalOfAdviser = 4, AdviserInstructed = 5, Bespoke = 6.
Accounts.TradeFreezeNote	string
Accounts.IllustrationData	object
Accounts.IllustrationData.CostsAndCharges	array
Accounts.IllustrationData.CostsAndCharges.Type	enum	OneOffCharges = 0, OngoingCharges = 1, TransactionCharges = 2, IncidentalCharges = 3, ThirdPartyPayment = 4.
Accounts.IllustrationData.CostsAndCharges.Amount	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Trust Applicant & GIA Account - UK

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 2,
      "TrustDetails": {
        "TrustName": "Test company",
        "NatureOfTrust": 1,
        "Lei": "123456",
        "DateOfEstablishment": "2020-01-01",
        "TaxDomicile": "some place",
        "Address": {
          "Addressee": "Test company",
          "Street": "Street A",
          "Postcode": "518000",
          "Suburb": "Kingston",
          "CountryCode": "CHN",
          "IsRegistered": true
        },
        "Signatories": [
          {
            "Capacity": 4,
            "Address": {
              "Addressee": "111 222",
              "Street": "Home",
              "Line2": null,
              "Line3": null,
              "Postcode": "u090",
              "Suburb": "Kingston",
              "CountryCode": "HKG",
              "IsRegistered": false
            },
            "TaxNumber": "ji000",
            "CountryOfBirth": "",
            "Title": "Miss",
            "FirstName": "111",
            "LastName": "222",
            "FullName": null,
            "DateOfBirth": "1998-12-01T00:00:00Z",
            "Email": "test@praemium.com",
            "Phone": "12345678",
            "NationalIdentifier": {
              "CountryOfNationality": "",
              "IdentifierType": 0,
              "IdentifierCode": "",
              "NoNationalIdentifier": true
            },
            "ReceiveCommunicationByPost": false,
            "IsPoliticallyExposedPerson": false
          }
        ],
        "CorporateTrustees": [
          {
            "Name": "Test company",
            "TradingName": "Test company",
            "BusinessAddress": {
              "Addressee": "Test company",
              "Street": "Street A",
              "Postcode": "518000",
              "Suburb": "Kingston",
              "CountryCode": "CHN",
              "IsRegistered": true
            },
            "MailingAddress": {
              "Addressee": "Test company",
              "Street": "Street A",
              "Postcode": "518000",
              "Suburb": "Kingston",
              "CountryCode": "CHN",
              "IsRegistered": true
            },
            "CompanyRegistrationNumber": "689",
            "TaxId": "6i87899",
            "Lei": "123456",
            "NameOfRegulator": "test regulator",
            "RegulatorReferenceNumber": "12345678"
          }
        ]        
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 1,
      "PdsId": "AU5",
      "SourceOfFunds": "Loan",
      "AdviserReference": "123123",
      "OngoingFeeAmount": 2.5,
      "ReinvestIncome": false,
      "ProductId": "UK96",
      "ProductProviderReference": "Praemium International Limited",
      "RegularContribution": {
        "Amount": 0,
        "Method": 3,
        "Frequency": 0
      },
      "RegularWithdrawal": {
        "Amount": 120,
        "Method": 2,
        "Frequency": 0
      },
      "Region": 2,
      "CurrencyCode": "GBP",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "SortCode": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1"
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "IllustrationData": {
        "CostsAndCharges": [
          {
            "Type": 0,
            "Amount": 123.123
          },
          {
            "Type": 1,
            "Amount": 321.123
          },
          {
            "Type": 2,
            "Amount": 123.123
          }
        ]
      },
      "InSpecieCashStockTransfers": [
        {
          "TransferType": 0,
          "CedingPartyId": "UK29821",
          "CedingAccountNumber": "123456",
          "InSpecieCashStockTransferDetails": [
            {
              "SecurityIsin": "AU000000ROC4",
              "Quantity": 123.123,
              "BookCost": 3242.32432
            }
          ]
        }
      ],
      "IsTradeFreezeOn": true,
      "TradeFreezeReason": 4,
      "TradeFreezeNote": "just freeze it"
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Trust = 2.
Applicants.TrustDetails	object	Used for Trust applicants.
Applicants.TrustDetails.TrustName	string	Name of the trust.
Applicants.TrustDetails.NatureOfTrust	enum	Nature of the trust. Bare = 0, Charitable = 1, Will = 2, Interest in possession = 3, Discretionary = 4, Accumulation = 5, Settlor interested = 6, Granted = 7, Single Persion Pension = 8, Mulitple Member Personal Pension = 9, Single Member SSAS = 10, Multiple Member SSAS = 11, Loan = 12,.
Applicants.TrustDetails.Lei	string	LEI of Trust.
Applicants.TrustDetails.DateOfEstablishment	date-time	Date Trust was established.
Applicants.TrustDetails.TaxDomicile	string	Tax domicile of Trust.
Applicants.TrustDetails.Address	object	Address of Trust.
Applicants.TrustDetails.Address.Addressee	string	Addressee.
Applicants.TrustDetails.Address.Street	string	Address line 1.
Applicants.TrustDetails.Address.Line2	string	Address line 2.
Applicants.TrustDetails.Address.Line3	string	Address line 3.
Applicants.TrustDetails.Address.Postcode	string	Postcode of address.
Applicants.TrustDetails.Address.Suburb	string	Suburb of address.
Applicants.TrustDetails.Address.CountryCode	string	Country code of address.
Applicants.TrustDetails.Address.IsRegistered	boolean	Whether address is registered.
Applicants.TrustDetails.Signatories	array	Signatories of the trust.
Applicants.TrustDetails.Signatories.Capacity	enum	Trustee = 4, Beneficiary = 7.
Applicants.TrustDetails.Signatories.TaxNumber	string	TaxNumber of signatory.
Applicants.TrustDetails.Signatories.CountryOfBirth	string	Country of Birth of signatory.
Applicants.TrustDetails.Signatories.Address	object	Address of signatory.
Applicants.TrustDetails.Signatories.Address.Addressee	string	Addressee.
Applicants.TrustDetails.Signatories.Address.Street	string	Address line 1.
Applicants.TrustDetails.Signatories.Address.Line2	string	Address line 2.
Applicants.TrustDetails.Signatories.Address.Line3	string	Address line 3.
Applicants.TrustDetails.Signatories.Address.Postcode	string	Postcode of address.
Applicants.TrustDetails.Signatories.Address.Suburb	string	Suburb of address.
Applicants.TrustDetails.Signatories.Address.CountryCode	string	Country code of address.
Applicants.TrustDetails.Signatories.Address.IsRegistered	boolean	Whether address is registered.
Applicants.TrustDetails.Signatories.Title	string	Title of signatory.
Applicants.TrustDetails.Signatories.FirstName	string	First name of signatory.
Applicants.TrustDetails.Signatories.LastName	string	Last name of signatory.
Applicants.TrustDetails.Signatories.DateOfBirth	date-time	Date of birth of signatory.
Applicants.TrustDetails.Signatories.Email	string	Email address of signatory.
Applicants.TrustDetails.Signatories.Phone	string	Phone number of signatory.
Applicants.TrustDetails.Signatories.PhoneOther	string	Secondary contact number of signatory.
Applicants.TrustDetails.Signatories.NationalIdentifier	object	Signatory's national identifier.
Applicants.TrustDetails.Signatories.NationalIdentifier.CountryOfNationality	string	Applicant's country of national identifier.
Applicants.TrustDetails.Signatories.NationalIdentifier.IdentifierType	enum	NoDocument = 0, NationalId = 1, Passport = 2, TaxNumber = 3, LEI = 4.
Applicants.TrustDetails.Signatories.NationalIdentifier.IdentifierCode	string	Applicant's national identifier code.
Applicants.TrustDetails.Signatories.ReceiveCommunicationByPost	boolean	If you would like to opt out of electronic communications.
Applicants.TrustDetails.Signatories.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.TrustDetails.Signatories.PepDetails	string	If applicant is politically exposed, details must be supplied.
Applicants.TrustDetails.CorporateTrustees	array	Corporate trustees of the trust.
Applicants.TrustDetails.CorporateTrustees.Name	string	Name of the corporate applicant.
Applicants.TrustDetails.CorporateTrustees.TradingName	string	Trading name of the corporate applicant.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress	object	Business address.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Addressee	string	Addressee.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Street	string	Address line 1.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Line2	string	Address line 2.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Line3	string	Address line 3.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Postcode	string	Postcode of address.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.Suburb	string	Suburb of address.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.CountryCode	string	Country code of address.
Applicants.TrustDetails.CorporateTrustees.BusinessAddress.IsRegistered	boolean	Whether address is registered.
Applicants.TrustDetails.CorporateTrustees.MailingAddress	object	Mailing address.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Addressee	string	Addressee.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Street	string	Address line 1.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Line2	string	Address line 2.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Line3	string	Address line 3.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Postcode	string	Postcode of address.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.Suburb	string	Suburb of address.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.CountryCode	string	Country code of address.
Applicants.TrustDetails.CorporateTrustees.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.TrustDetails.CorporateTrustees.CompanyRegistrationNumber	string	Register number of the company.
Applicants.TrustDetails.CorporateTrustees.TaxId	string	Tax Identity of the company.
Applicants.TrustDetails.CorporateTrustees.Lei	string	LEI of the Company.
Applicants.TrustDetails.CorporateTrustees.NameOfRegulator	string	Name of regulator.
Applicants.TrustDetails.CorporateTrustees.RegulatorReferenceNumber	string	Regulator reference number.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Gia = 1.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.SortCode	string	Bank account sort code.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Bic	string	Bank Identifier Code (BIC) of your banking institution.
Accounts.BankAccounts.Iban	string	International Bank Account Number (IBAN) of your banking institution.
Accounts.BankAccounts.RoutingNumber	string	Routing number of banking institution.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1, ElectronicTransfer = 2, Cheque = 3.
Accounts.SourceOfFunds	string	Contribution source.
Accounts.OngoingFeeAmount	double	Ongoing fee amount.
Accounts.ReinvestIncome	boolean	Reinvest income.
Accounts.ProductId	string	Product Id.
Accounts.ProductProviderReference	string	Product provider reference.
Accounts.RegularContribution		Regular cash contributions to the account.
Accounts.RegularWithdrawal		Regular cash withdrawals from the account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Region	enum	Region.
Accounts.CurrencyCode	string	The currency code of the account.
Accounts.AdviserReference	string
Accounts.InSpecieCashStockTransfers	array
Accounts.InSpecieCashStockTransfers.TransferTyperequired	enum	StockAndCash = 0, CashOnly = 1.
Accounts.InSpecieCashStockTransfers.CedingPartyId	string
Accounts.InSpecieCashStockTransfers.CedingAccountNumber	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails	array
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.SecurityIsinrequired	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.Quantity	double
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.BookCost	double
Accounts.InSpecieCashStockTransfers.CashTransferAmount	double
Accounts.InSpecieCashStockTransfers.AmountUsedThisYear	double
Accounts.InSpecieCashStockTransfers.FeeAmount	double
Accounts.InSpecieCashStockTransfers.FeePercent	double
Accounts.IsTradeFreezeOn	boolean
Accounts.TradeFreezeReason	enum	TransferIn = 0, TransferOut = 1, Incident = 2, Deceased = 3, RemovalOfAdviser = 4, AdviserInstructed = 5, Bespoke = 6.
Accounts.TradeFreezeNote	string
Accounts.IllustrationData	object
Accounts.IllustrationData.CostsAndCharges	array
Accounts.IllustrationData.CostsAndCharges.Type	enum	OneOffCharges = 0, OngoingCharges = 1, TransactionCharges = 2, IncidentalCharges = 3, ThirdPartyPayment = 4.
Accounts.IllustrationData.CostsAndCharges.Amount	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

POST Individual Applicant & ISA Account - UK

Definition: https://api.onpraemium.com/api/application

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AdviserId": 123456,
  "Applicants": [
    {
      "ApplicantType": 0,
      "IndividualDetails": {
        "Title": "Mr",
        "FirstName": "John",
        "LastName": "Smith",
        "Email": "j.smith@example.com",
        "Phone": "012489235",
        "PhoneOther": "012489235",
        "Gender": 1,
        "BirthCountryCode": "AUS",
        "DualNationality": false,
        "UsPerson": true,
        "Profession": "Software engineer",
        "SourceOfWealth": "Secret source",
        "TaxResidences": [
          {
            "CountryCode": "CAN",
            "From": "2020-10-01T00:00:00Z",
            "To": "2020-10-01T00:00:00Z",
            "Identification": "ui9089",
            "NoDocument": false
          }
        ],
        "HomeAddress": {
          "Addressee": "Yoki individual",
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "MailingAddress": {
          "Addressee": "Yoki individual",
          "Street": "123 Test St",
          "Postcode": "3000",
          "Suburb": "Melbourne",
          "State": "VIC",
          "CountryCode": "AUS"
        },
        "NationalIdentifier": {
          "CountryOfNationality": "USA",
          "IdentifierType": 0,
          "IdentifierCode": "",
          "NoNationalIdentifier": true
        },
        "ReceiveCommunicationByPost": true,
        "IsPoliticallyExposedPerson": true,
        "PepDetails": "Senior politician"
      }
    }
  ],
  "Accounts": [
    {
      "Name": "Miss Jane Smith",
      "RegisteredName": "Miss Jane Smith",
      "ShortName": "Jane",
      "AccountType": 1,
      "PdsId": "AU5",
      "SourceOfFunds": "Loan",
      "AdviserReference": "123123",
      "OngoingFeeAmount": 2.5,
      "ReinvestIncome": false,
      "ProductId": "UK96",
      "ProductProviderReference": "Praemium International Limited",
      "RegularContribution": {
        "Amount": 0,
        "Method": 3,
        "Frequency": 0
      },
      "RegularWithdrawal": {
        "Amount": 120,
        "Method": 2,
        "Frequency": 0
      },
      "Region": 2,
      "CurrencyCode": "GBP",
      "Fees": [
        {
          "Id": "AU21871",
          "Rate": 0,
          "Unit": "Dollar"
        }
      ],
      "Models": [
        {
          "Code": "AU0001",
          "Proportion": 50
        },
        {
          "Code": "IN0001",
          "Proportion": 50
        }
      ],
      "BankAccounts": [
        {
          "SortCode": "12012",
          "AccountNumber": "6555555567",
          "AccountName": "Bank1"
        }
      ],
      "Exclusions": [
        {
          "Code": "AU0002",
          "Exchange": "ASX"
        }
      ],
      "InitialInvestment": {
        "Cash": 132.12,
        "Shares": 321.32,
        "Method": 0
      },
      "IllustrationData": {
        "CostsAndCharges": [
          {
            "Type": 0,
            "Amount": 123.123
          },
          {
            "Type": 1,
            "Amount": 321.123
          },
          {
            "Type": 2,
            "Amount": 123.123
          }
        ]
      },
      "InSpecieCashStockTransfers": [
        {
          "TransferType": 0,
          "CedingPartyId": "UK29821",
          "CedingAccountNumber": "123456",
          "InSpecieCashStockTransferDetails": [
            {
              "SecurityIsin": "AU000000ROC4",
              "Quantity": 123.123,
              "BookCost": 3242.32432
            }
          ]
        }
      ],
      "IsTradeFreezeOn": true,
      "TradeFreezeReason": 4,
      "TradeFreezeNote": "just freeze it"
    }
  ]
}

Request Parameter - Body

Parameter	Type	Description
AdviserIdrequired	integer	Adviser ID to create the application under.
OwnerAdviserId	integer	Owner adviser ID to create the application under.
Applicantsrequired	array	Objects containing the applicant data. There must be at least one applicant for the request to succeed. The array of objects may contain a mix of Individual and Corporate applicants.
Applicants.OwnerAdviserId	integer	Owner Adviser ID.
Applicants.ApplicantType	enum	Individual = 0.
Applicants.IndividualDetails	object	Used for Individual applicants.
Applicants.IndividualDetails.CitizenshipCountryCode	string	Citizenship country code.
Applicants.IndividualDetails.BirthCountryCode	string	Birth country code.
Applicants.IndividualDetails.HomeAddress	object	Home address of individual applicant.
Applicants.IndividualDetails.HomeAddress.Addressee	string	Addressee.
Applicants.IndividualDetails.HomeAddress.Street	string	Address line 1.
Applicants.IndividualDetails.HomeAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.HomeAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.HomeAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.HomeAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.HomeAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.HomeAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.MailingAddress	object	Mailing address of individual applicant.
Applicants.IndividualDetails.MailingAddress.Addressee	string	Addressee.
Applicants.IndividualDetails.MailingAddress.Street	string	Address line 1.
Applicants.IndividualDetails.MailingAddress.Line2	string	Address line 2.
Applicants.IndividualDetails.MailingAddress.Line3	string	Address line 3.
Applicants.IndividualDetails.MailingAddress.Postcode	string	Postcode of address.
Applicants.IndividualDetails.MailingAddress.Suburb	string	Suburb of address.
Applicants.IndividualDetails.MailingAddress.CountryCode	string	Country code of address.
Applicants.IndividualDetails.MailingAddress.IsRegistered	boolean	Whether address is registered.
Applicants.IndividualDetails.Genderrequired	enum	Male = 1, Female = 2.
Applicants.IndividualDetails.UserName	string	User Name of individual applicant.
Applicants.IndividualDetails.UserId	string	User ID of individual applicant.
Applicants.IndividualDetails.TaxResidences	array	Applicant's tax residence.
Applicants.IndividualDetails.TaxResidences.CountryCode	string	Applicant's tax residence country code.
Applicants.IndividualDetails.TaxResidences.From	date-time	From date that applicant held tax residence in that country.
Applicants.IndividualDetails.TaxResidences.To	date-time	To date that applicant held tax residence in that country.
Applicants.IndividualDetails.TaxResidences.Identification	string	Applicant's tax residence identification.
Applicants.IndividualDetails.TaxResidences.NoDocument	boolean	If the applicant does not hold a identification document.
Applicants.IndividualDetails.UsPerson	boolean	Select if applicant is from the US.
Applicants.IndividualDetails.SourceOfWealth	string	Provide the applicant's source of wealth.
Applicants.IndividualDetails.Profession	string	Provide the applicant's profession.
Applicants.IndividualDetails.Title	string	Title: Mr, Mrs, Ms, Miss, Doctor, Lady, Prof and Sir.
Applicants.IndividualDetails.FirstName	string	First name of individual.
Applicants.IndividualDetails.LastName	string	Last name of individual.
Applicants.IndividualDetails.DateOfBirth	date-time	Date of birth of the individual.
Applicants.IndividualDetails.Email	string	E-mail address of the individual.
Applicants.IndividualDetails.Phone	string	Primary contact number of the individual.
Applicants.IndividualDetails.PhoneOther	string	Other phone of the individual.
Applicants.IndividualDetails.NationalIdentifier	object	Individual's national identifier.
Applicants.IndividualDetails.NationalIdentifier.CountryOfNationality	string	Applicant's country of national identifier.
Applicants.IndividualDetails.NationalIdentifier.IdentifierType	enum	NoDocument = 0, NationalId = 1, Passport = 2, TaxNumber = 3, LEI = 4.
Applicants.IndividualDetails.NationalIdentifier.IdentifierCode	string	Applicant's national identifier code.
Applicants.IndividualDetails.ReceiveCommunicationByPost	boolean	If you would like to opt out of electronic communications.
Applicants.IndividualDetails.IsPoliticallyExposedPerson	boolean	Whether applicant is politically exposed.
Applicants.IndividualDetails.PepDetails	string	If applicant is politically exposed, details must be supplied.
Accounts	array	Array of accounts to be opened with the application. Must be linked to an included applicant.
Accounts.Name	string	Account name.
Accounts.RegisteredName	string	Account registered name.
Accounts.ShortName	string	Account short name.
Accounts.AccountTyperequired		Isa = 0.
Accounts.PdsId	string	PDS ID of account.
Accounts.Fees	array	Account fees.
Accounts.Fees.Id	string	Fee Id.
Accounts.Fees.Rate	double	Fee rate.
Accounts.Fees.Unit	string	Fee unit, dollars or percentage.
Accounts.Fees.Type	string	Fee type.
Accounts.Models	array	Account models.
Accounts.Models.Code	string	Model code.
Accounts.Models.Proportion	double	Proportion of model.
Accounts.BankAccounts	array	Bank accounts.
Accounts.BankAccounts.SortCode	string	Bank account sort code.
Accounts.BankAccounts.AccountNumber	string	Bank account number.
Accounts.BankAccounts.AccountName	string	Bank account name.
Accounts.BankAccounts.Bic	string	Bank Identifier Code (BIC) of your banking institution.
Accounts.BankAccounts.Iban	string	International Bank Account Number (IBAN) of your banking institution.
Accounts.BankAccounts.RoutingNumber	string	Routing number of banking institution.
Accounts.Exclusions	array	Account exclusions.
Accounts.Exclusions.Security	object	Security code of the exclusion.
Accounts.Exclusions.Security.Code	string	Security code of the security.
Accounts.Exclusions.Security.Exchange	string	Exchange code of the security.
Accounts.InitialInvestment	object	Initial investment of account.
Accounts.InitialInvestment.Cash	double	Select if the initial investment will include cash.
Accounts.InitialInvestment.Shares	double	Select if the initial investment will include shares.
Accounts.InitialInvestment.Methodrequired	enum	BPay = 0, DirectDebit = 1, ElectronicTransfer = 2, Cheque = 3.
Accounts.SourceOfFunds	string	Contribution source.
Accounts.OngoingFeeAmount	double	Ongoing fee amount.
Accounts.ReinvestIncome	boolean	Reinvest income.
Accounts.ProductId	string	Product Id.
Accounts.ProductProviderReference	string	Product provider reference.
Accounts.RegularContribution		Regular cash contributions to the account.
Accounts.RegularWithdrawal		Regular cash withdrawals from the account.
Accounts.OwnerAdviserId	integer	Owner Adviser Id.
Accounts.Region	enum	Region.
Accounts.CurrencyCode	string	The currency code of the account.
Accounts.AdviserReference	string
Accounts.InSpecieCashStockTransfers	array
Accounts.InSpecieCashStockTransfers.TransferTyperequired	enum	StockAndCash = 0, CashOnly = 1.
Accounts.InSpecieCashStockTransfers.CedingPartyId	string
Accounts.InSpecieCashStockTransfers.CedingAccountNumber	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails	array
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.SecurityIsinrequired	string
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.Quantity	double
Accounts.InSpecieCashStockTransfers.InSpecieCashStockTransferDetails.BookCost	double
Accounts.InSpecieCashStockTransfers.CashTransferAmount	double
Accounts.InSpecieCashStockTransfers.AmountUsedThisYear	double
Accounts.InSpecieCashStockTransfers.FeeAmount	double
Accounts.InSpecieCashStockTransfers.FeePercent	double
Accounts.IsTradeFreezeOn	boolean
Accounts.TradeFreezeReason	enum	TransferIn = 0, TransferOut = 1, Incident = 2, Deceased = 3, RemovalOfAdviser = 4, AdviserInstructed = 5, Bespoke = 6.
Accounts.TradeFreezeNote	string
Accounts.IllustrationData	object
Accounts.IllustrationData.CostsAndCharges	array
Accounts.IllustrationData.CostsAndCharges.Type	enum	OneOffCharges = 0, OngoingCharges = 1, TransactionCharges = 2, IncidentalCharges = 3, ThirdPartyPayment = 4.
Accounts.IllustrationData.CostsAndCharges.Amount	double

Response Examples

# 200 - OK
{
  "ApplicationId": "c1bdac67-39a0-4835-8168-e99f44f01iu7"
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Application Id.

GET Application Status

Definition: https://api.onpraemium.com/api/application/{ApplicationId}/status

This endpoint returns the status of the application. This can be used to check which state an application is in, and the awaiting action.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameters - Path Examples

ApplicationId: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

Request Parameters - Path

Parameter	Type	Description
ApplicationIdrequired	string

Response Examples

# 200 - OK
{
  "ApplicationId": "83225a21-1e9e-9ty1-b35a-6f1091c7a434",
  "Status": "Submitted",
  "AccountsStatus": [
    {
      "AccountCode": "SMA00400000",
      "Status": "ClosureRequested"
    }
  ]
}

Response Parameters

Parameter	Type	Description
ApplicationId	string	Unique ApplicationID to be used as an application reference.
Status	string	Draft / Submitted.
AccountsStatus	array	Refer to endpoint description.
AccountsStatus.AccountCode	string	Portfolio ID.
AccountsStatus.Status	enum	Draft = 0, AwaitingSignature = 1, AwaitingApproval = 2, AwaitingFund = 3, Funded = 4, Trading = 5, ClosureRequested = 6, Closed = 7, Deleted = 8.

App Form

GET App Form

Definition: https://api.onpraemium.com/api/appform

This endpoint returns a PDF version of the application form for the specified account. This is a confirmation to the client of the details of their account. The PDF is returned as a base64 encoded string.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Query Examples

AccountId: AU400000
Recipient: 0
FormType: 0

Request Parameter - Query

Parameter	Type	Description
AccountIdrequired	string
Recipient	enum	Adviser = 0, Investor = 1 (UK only)
FormType	enum	Digital = 0, Paper = 1 (UK only)

Account Model Weightings

GET Account Model Weightings

Definition: https://api.onpraemium.com/api/accountmodelweightings

This endpoint returns the account model weightings for the account.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Query Examples

AccountId: AU400000

Request Parameter - Query

Parameter	Type	Description
AccountIdrequired	string

Response Examples

# 200 - OK
[
  {
    "ModelCode": "MACAUD",
    "Percent": 100.0
  }
]

Response Parameters

Parameter	Type	Description
ModelCode	string	Model code.
Percent	double	Model percent.

PUT Account Model Weightings

Definition: https://api.onpraemium.com/api/accountmodelweightings

This endpoint allows you to modify the account model weightings for the account.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "AccountId": "AU400000",
  "AccountModelWeightings": [
    {
      "ModelCode": "MACAUD",
      "Percent": 100
    }    
  ]
}

Request Parameter - Body

Parameter	Type	Description
AccountIdrequired	string	Account Id.
RebalanceTyperequired	enum	Floating = 0, Fixed = 1.
AccountModelWeightingsrequired	array	Account Model Weightings.
AccountModelWeightings.ModelCode	string	Model code.
AccountModelWeightings.Percent	double	Model percent.

Definition: https://api.onpraemium.com/api/ssologin

This endpoint is to authenticate a user's access to the Praemium API. It returns a URL that contains a one-time security token. By accessing this URL, an authenticated user will be logged in without having to specify the user's credentials again.
Either UserId or Username is required.
Parameters are used to pass in additional data for certain applications. The following parameters are valid for Platform & Reporting:
- AccountID is the internal ID of the account to be selected when the user is logged in.
- AreaID is an ID to determine which page the user will load initially (e.g. 103 - Transaction History, 1171 - Reporting).
- Frameless is an option to determine whether or not the menu and logo are hidden.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Body Examples

{
  "UserId": 1234,
  "Application": "Platform"
}

Request Parameter - Body

Parameter	Type	Description
Applicationrequired	string	The ID of the application the user will be sent to once logged in. Platform=V-Wrap, Investor=Investor Portal, Adviser=Adviser Portal, Applications=Application Portal.
UserIdrequired	integer	The ID of the user to log in. Either UserId or Username is required.

Response Examples

# 200 - OK
{
  "SsoUrl": "https://login.onpraemium.com/useraccount/sso?token=XXXXXX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-XXXXXXXXXXXXXXXXXX"
}

Response Parameters

Parameter	Type	Description
SsoUrl	string	SSO url

Users

GET User

Definition: https://api.onpraemium.com/api/user/{username}

This endpoint returns the user links for the account.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameters - Path Examples

UserName: john_smith

Request Parameters - Path

Parameter	Type	Description
UserNamerequired	string

Response Examples

# 200 - OK
{
  "UserId": 123456
}

Response Parameters

Parameter	Type	Description
UserId	integer	User ID.

Ceding Parties

GET Ceding Parties

Definition: https://api.onpraemium.com/api/cedingparties

This endpoint returns the ceding parties details for the service.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Query Examples

AccountType: 15
Search: ROC

Request Parameter - Query

Parameter	Type	Description
AccountType	enum	Isa = 15, Gia = 16.
Searchrequired	string

Response Examples

# 200 - OK (AU response)
[
  {
    "CedingPartyId": "UK1",
    "CedingPartyName": "Test Ceding Party",
    "AcceptsElectronicTransfer": true
  }
]

Response Parameters

Parameter	Type	Description
CedingPartyId	string	Ceding party Id.
CedingPartyName	string	Ceding party name.
AcceptsElectronicTransfer	boolean	Ceding party accepts electronic transfers.

Securities

GET Securities

Definition: https://api.onpraemium.com/api/securities

This endpoint returns the securties details for the service.

Header Examples

Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImt...
x-pps-subscription-key: d3e30ecd1ab345...
x-pps-api-version: v1

Header Parameters

Parameter	Type	Description
Authorizationrequired	string	OAuth 2.0 access token.
x-pps-subscription-keyrequired	string	Product subscription key.
x-pps-api-versionrequired	string	API version of the endpoint.

Request Parameter - Query Examples

Search: BHP
PdsId: AU123
ExchangeType: 1
AllowInternational: true

Request Parameter - Query

Parameter	Type	Description
Searchrequired	string
ExchangeType	enum	Share = 1, Fund = 2.
PdsIdrequired	string
AllowInternational	boolean

Response Examples

# 200 - OK (AU response)
[
  {
    "Id": "AU94",
    "Code": "BHP",
    "Description": "BHP GROUP LIMITED FPO",
    "Exchange": "ASX",
    "IsAllowedByApl": true
  }
]

# 200 - OK (UK response)
[
  {
    "Id": "UK1000000993",
    "Code": "ROC",
    "Description": "ROC OIL CO LTD NPV",
    "ISIN": "AU000000ROC4",
    "Exchange": "LON"
  }
]

Response Parameters

Parameter	Type	Description
Id	string	Security Id.
Code	string	Security code.
Description	string	Description.
ISIN	string	ISIN of security code.
Exchange	string	Exchange of security.
IsAllowedByApl	boolean	Is the security allowed by the Approved Product List.

Rate Limiting

The Praemium API limits requests made to each Praemium service.

The default is 1000 requests per minute, if you hit the limit the API will return HTTP code 429 (Too many requests). If you genuinely need to make more requests, please speak to our support team.

Response Codes

The Praemium API communicates errors through standard HTTP status codes paired. Generally the following pattern will apply:

400 - Bad Request

{
  "Message": "Unexpected character encountered while parsing value: d. Path 'AccountId', line 2, position 23."
}

Next Steps

To get started with the Praemium API, you need to first gain access.

If you are an existing customer, please connect contact with your local relationship manager or support team.

If you are new to Praemium, either as an Advice firm, investment manager or entrepreneur seeking to build a product atop of our platform – please get in touch via the contact page.

The process for gaining access is as follows:

1.) Contact your relationship manager or sales/support team, who will provide you a terms of use document

2.) On acceptance of the terms, a login will be created that allows you to access our Test API and more detailed documentation relevant to your type of subscription

3.) After your successful development and testing, you will be granted access to the Live environment

Introduction

Versioning

Specifying a Version

Product Subscription

Authorisation

POST Access Token

Header Parameters

Request Parameter - Body

Response Parameters

PDS

GET PDS

Header Parameters

Response Parameters

Applications

POST Individual Applicant & Individual Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Corporate Applicant & Company Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & Trust Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Corporate Applicant & Company Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & SuperSMA Accumulation Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & SuperSMA Account-Based-Pensions Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & SuperSMA Transition-To-Retirement Account - AU

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & GIA Account - UK

Header Parameters

Request Parameter - Body

Response Parameters

POST Corporate Applicant & GIA Account - UK

Header Parameters

Request Parameter - Body

Response Parameters

POST Trust Applicant & GIA Account - UK

Header Parameters

Request Parameter - Body

Response Parameters

POST Individual Applicant & ISA Account - UK

Header Parameters

Request Parameter - Body

Response Parameters

GET Application Status

Header Parameters

Request Parameters - Path

Response Parameters

App Form

GET App Form

Header Parameters

Request Parameter - Query

Account Model Weightings

GET Account Model Weightings

Header Parameters

Request Parameter - Query

Response Parameters

PUT Account Model Weightings

Header Parameters

Request Parameter - Body

SSO Login

POST SSO Login

Header Parameters

Request Parameter - Body

Response Parameters

Users