POST api/Clients

Create Client in the database

Request Information

URI Parameters

None.

Body Parameters

client_obj
NameDescriptionTypeAdditional information
trader

string

None.

cold_caller

string

None.

type

string

None.

name

string

None.

address1

string

String length: inclusive between 0 and 200

address2

string

String length: inclusive between 0 and 200

address3

string

String length: inclusive between 0 and 200

postcode

string

String length: inclusive between 0 and 200

city

string

String length: inclusive between 0 and 50

country

string

None.

fax

string

String length: inclusive between 0 and 50

switchboard

string

String length: inclusive between 0 and 50

comment

string

None.

company_number

string

String length: inclusive between 0 and 200

company_sic

string

String length: inclusive between 0 and 30

web

string

String length: inclusive between 0 and 500

email

string

String length: inclusive between 0 and 100

trader_commission

string

None.

cold_caller_commission

string

None.

web_commission

string

None.

ip

string

None.

kyc_nature

string

String length: inclusive between 0 and 150

kyc_avg_volume

string

None.

kyc_annual_volume

string

None.

kyc_frequency

string

None.

countries_of_interest_beneficiaries

Collection of string

None.

countries_of_interest_remitters

Collection of string

None.

currency_of_interest

Collection of string

None.

expiry_date

string

None.

regulator_name

string

None.

source

string

None.

reason

string

String length: inclusive between 0 and 150

kyc_max_volume

string

None.

kyc_ccy

string

None.

country_of_incorporation

string

None.

legal_status

string

None.

company_vat

string

None.

trading_as_name

string

String length: inclusive between 0 and 500

trading_country

string

None.

trading_address1

string

String length: inclusive between 0 and 500

trading_address2

string

String length: inclusive between 0 and 500

trading_address3

string

String length: inclusive between 0 and 500

trading_city

string

String length: inclusive between 0 and 500

trading_postcode

string

String length: inclusive between 0 and 500

referer

string

None.

activity

string

None.

kyc_source_of_wealth

string

None.

kyc_source

string

None.

kyc_relationship_with_beneficiaries

string

None.

agree_marketing_conditions

integer

None.

agree_marketing_conditions_affiliate

integer

None.

group_industry

string

None.

sid

string

None.

unsubscribe_emails

string

None.

affiliate_campaign

string

None.

affiliate_reference

string

None.

kyc_json

string

None.

language

string

None.

non_uk_shareholder

string

None.

contact_list

Collection of contacts_obj

None.

invoiceable_charges

boolean

None.

disable_charges

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "trader": "sample string 1",
  "cold_caller": "sample string 2",
  "type": "sample string 3",
  "name": "sample string 4",
  "address1": "sample string 5",
  "address2": "sample string 6",
  "address3": "sample string 7",
  "postcode": "sample string 8",
  "city": "sample string 9",
  "country": "sample string 10",
  "fax": "sample string 11",
  "switchboard": "sample string 12",
  "comment": "sample string 13",
  "company_number": "sample string 14",
  "company_sic": "sample string 15",
  "web": "sample string 16",
  "email": "sample string 17",
  "trader_commission": "sample string 18",
  "cold_caller_commission": "sample string 19",
  "web_commission": "sample string 20",
  "ip": "sample string 21",
  "kyc_nature": "sample string 22",
  "kyc_avg_volume": "sample string 23",
  "kyc_annual_volume": "sample string 24",
  "kyc_frequency": "sample string 25",
  "countries_of_interest_beneficiaries": [
    "sample string 1",
    "sample string 2"
  ],
  "countries_of_interest_remitters": [
    "sample string 1",
    "sample string 2"
  ],
  "currency_of_interest": [
    "sample string 1",
    "sample string 2"
  ],
  "expiry_date": "sample string 26",
  "regulator_name": "sample string 27",
  "source": "sample string 28",
  "reason": "sample string 29",
  "kyc_max_volume": "sample string 30",
  "kyc_ccy": "sample string 31",
  "country_of_incorporation": "sample string 32",
  "legal_status": "sample string 33",
  "company_vat": "sample string 34",
  "trading_as_name": "sample string 35",
  "trading_country": "sample string 36",
  "trading_address1": "sample string 37",
  "trading_address2": "sample string 38",
  "trading_address3": "sample string 39",
  "trading_city": "sample string 40",
  "trading_postcode": "sample string 41",
  "referer": "sample string 42",
  "activity": "sample string 43",
  "kyc_source_of_wealth": "sample string 44",
  "kyc_source": "sample string 45",
  "kyc_relationship_with_beneficiaries": "sample string 46",
  "agree_marketing_conditions": 47,
  "agree_marketing_conditions_affiliate": 48,
  "group_industry": "sample string 49",
  "sid": "sample string 50",
  "unsubscribe_emails": "sample string 51",
  "affiliate_campaign": "sample string 52",
  "affiliate_reference": "sample string 53",
  "kyc_json": "sample string 54",
  "language": "sample string 55",
  "non_uk_shareholder": "sample string 56",
  "contact_list": [
    {
      "first_name": "sample string 1",
      "middle_name": "sample string 2",
      "job_title": "sample string 3",
      "last_name": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "city": "sample string 8",
      "country": "sample string 9",
      "date_of_birth": "sample string 10",
      "email": "sample string 11",
      "fax": "sample string 12",
      "mobile_phone": "sample string 13",
      "nationality": "sample string 14",
      "post_code": "sample string 15",
      "telephone": "sample string 16",
      "title": "sample string 17",
      "web": "sample string 18"
    },
    {
      "first_name": "sample string 1",
      "middle_name": "sample string 2",
      "job_title": "sample string 3",
      "last_name": "sample string 4",
      "address1": "sample string 5",
      "address2": "sample string 6",
      "address3": "sample string 7",
      "city": "sample string 8",
      "country": "sample string 9",
      "date_of_birth": "sample string 10",
      "email": "sample string 11",
      "fax": "sample string 12",
      "mobile_phone": "sample string 13",
      "nationality": "sample string 14",
      "post_code": "sample string 15",
      "telephone": "sample string 16",
      "title": "sample string 17",
      "web": "sample string 18"
    }
  ],
  "invoiceable_charges": true,
  "disable_charges": true
}

