FxHubPartnersApi

<back to all web services

CreateClientTccDocs

Requires Authentication
The following routes are available for this service:
POST/tccdocs/create
CreateClientTccDocs Parameters:
NameParameterData TypeRequiredDescription
ClientIdbodyintNo
ClientTccbodyClientTccNo
TccDocsbodyTccDocsNo
ClientTcc Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FullNamesformstringNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
ApplicationStatusformstringNo
TccIssuerformstringNo
TccPinformstringNo
TccValueformdecimal?No
IssueDateformDateTime?No
ExpiryDateformDateTime?No
Chargesformdecimal?No
ChargesInvoiceformstringNo
ChargesDateformDateTime?No
ChargesTypeformstringNo
CommentsformstringNo
InitialSendformDateTime?No
UpdatedAtformDateTime?No
TimeElapsedformdoubleNo
HasTccDocsformbool?No
TccDocs Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
TccIdformintNo
ClientIdformintNo
ClientNameformstringNo
PowerOfAttorneyFileNameformstringNo
PowerOfAttorneyFileDisplayNameformstringNo
PowerOfAttorneyFileUploadedDateformDateTime?No
HasPowerOfAttorneyFileformbool?No
Fia001FileNameformstringNo
Fia001FileDisplayNameformstringNo
Fia001FileUploadedDateformDateTime?No
HasFia001Fileformbool?No
AssetsAndLiabilitiesFileNameformstringNo
AssetsAndLiabilitiesFileDisplayNameformstringNo
AssetsAndLiabilitiesFileUploadedDateformDateTime?No
HasAssetsAndLiabilitiesFileformbool?No
BankStatementsFileNameformstringNo
BankStatementsFileDisplayNameformstringNo
BankStatementsFileUploadedDateformDateTime?No
HasBankStatementsFileformbool?No
InheritanceFileNameformstringNo
InheritanceFileDisplayNameformstringNo
InheritanceFileUploadedDateformDateTime?No
HasInheritanceFileformbool?No
LoansFileNameformstringNo
LoansFileDisplayNameformstringNo
LoansFileUploadedDateformDateTime?No
HasLoansFileformbool?No
InvestmentsFileNameformstringNo
InvestmentsFileDisplayNameformstringNo
InvestmentsFileUploadedDateformDateTime?No
HasInvestmentsFileformbool?No
PropertyFileNameformstringNo
PropertyFileDisplayNameformstringNo
PropertyFileUploadedDateformDateTime?No
HasPropertyFileformbool?No
DistributionFileNameformstringNo
DistributionFileDisplayNameformstringNo
DistributionFileUploadedDateformDateTime?No
HasDistributionFileformbool?No
DonationFileNameformstringNo
DonationFileDisplayNameformstringNo
DonationFileUploadedDateformDateTime?No
HasDonationFileformbool?No
MiscellaneousFileNameformstringNo
MiscellaneousFileDisplayNameformstringNo
MiscellaneousFileUploadedDateformDateTime?No
HasMiscellaneousFileformbool?No
CreateClientTccDocsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

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

HTTP + JSV

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

POST /tccdocs/create HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	clientId: 0,
	clientTcc: 
	{
		id: 0,
		clientId: 0,
		fullNames: String,
		firstLastName: String,
		partnerId: 0,
		partnerName: String,
		applicationStatus: String,
		tccIssuer: String,
		tccPin: String,
		tccValue: 0,
		issueDate: 0001-01-01,
		expiryDate: 0001-01-01,
		charges: 0,
		chargesInvoice: String,
		chargesDate: 0001-01-01,
		chargesType: String,
		comments: String,
		initialSend: 0001-01-01,
		updatedAt: 0001-01-01,
		timeElapsed: 0,
		hasTccDocs: False
	},
	tccDocs: 
	{
		id: 0,
		tccId: 0,
		clientId: 0,
		clientName: String,
		powerOfAttorneyFileName: String,
		powerOfAttorneyFileDisplayName: String,
		powerOfAttorneyFileUploadedDate: 0001-01-01,
		hasPowerOfAttorneyFile: False,
		fia001FileName: String,
		fia001FileDisplayName: String,
		fia001FileUploadedDate: 0001-01-01,
		hasFia001File: False,
		assetsAndLiabilitiesFileName: String,
		assetsAndLiabilitiesFileDisplayName: String,
		assetsAndLiabilitiesFileUploadedDate: 0001-01-01,
		hasAssetsAndLiabilitiesFile: False,
		bankStatementsFileName: String,
		bankStatementsFileDisplayName: String,
		bankStatementsFileUploadedDate: 0001-01-01,
		hasBankStatementsFile: False,
		inheritanceFileName: String,
		inheritanceFileDisplayName: String,
		inheritanceFileUploadedDate: 0001-01-01,
		hasInheritanceFile: False,
		loansFileName: String,
		loansFileDisplayName: String,
		loansFileUploadedDate: 0001-01-01,
		hasLoansFile: False,
		investmentsFileName: String,
		investmentsFileDisplayName: String,
		investmentsFileUploadedDate: 0001-01-01,
		hasInvestmentsFile: False,
		propertyFileName: String,
		propertyFileDisplayName: String,
		propertyFileUploadedDate: 0001-01-01,
		hasPropertyFile: False,
		distributionFileName: String,
		distributionFileDisplayName: String,
		distributionFileUploadedDate: 0001-01-01,
		hasDistributionFile: False,
		donationFileName: String,
		donationFileDisplayName: String,
		donationFileUploadedDate: 0001-01-01,
		hasDonationFile: False,
		miscellaneousFileName: String,
		miscellaneousFileDisplayName: String,
		miscellaneousFileUploadedDate: 0001-01-01,
		hasMiscellaneousFile: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: False,
	message: String
}