| POST | /tccdocs/create |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientId | body | int | No | |
| ClientTcc | body | ClientTcc | No | |
| TccDocs | body | TccDocs | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ClientId | form | int | No | |
| FullNames | form | string | No | |
| FirstLastName | form | string | No | |
| PartnerId | form | int | No | |
| PartnerName | form | string | No | |
| ApplicationStatus | form | string | No | |
| TccIssuer | form | string | No | |
| TccPin | form | string | No | |
| TccValue | form | decimal? | No | |
| IssueDate | form | DateTime? | No | |
| ExpiryDate | form | DateTime? | No | |
| Charges | form | decimal? | No | |
| ChargesInvoice | form | string | No | |
| ChargesDate | form | DateTime? | No | |
| ChargesType | form | string | No | |
| Comments | form | string | No | |
| InitialSend | form | DateTime? | No | |
| UpdatedAt | form | DateTime? | No | |
| TimeElapsed | form | double | No | |
| HasTccDocs | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| TccId | form | int | No | |
| ClientId | form | int | No | |
| ClientName | form | string | No | |
| PowerOfAttorneyFileName | form | string | No | |
| PowerOfAttorneyFileDisplayName | form | string | No | |
| PowerOfAttorneyFileUploadedDate | form | DateTime? | No | |
| HasPowerOfAttorneyFile | form | bool? | No | |
| Fia001FileName | form | string | No | |
| Fia001FileDisplayName | form | string | No | |
| Fia001FileUploadedDate | form | DateTime? | No | |
| HasFia001File | form | bool? | No | |
| AssetsAndLiabilitiesFileName | form | string | No | |
| AssetsAndLiabilitiesFileDisplayName | form | string | No | |
| AssetsAndLiabilitiesFileUploadedDate | form | DateTime? | No | |
| HasAssetsAndLiabilitiesFile | form | bool? | No | |
| BankStatementsFileName | form | string | No | |
| BankStatementsFileDisplayName | form | string | No | |
| BankStatementsFileUploadedDate | form | DateTime? | No | |
| HasBankStatementsFile | form | bool? | No | |
| InheritanceFileName | form | string | No | |
| InheritanceFileDisplayName | form | string | No | |
| InheritanceFileUploadedDate | form | DateTime? | No | |
| HasInheritanceFile | form | bool? | No | |
| LoansFileName | form | string | No | |
| LoansFileDisplayName | form | string | No | |
| LoansFileUploadedDate | form | DateTime? | No | |
| HasLoansFile | form | bool? | No | |
| InvestmentsFileName | form | string | No | |
| InvestmentsFileDisplayName | form | string | No | |
| InvestmentsFileUploadedDate | form | DateTime? | No | |
| HasInvestmentsFile | form | bool? | No | |
| PropertyFileName | form | string | No | |
| PropertyFileDisplayName | form | string | No | |
| PropertyFileUploadedDate | form | DateTime? | No | |
| HasPropertyFile | form | bool? | No | |
| DistributionFileName | form | string | No | |
| DistributionFileDisplayName | form | string | No | |
| DistributionFileUploadedDate | form | DateTime? | No | |
| HasDistributionFile | form | bool? | No | |
| DonationFileName | form | string | No | |
| DonationFileDisplayName | form | string | No | |
| DonationFileUploadedDate | form | DateTime? | No | |
| HasDonationFile | form | bool? | No | |
| MiscellaneousFileName | form | string | No | |
| MiscellaneousFileDisplayName | form | string | No | |
| MiscellaneousFileUploadedDate | form | DateTime? | No | |
| HasMiscellaneousFile | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | bool | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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.fxhub.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
}