application/xml, text/xml

Sample:
<client_obj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FXOPS_API">
  <activity>sample string 43</activity>
  <address1>sample string 5</address1>
  <address2>sample string 6</address2>
  <address3>sample string 7</address3>
  <affiliate_campaign>sample string 52</affiliate_campaign>
  <affiliate_reference>sample string 53</affiliate_reference>
  <agree_marketing_conditions>47</agree_marketing_conditions>
  <agree_marketing_conditions_affiliate>48</agree_marketing_conditions_affiliate>
  <city>sample string 9</city>
  <cold_caller>sample string 2</cold_caller>
  <cold_caller_commission>sample string 19</cold_caller_commission>
  <comment>sample string 13</comment>
  <company_number>sample string 14</company_number>
  <company_sic>sample string 15</company_sic>
  <company_vat>sample string 34</company_vat>
  <contact_list>
    <contacts_obj>
      <address1>sample string 5</address1>
      <address2>sample string 6</address2>
      <address3>sample string 7</address3>
      <city>sample string 8</city>
      <country>sample string 9</country>
      <date_of_birth>sample string 10</date_of_birth>
      <email>sample string 11</email>
      <fax>sample string 12</fax>
      <first_name>sample string 1</first_name>
      <job_title>sample string 3</job_title>
      <last_name>sample string 4</last_name>
      <middle_name>sample string 2</middle_name>
      <mobile_phone>sample string 13</mobile_phone>
      <nationality>sample string 14</nationality>
      <post_code>sample string 15</post_code>
      <telephone>sample string 16</telephone>
      <title>sample string 17</title>
      <web>sample string 18</web>
    </contacts_obj>
    <contacts_obj>
      <address1>sample string 5</address1>
      <address2>sample string 6</address2>
      <address3>sample string 7</address3>
      <city>sample string 8</city>
      <country>sample string 9</country>
      <date_of_birth>sample string 10</date_of_birth>
      <email>sample string 11</email>
      <fax>sample string 12</fax>
      <first_name>sample string 1</first_name>
      <job_title>sample string 3</job_title>
      <last_name>sample string 4</last_name>
      <middle_name>sample string 2</middle_name>
      <mobile_phone>sample string 13</mobile_phone>
      <nationality>sample string 14</nationality>
      <post_code>sample string 15</post_code>
      <telephone>sample string 16</telephone>
      <title>sample string 17</title>
      <web>sample string 18</web>
    </contacts_obj>
  </contact_list>
  <countries_of_interest_beneficiaries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </countries_of_interest_beneficiaries>
  <countries_of_interest_remitters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </countries_of_interest_remitters>
  <country>sample string 10</country>
  <country_of_incorporation>sample string 32</country_of_incorporation>
  <currency_of_interest xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </currency_of_interest>
  <disable_charges>true</disable_charges>
  <email>sample string 17</email>
  <expiry_date>sample string 26</expiry_date>
  <fax>sample string 11</fax>
  <group_industry>sample string 49</group_industry>
  <invoiceable_charges>true</invoiceable_charges>
  <ip>sample string 21</ip>
  <kyc_annual_volume>sample string 24</kyc_annual_volume>
  <kyc_avg_volume>sample string 23</kyc_avg_volume>
  <kyc_ccy>sample string 31</kyc_ccy>
  <kyc_frequency>sample string 25</kyc_frequency>
  <kyc_json>sample string 54</kyc_json>
  <kyc_max_volume>sample string 30</kyc_max_volume>
  <kyc_nature>sample string 22</kyc_nature>
  <kyc_relationship_with_beneficiaries>sample string 46</kyc_relationship_with_beneficiaries>
  <kyc_source>sample string 45</kyc_source>
  <kyc_source_of_wealth>sample string 44</kyc_source_of_wealth>
  <language>sample string 55</language>
  <legal_status>sample string 33</legal_status>
  <name>sample string 4</name>
  <non_uk_shareholder>sample string 56</non_uk_shareholder>
  <postcode>sample string 8</postcode>
  <reason>sample string 29</reason>
  <referer>sample string 42</referer>
  <regulator_name>sample string 27</regulator_name>
  <sid>sample string 50</sid>
  <source>sample string 28</source>
  <switchboard>sample string 12</switchboard>
  <trader>sample string 1</trader>
  <trader_commission>sample string 18</trader_commission>
  <trading_address1>sample string 37</trading_address1>
  <trading_address2>sample string 38</trading_address2>
  <trading_address3>sample string 39</trading_address3>
  <trading_as_name>sample string 35</trading_as_name>
  <trading_city>sample string 40</trading_city>
  <trading_country>sample string 36</trading_country>
  <trading_postcode>sample string 41</trading_postcode>
  <type>sample string 3</type>
  <unsubscribe_emails>sample string 51</unsubscribe_emails>
  <web>sample string 16</web>
  <web_commission>sample string 20</web_commission>
</client_obj>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'client_obj'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.