FxHubPartnersApi

<back to all web services

FicaDownload

Requires Authentication
The following routes are available for this service:
GET/fica_download
FicaDownload Parameters:
NameParameterData TypeRequiredDescription
IdqueryintNo
FormTypequerystringNo
FicaqueryFicaNo
Fica Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
ClientNameformstringNo
IdentityDocumentFileNameformstringNo
IdentityDocumentFileDisplayNameformstringNo
IdentityDocumentFileUploadedDateformDateTime?No
HasIdentityDocumentFileformbool?No
ProofOfResidenceFileNameformstringNo
ProofOfResidenceFileDisplayNameformstringNo
ProofOfResidenceFileUploadedDateformDateTime?No
HasProofOfResidenceFileformbool?No
PowerOfAttorneyFileNameformstringNo
PowerOfAttorneyFileDisplayNameformstringNo
PowerOfAttorneyFileUploadedDateformDateTime?No
HasPowerOfAttorneyFileformbool?No
MarriageCertificateFileNameformstringNo
MarriageCertificateFileDisplayNameformstringNo
MarriageCertificateFileUploadedDateformDateTime?No
HasMarriageCertificateFileformbool?No
ClientImageFileNameformstringNo
ClientImageFileDisplayNameformstringNo
ClientImageFileUploadedDateformDateTime?No
HasClientImageFileformbool?No
MiscellaneousOneFileNameformstringNo
MiscellaneousOneFileDisplayNameformstringNo
MiscellaneousOneFileUploadedDateformDateTime?No
HasMiscellaneousOneFileformbool?No
TimFileNameformstringNo
TimFileDisplayNameformstringNo
TimFileUploadedDateformDateTime?No
HasTimFileformbool?No
PepFileNameformstringNo
PepFileDisplayNameformstringNo
PepFileUploadedDateformDateTime?No
HasPepFileformbool?No
SourceOfFundsFileNameformstringNo
SourceOfFundsFileDisplayNameformstringNo
SourceOfFundsFileUploadedDateformDateTime?No
HasSourceOfFundsFileformbool?No
ManagementSignOffFileNameformstringNo
ManagementSignOffFileDisplayNameformstringNo
ManagementSignOffFileUploadedDateformDateTime?No
HasManagementSignOffFileformbool?No
FicaDownloadResponse Parameters:
NameParameterData TypeRequiredDescription
Dataformbyte[]No
ResponseformboolNo
FileNameformstringNo

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.

GET /fica_download HTTP/1.1 
Host: api.fxlink.co.za 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FicaDownloadResponse 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>
</FicaDownloadResponse>