POST api/person/client-person

Create new person account

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
BrandID	Brand ID of new person	integer	Required
Username	Username for new person. Required for persons that are to access via TPP websites	string	None.
Salutation	Salutation of new person. Mandatory unless agreed upon with TPP	Salutation	None.
FirstName	First name of new person	string	Required
LastName	Last name of new person	string	Required
DOB	Date of Birth. Unless agreed with TPP, this field is required for both client and adviser persons	Date	None.
Email	Email address.	string	None.
Phonemobile	Mobile phone number. Unless agreed with TPP, one of Phonemobile, Phonehome or Phonework is required for both client and adviser persons	string	None.
Phonehome	Home phone number. Unless agreed with TPP, one of Phonemobile, Phonehome or Phonework is required for both client and adviser persons	string	None.
Phonework	Work phone number. Unless agreed with TPP, one of Phonemobile, Phonehome or Phonework is required for both client and adviser persons	string	None.
Fax	Fax number.	string	None.
ContactPreference	Person's contact preference. Unless agreed with TPP, this field is required for both client and adviser persons	enContactPreference	None.
TFN	Tax file number	string	String length: inclusive between 0 and 24
TFNExemptionType	Tax file number exemption reason if no tax file number	enTaxExemptionCode	None.
PhonePassword	Password used to identify person over the phone. Unless agreed with TPP, this field is required for client persons but is not required for adviser persons	string	None.
ResidentialAddress	Home address. Destination of posted contract notes, if Postal Address not supplied.	Address	None.
PostalAddress	Postal address. Destination of posted contract notes.	Address	None.
IdentificationType	Identification type for person. Unless agreed with TPP, this field is required for both client and adviser persons	enIdentificationType	None.
Identification	Identification value. Unless agreed with TPP, this field is required for both client and adviser persons	string	None.
IdentificationStateOfIssue	Issue state. Mandatory where IdentificationType is DriverLicense and "DL card number required" setting is active on the person brand.	enIdentificationStateOfIssue	None.
IdentificationCardNo	Card number. Mandatory where IdentificationType is DriverLicense and "DL card number required" setting is active on the person brand and state of issue matches against the states selected in the platform setting.	string	None.
Employer	Employer name	string	None.
Occupation	Occupation of person	string	None.
Externalreference	Reference used to identify the person in an external system.	string	None.
FATCACRS	Details of foreign tax residences for accounts of individual and joint persons	Collection of FATCACountryDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "BrandID": 1,
  "Username": "johnsmith",
  "Salutation": "Mr",
  "FirstName": "John",
  "LastName": "Smith",
  "DOB": "1990-2-7",
  "Email": "johnsmith@sample.com",
  "Phonemobile": "0418 888 999",
  "Phonehome": "",
  "Phonework": "",
  "Fax": "",
  "ContactPreference": 4,
  "TFN": "81854402",
  "TFNExemptionType": null,
  "PhonePassword": "1234",
  "ResidentialAddress": {
    "Address1": "TPP PTY LTD,",
    "Address2": "LEVEL 20",
    "Address3": "GOVERNOR PHILIP TOWER",
    "Address4": "1 FARRER PLACE",
    "Suburb": "SYDNEY",
    "State": "NSW",
    "Postcode": "2000",
    "Country": "AUSTRALIA"
  },
  "PostalAddress": null,
  "IdentificationType": 1,
  "Identification": "123123A",
  "IdentificationStateOfIssue": 1,
  "IdentificationCardNo": "487596",
  "Employer": "TPP",
  "Occupation": "QA Engineer",
  "Externalreference": "125930",
  "FATCACRS": [
    {
      "Country": "AUS",
      "TIN": "123456",
      "TINExemption": null
    },
    {
      "Country": "USA",
      "TIN": null,
      "TINExemption": 3
    },
    {
      "Country": "GBR",
      "TIN": null,
      "TINExemption": 2
    }
  ]
}

application/xml, text/xml

Sample:

<ClientPersonCreation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Person">
  <BrandID>1</BrandID>
  <ContactPreference>EmailAddress</ContactPreference>
  <DOB xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.Utilities" />
  <Email>johnsmith@sample.com</Email>
  <Employer>TPP</Employer>
  <Externalreference>125930</Externalreference>
  <FATCACRS xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
    <d2p1:FATCACountryDetail>
      <d2p1:Country>AUS</d2p1:Country>
      <d2p1:TIN>123456</d2p1:TIN>
      <d2p1:TINExemption i:nil="true" />
    </d2p1:FATCACountryDetail>
    <d2p1:FATCACountryDetail>
      <d2p1:Country>USA</d2p1:Country>
      <d2p1:TIN i:nil="true" />
      <d2p1:TINExemption>CountryNotRequireTIN</d2p1:TINExemption>
    </d2p1:FATCACountryDetail>
    <d2p1:FATCACountryDetail>
      <d2p1:Country>GBR</d2p1:Country>
      <d2p1:TIN i:nil="true" />
      <d2p1:TINExemption>IndividualNotIssuedTIN</d2p1:TINExemption>
    </d2p1:FATCACountryDetail>
  </FATCACRS>
  <Fax></Fax>
  <FirstName>John</FirstName>
  <Identification>123123A</Identification>
  <IdentificationCardNo>487596</IdentificationCardNo>
  <IdentificationStateOfIssue>NSW</IdentificationStateOfIssue>
  <IdentificationType>DriverLicence</IdentificationType>
  <LastName>Smith</LastName>
  <Occupation>QA Engineer</Occupation>
  <PhonePassword>1234</PhonePassword>
  <Phonehome></Phonehome>
  <Phonemobile>0418 888 999</Phonemobile>
  <Phonework></Phonework>
  <PostalAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account" i:nil="true" />
  <ResidentialAddress xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Account">
    <d2p1:Address1>TPP PTY LTD,</d2p1:Address1>
    <d2p1:Address2>LEVEL 20</d2p1:Address2>
    <d2p1:Address3>GOVERNOR PHILIP TOWER</d2p1:Address3>
    <d2p1:Address4>1 FARRER PLACE</d2p1:Address4>
    <d2p1:Country>AUSTRALIA</d2p1:Country>
    <d2p1:Postcode>2000</d2p1:Postcode>
    <d2p1:State>NSW</d2p1:State>
    <d2p1:Suburb>SYDNEY</d2p1:Suburb>
  </ResidentialAddress>
  <Salutation xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Utilities" />
  <TFN>81854402</TFN>
  <TFNExemptionType i:nil="true" />
  <Username>johnsmith</Username>
</ClientPersonCreation>

Response Information

Resource Description

New Person ID and Activation URL

ClientPersonCreationResult

Name	Description	Type	Additional information
PersonID	Person ID created	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "PersonID": 12345
}

application/xml, text/xml

Sample:

<ClientPersonCreationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contract.Person">
  <PersonID>12345</PersonID>
</ClientPersonCreationResult>

Error Response Information

Resource Description

New Person ID and Activation URL

BadRequestResult

Name	Description	Type	Additional information
Errors		Collection of Error	None.

Error Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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