FxHubPartnersApi

FormsDownload

The following routes are available for this service:
All Verbs	/forms_download

**FormsDownload** Parameters:
Name	Parameter	Data Type	Required
FormType	query	string	No
Id	query	int	No
RetailClient	query	RetailClient	No

**RetailClient** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
PartnerId	form	int	No
PartnerIds	form	List<int>	No
PartnerName	form	string	No
ClientType	form	string	No
FirstName	form	string	No
MiddleName	form	string	No
LastName	form	string	No
FullNames	form	string	No
FirstLastName	form	string	No
Title	form	string	No
Gender	form	string	No
Race	form	string	No
ResidencyStatus	form	string	No
TaxRefNumber	form	string	No
IdNumber	form	string	No
DateOfBirth	form	DateTime?	No
PlaceOfBirth	form	string	No
Nationality	form	string	No
CountryOfResidence	form	string	No
PassportNumber	form	string	No
PassportIssueDate	form	DateTime?	No
PassportExpiryDate	form	DateTime?	No
PassportCountry	form	string	No
TempResNumber	form	string	No
TempResDate	form	string	No
EmailAddress	form	string	No
ContactNumber1	form	string	No
ContactNumber2	form	string	No
ContactNumber3	form	string	No
Address	form	string	No
Suburb	form	string	No
City	form	string	No
Province	form	string	No
PostalCode	form	string	No
Country	form	string	No
PostalSameAsStreet	form	bool?	No
PostalAddress	form	string	No
PostalSuburb	form	string	No
PostalCity	form	string	No
PostalProvince	form	string	No
PostalPostalCode	form	string	No
PostalCountry	form	string	No
IsSoleProprietor	form	bool?	No
TradingSameAsStreet	form	bool?	No
TradingAddress	form	string	No
TradingSuburb	form	string	No
TradingCity	form	string	No
TradingProvince	form	string	No
TradingPostalCode	form	string	No
TradingCountry	form	string	No
Occupation	form	string	No
OccupationSpecify	form	string	No
Designation	form	string	No
DesignationSpecify	form	string	No
BusinessType	form	string	No
IsZarAccount	form	bool?	No
FcaRequired	form	bool?	No
FcaCurrency1	form	string	No
FcaCurrency2	form	string	No
FcaDetails	form	string	No
TradeLimit	form	string	No
LessR10k	form	bool?	No
LessR20k	form	bool?	No
LessR50k	form	bool?	No
LessR100k	form	bool?	No
MoreR100k	form	bool?	No
MonthlyIncome	form	string	No
AccountPurpose	form	string	No
SourceOfFunds	form	string	No
SourceOfFundsSpecify	form	string	No
SourceOfWealth	form	string	No
SourceOfWealthSpecify	form	string	No
AccountDomicile	form	string	No
ThirdPartyAccount	form	string	No
InvestmentValue	form	string	No
UsPersonYes	form	bool?	No
UsPersonNo	form	bool?	No
TinNumber	form	string	No
ExSaTaxResidentYes	form	bool?	No
ExSaTaxResidentNo	form	bool?	No
Country1	form	string	No
TinNumber1	form	string	No
Country2	form	string	No
TinNumber2	form	string	No
CurrentDate	form	DateTime?	No
MultipleSignatories	form	bool	No
Capacity1	form	string	No
ClSignFullNames2	form	string	No
Capacity2	form	string	No
MustSign	form	string	No
SignedAt	form	string	No
Status	form	string	No
CifNumber	form	string	No
ZarAccountNumber	form	string	No
FcaAccountNumber1	form	string	No
FcaAccountNumber2	form	string	No
FaceToFace	form	bool?	No
NonFaceToFace	form	bool?	No
BrokerIntroduced	form	bool?	No
TradingAccount	form	bool?	No
Resident	form	bool?	No
NonResident	form	bool?	No
EmigrantBlockedAccount	form	bool?	No
EbaSavings	form	bool?	No
EbaCurrent	form	bool?	No
EbaTradingAccount	form	bool?	No
ExternalReference	form	string	No
GeoCode	form	string	No
ExchangeControl1	form	bool?	No
ExchangeControl2	form	bool?	No
ExchangeControl3	form	bool?	No
TheAgent	form	string	No
IpIntroducer	form	string	No
IsSwitchClient	form	bool?	No
PreviousIntermediary	form	string	No
ResignationDate	form	DateTime?	No
IsPartnerClient	form	bool?	No
ClientAllocatedToPartner	form	bool?	No
HavePopiPermission	form	bool?	No
IsSanctionsCheckComplete	form	bool?	No
SanctionsScreen	form	string	No
HasForm25Data	form	bool?	No
HasClientTcc	form	bool?	No
HasClientTccPending	form	bool?	No
HasHadClientTcc	form	bool?	No
IsDeactivated	form	bool?	No
DeactivatedDate	form	DateTime?	No
DiscretionaryAllowance	form	decimal?	No
DaStartDate	form	DateTime?	No
DaEndDate	form	DateTime?	No
ProgressOne	form	bool?	No
ProgressTwo	form	bool?	No
ProgressThree	form	bool?	No
IsEditing	form	bool?	No
HasFicaUpload	form	bool?	No
CreatedByUserId	form	int	No
CompletedNotificationSent	form	bool?	No
HigherRiskClientsChecksDone	form	bool?	No
LessAnnual100k	form	bool?	No
LessAnnual250k	form	bool?	No
LessAnnual500k	form	bool?	No
LessAnnual1mil	form	bool?	No
MoreAnnual1mil	form	bool?	No
SpotForeignExchange	form	bool?	No
ForwardExchange	form	bool?	No

