POST Sale/NewCustomer

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ServiceUsername	string	Required
ServicePassword	string	Required
ProspectCode	integer	Required
DateOfBirth	date	None.
State	string	None.
Occupation	string	None.
MotherMaidenName	string	None.
AccountName	string	None.
NameOfBank	string	None.
AccountNumber	string	None.
NextOfKin	string	None.
NokRelationship	string	None.
NokPhone	string	None.
PassportUpload	string	None.
SignatureUpload	string	None.
ThumbUpload	string	None.
IdentificationUpload	string	None.
UtilityUpload	string	None.
OtherProducts	string	None.
DivendedReinvestment	boolean	None.
SetupDirectDebit	boolean	None.
DocumentComplete	boolean	None.
ThirdPartyRedemptionIndemity	boolean	None.
Nationality	string	None.
Jurisdiction	string	None.
UsTaxNumber	string	None.
PepInfo	string	None.
OrderPayment	OrderPayment	None.
OrderItems	Collection of OrderItem	None.

Request Formats

application/json, text/json

Sample:

{
  "ThirdPartyRedemptionIndemity": true,
  "DocumentComplete": true,
  "SetupDirectDebit": true,
  "DivendedReinvestment": true,
  "ProspectCode": 3,
  "OrderPayment": {
    "Amount": 4,
    "PaymentDate": "2025-11-01T19:28:56.607386Z",
    "ReceiptNo": "sample string 6",
    "PaymentChannel": "sample string 5",
    "PaymentLogId": "sample string 3",
    "PaymentReference": "sample string 2",
    "PaymentMethod": "sample string 1"
  },
  "OrderItems": [
    {
      "ItemAmount": 4,
      "PassportUploadMinor": "sample string 9",
      "ThumbUploadJoint": "sample string 8",
      "SignatureUploadJoint": "sample string 7",
      "JointOtherNames": "sample string 6",
      "JointSurname": "sample string 5",
      "ItemCode": "sample string 3",
      "ItemName": "sample string 2",
      "AccountType": "sample string 1"
    },
    {
      "ItemAmount": 4,
      "PassportUploadMinor": "sample string 9",
      "ThumbUploadJoint": "sample string 8",
      "SignatureUploadJoint": "sample string 7",
      "JointOtherNames": "sample string 6",
      "JointSurname": "sample string 5",
      "ItemCode": "sample string 3",
      "ItemName": "sample string 2",
      "AccountType": "sample string 1"
    }
  ],
  "DateOfBirth": "2025-11-01T19:28:56.6043884Z",
  "PepInfo": "sample string 26",
  "UsTaxNumber": "sample string 25",
  "Jurisdiction": "sample string 24",
  "Nationality": "sample string 23",
  "OtherProducts": "sample string 18",
  "UtilityUpload": "sample string 17",
  "IdentificationUpload": "sample string 16",
  "ThumbUpload": "sample string 15",
  "SignatureUpload": "sample string 14",
  "PassportUpload": "sample string 13",
  "NokPhone": "sample string 12",
  "NokRelationship": "sample string 11",
  "NextOfKin": "sample string 10",
  "AccountNumber": "sample string 9",
  "NameOfBank": "sample string 8",
  "AccountName": "sample string 7",
  "MotherMaidenName": "sample string 6",
  "Occupation": "sample string 5",
  "State": "sample string 4",
  "ServicePassword": "sample string 2",
  "ServiceUsername": "sample string 1"
}

application/xml, text/xml

Sample:

<NewCustomerRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceUsername>sample string 1</ServiceUsername>
  <ServicePassword>sample string 2</ServicePassword>
  <ProspectCode>3</ProspectCode>
  <DateOfBirth>2025-11-01T20:28:56.6043884+01:00</DateOfBirth>
  <State>sample string 4</State>
  <Occupation>sample string 5</Occupation>
  <MotherMaidenName>sample string 6</MotherMaidenName>
  <AccountName>sample string 7</AccountName>
  <NameOfBank>sample string 8</NameOfBank>
  <AccountNumber>sample string 9</AccountNumber>
  <NextOfKin>sample string 10</NextOfKin>
  <NokRelationship>sample string 11</NokRelationship>
  <NokPhone>sample string 12</NokPhone>
  <PassportUpload>sample string 13</PassportUpload>
  <SignatureUpload>sample string 14</SignatureUpload>
  <ThumbUpload>sample string 15</ThumbUpload>
  <IdentificationUpload>sample string 16</IdentificationUpload>
  <UtilityUpload>sample string 17</UtilityUpload>
  <OtherProducts>sample string 18</OtherProducts>
  <DivendedReinvestment>true</DivendedReinvestment>
  <SetupDirectDebit>true</SetupDirectDebit>
  <DocumentComplete>true</DocumentComplete>
  <ThirdPartyRedemptionIndemity>true</ThirdPartyRedemptionIndemity>
  <Nationality>sample string 23</Nationality>
  <Jurisdiction>sample string 24</Jurisdiction>
  <UsTaxNumber>sample string 25</UsTaxNumber>
  <PepInfo>sample string 26</PepInfo>
  <OrderPayment>
    <PaymentMethod>sample string 1</PaymentMethod>
    <PaymentReference>sample string 2</PaymentReference>
    <PaymentLogId>sample string 3</PaymentLogId>
    <Amount>4</Amount>
    <PaymentChannel>sample string 5</PaymentChannel>
    <PaymentDate>2025-11-01T20:28:56.607386+01:00</PaymentDate>
    <ReceiptNo>sample string 6</ReceiptNo>
  </OrderPayment>
  <OrderItems>
    <OrderItem>
      <AccountType>sample string 1</AccountType>
      <ItemName>sample string 2</ItemName>
      <ItemCode>sample string 3</ItemCode>
      <ItemAmount>4</ItemAmount>
      <JointSurname>sample string 5</JointSurname>
      <JointOtherNames>sample string 6</JointOtherNames>
      <SignatureUploadJoint>sample string 7</SignatureUploadJoint>
      <ThumbUploadJoint>sample string 8</ThumbUploadJoint>
      <PassportUploadMinor>sample string 9</PassportUploadMinor>
    </OrderItem>
    <OrderItem>
      <AccountType>sample string 1</AccountType>
      <ItemName>sample string 2</ItemName>
      <ItemCode>sample string 3</ItemCode>
      <ItemAmount>4</ItemAmount>
      <JointSurname>sample string 5</JointSurname>
      <JointOtherNames>sample string 6</JointOtherNames>
      <SignatureUploadJoint>sample string 7</SignatureUploadJoint>
      <ThumbUploadJoint>sample string 8</ThumbUploadJoint>
      <PassportUploadMinor>sample string 9</PassportUploadMinor>
    </OrderItem>
  </OrderItems>
</NewCustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

NewCustomerResponse

Name	Type	Additional information
PaymentLogId	string	None.
Status	integer	None.
StatusMessage	string	None.
MembershipNumber	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "MembershipNumber": 4,
  "Status": 2,
  "StatusMessage": "sample string 3",
  "PaymentLogId": "sample string 1"
}

application/xml, text/xml

Sample:

<NewCustomerResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PaymentLogId>sample string 1</PaymentLogId>
  <Status>2</Status>
  <StatusMessage>sample string 3</StatusMessage>
  <MembershipNumber>4</MembershipNumber>
</NewCustomerResponse>