**FormsDownloadResponse** Parameters:
Name	Parameter	Data Type	Required
Data	form	byte[]	No
Response	form	bool	No
FileName	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /forms_download HTTP/1.1 
Host: api.fxhub.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormsDownload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <FormType>String</FormType>
  <Id>0</Id>
  <RetailClient xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
    <d2p1:AccountDomicile>String</d2p1:AccountDomicile>
    <d2p1:AccountPurpose>String</d2p1:AccountPurpose>
    <d2p1:Address>String</d2p1:Address>
    <d2p1:BrokerIntroduced>false</d2p1:BrokerIntroduced>
    <d2p1:BusinessType>String</d2p1:BusinessType>
    <d2p1:Capacity1>String</d2p1:Capacity1>
    <d2p1:Capacity2>String</d2p1:Capacity2>
    <d2p1:CifNumber>String</d2p1:CifNumber>
    <d2p1:City>String</d2p1:City>
    <d2p1:ClSignFullNames2>String</d2p1:ClSignFullNames2>
    <d2p1:ClientAllocatedToPartner>false</d2p1:ClientAllocatedToPartner>
    <d2p1:ClientType>String</d2p1:ClientType>
    <d2p1:CompletedNotificationSent>false</d2p1:CompletedNotificationSent>
    <d2p1:ContactNumber1>String</d2p1:ContactNumber1>
    <d2p1:ContactNumber2>String</d2p1:ContactNumber2>
    <d2p1:ContactNumber3>String</d2p1:ContactNumber3>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:Country1>String</d2p1:Country1>
    <d2p1:Country2>String</d2p1:Country2>
    <d2p1:CountryOfResidence>String</d2p1:CountryOfResidence>
    <d2p1:CreatedByUserId>0</d2p1:CreatedByUserId>
    <d2p1:CurrentDate>0001-01-01T00:00:00</d2p1:CurrentDate>
    <d2p1:DaEndDate>0001-01-01T00:00:00</d2p1:DaEndDate>
    <d2p1:DaStartDate>0001-01-01T00:00:00</d2p1:DaStartDate>
    <d2p1:DateOfBirth>0001-01-01T00:00:00</d2p1:DateOfBirth>
    <d2p1:DeactivatedDate>0001-01-01T00:00:00</d2p1:DeactivatedDate>
    <d2p1:Designation>String</d2p1:Designation>
    <d2p1:DesignationSpecify>String</d2p1:DesignationSpecify>
    <d2p1:DiscretionaryAllowance>0</d2p1:DiscretionaryAllowance>
    <d2p1:EbaCurrent>false</d2p1:EbaCurrent>
    <d2p1:EbaSavings>false</d2p1:EbaSavings>
    <d2p1:EbaTradingAccount>false</d2p1:EbaTradingAccount>
    <d2p1:EmailAddress>String</d2p1:EmailAddress>
    <d2p1:EmigrantBlockedAccount>false</d2p1:EmigrantBlockedAccount>
    <d2p1:ExSaTaxResidentNo>false</d2p1:ExSaTaxResidentNo>
    <d2p1:ExSaTaxResidentYes>false</d2p1:ExSaTaxResidentYes>
    <d2p1:ExchangeControl1>false</d2p1:ExchangeControl1>
    <d2p1:ExchangeControl2>false</d2p1:ExchangeControl2>
    <d2p1:ExchangeControl3>false</d2p1:ExchangeControl3>
    <d2p1:ExternalReference>String</d2p1:ExternalReference>
    <d2p1:FaceToFace>false</d2p1:FaceToFace>
    <d2p1:FcaAccountNumber1>String</d2p1:FcaAccountNumber1>
    <d2p1:FcaAccountNumber2>String</d2p1:FcaAccountNumber2>
    <d2p1:FcaCurrency1>String</d2p1:FcaCurrency1>
    <d2p1:FcaCurrency2>String</d2p1:FcaCurrency2>
    <d2p1:FcaDetails>String</d2p1:FcaDetails>
    <d2p1:FcaRequired>false</d2p1:FcaRequired>
    <d2p1:FirstName>String</d2p1:FirstName>
    <d2p1:ForwardExchange>false</d2p1:ForwardExchange>
    <d2p1:Gender>String</d2p1:Gender>
    <d2p1:GeoCode>String</d2p1:GeoCode>
    <d2p1:HasClientTcc>false</d2p1:HasClientTcc>
    <d2p1:HasClientTccPending>false</d2p1:HasClientTccPending>
    <d2p1:HasFicaUpload>false</d2p1:HasFicaUpload>
    <d2p1:HasForm25Data>false</d2p1:HasForm25Data>
    <d2p1:HasHadClientTcc>false</d2p1:HasHadClientTcc>
    <d2p1:HavePopiPermission>false</d2p1:HavePopiPermission>
    <d2p1:HigherRiskClientsChecksDone>false</d2p1:HigherRiskClientsChecksDone>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IdNumber>String</d2p1:IdNumber>
    <d2p1:InvestmentValue>String</d2p1:InvestmentValue>
    <d2p1:IpIntroducer>String</d2p1:IpIntroducer>
    <d2p1:IsDeactivated>false</d2p1:IsDeactivated>
    <d2p1:IsEditing>false</d2p1:IsEditing>
    <d2p1:IsPartnerClient>false</d2p1:IsPartnerClient>
    <d2p1:IsSanctionsCheckComplete>false</d2p1:IsSanctionsCheckComplete>
    <d2p1:IsSoleProprietor>false</d2p1:IsSoleProprietor>
    <d2p1:IsSwitchClient>false</d2p1:IsSwitchClient>
    <d2p1:IsZarAccount>false</d2p1:IsZarAccount>
    <d2p1:LastName>String</d2p1:LastName>
    <d2p1:LessAnnual100k>false</d2p1:LessAnnual100k>
    <d2p1:LessAnnual1mil>false</d2p1:LessAnnual1mil>
    <d2p1:LessAnnual250k>false</d2p1:LessAnnual250k>
    <d2p1:LessAnnual500k>false</d2p1:LessAnnual500k>
    <d2p1:LessR100k>false</d2p1:LessR100k>
    <d2p1:LessR10k>false</d2p1:LessR10k>
    <d2p1:LessR20k>false</d2p1:LessR20k>
    <d2p1:LessR50k>false</d2p1:LessR50k>
    <d2p1:MiddleName>String</d2p1:MiddleName>
    <d2p1:MonthlyIncome>String</d2p1:MonthlyIncome>
    <d2p1:MoreAnnual1mil>false</d2p1:MoreAnnual1mil>
    <d2p1:MoreR100k>false</d2p1:MoreR100k>
    <d2p1:MultipleSignatories>false</d2p1:MultipleSignatories>
    <d2p1:MustSign>String</d2p1:MustSign>
    <d2p1:Nationality>String</d2p1:Nationality>
    <d2p1:NonFaceToFace>false</d2p1:NonFaceToFace>
    <d2p1:NonResident>false</d2p1:NonResident>
    <d2p1:Occupation>String</d2p1:Occupation>
    <d2p1:OccupationSpecify>String</d2p1:OccupationSpecify>
    <d2p1:PartnerId>0</d2p1:PartnerId>
    <d2p1:PartnerIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </d2p1:PartnerIds>
    <d2p1:PartnerName>String</d2p1:PartnerName>
    <d2p1:PassportCountry>String</d2p1:PassportCountry>
    <d2p1:PassportExpiryDate>0001-01-01T00:00:00</d2p1:PassportExpiryDate>
    <d2p1:PassportIssueDate>0001-01-01T00:00:00</d2p1:PassportIssueDate>
    <d2p1:PassportNumber>String</d2p1:PassportNumber>
    <d2p1:PlaceOfBirth>String</d2p1:PlaceOfBirth>
    <d2p1:PostalAddress>String</d2p1:PostalAddress>
    <d2p1:PostalCity>String</d2p1:PostalCity>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:PostalCountry>String</d2p1:PostalCountry>
    <d2p1:PostalPostalCode>String</d2p1:PostalPostalCode>
    <d2p1:PostalProvince>String</d2p1:PostalProvince>
    <d2p1:PostalSameAsStreet>false</d2p1:PostalSameAsStreet>
    <d2p1:PostalSuburb>String</d2p1:PostalSuburb>
    <d2p1:PreviousIntermediary>String</d2p1:PreviousIntermediary>
    <d2p1:ProgressOne>false</d2p1:ProgressOne>
    <d2p1:ProgressThree>false</d2p1:ProgressThree>
    <d2p1:ProgressTwo>false</d2p1:ProgressTwo>
    <d2p1:Province>String</d2p1:Province>
    <d2p1:Race>String</d2p1:Race>
    <d2p1:ResidencyStatus>String</d2p1:ResidencyStatus>
    <d2p1:Resident>false</d2p1:Resident>
    <d2p1:ResignationDate>0001-01-01T00:00:00</d2p1:ResignationDate>
    <d2p1:SanctionsScreen>String</d2p1:SanctionsScreen>
    <d2p1:SignedAt>String</d2p1:SignedAt>
    <d2p1:SourceOfFunds>String</d2p1:SourceOfFunds>
    <d2p1:SourceOfFundsSpecify>String</d2p1:SourceOfFundsSpecify>
    <d2p1:SourceOfWealth>String</d2p1:SourceOfWealth>
    <d2p1:SourceOfWealthSpecify>String</d2p1:SourceOfWealthSpecify>
    <d2p1:SpotForeignExchange>false</d2p1:SpotForeignExchange>
    <d2p1:Status>String</d2p1:Status>
    <d2p1:Suburb>String</d2p1:Suburb>
    <d2p1:TaxRefNumber>String</d2p1:TaxRefNumber>
    <d2p1:TempResDate>String</d2p1:TempResDate>
    <d2p1:TempResNumber>String</d2p1:TempResNumber>
    <d2p1:TheAgent>String</d2p1:TheAgent>
    <d2p1:ThirdPartyAccount>String</d2p1:ThirdPartyAccount>
    <d2p1:TinNumber>String</d2p1:TinNumber>
    <d2p1:TinNumber1>String</d2p1:TinNumber1>
    <d2p1:TinNumber2>String</d2p1:TinNumber2>
    <d2p1:Title>String</d2p1:Title>
    <d2p1:TradeLimit>String</d2p1:TradeLimit>
    <d2p1:TradingAccount>false</d2p1:TradingAccount>
    <d2p1:TradingAddress>String</d2p1:TradingAddress>
    <d2p1:TradingCity>String</d2p1:TradingCity>
    <d2p1:TradingCountry>String</d2p1:TradingCountry>
    <d2p1:TradingPostalCode>String</d2p1:TradingPostalCode>
    <d2p1:TradingProvince>String</d2p1:TradingProvince>
    <d2p1:TradingSameAsStreet>false</d2p1:TradingSameAsStreet>
    <d2p1:TradingSuburb>String</d2p1:TradingSuburb>
    <d2p1:UsPersonNo>false</d2p1:UsPersonNo>
    <d2p1:UsPersonYes>false</d2p1:UsPersonYes>
    <d2p1:ZarAccountNumber>String</d2p1:ZarAccountNumber>
  </RetailClient>
</FormsDownload>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormsDownloadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
  <Data>AA==</Data>
  <FileName>String</FileName>
  <Response>false</Response>
</FormsDownloadResponse>