FxHubPartnersApi

<back to all web services

GetClientFica

Requires Authentication
The following routes are available for this service:
GET/fica/{Id}
GetClientFica Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
GetClientFicaResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformFicaNo
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

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.

GET /fica/{Id} HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		clientId: 0,
		clientName: String,
		identityDocumentFileName: String,
		identityDocumentFileDisplayName: String,
		identityDocumentFileUploadedDate: 0001-01-01,
		hasIdentityDocumentFile: False,
		proofOfResidenceFileName: String,
		proofOfResidenceFileDisplayName: String,
		proofOfResidenceFileUploadedDate: 0001-01-01,
		hasProofOfResidenceFile: False,
		powerOfAttorneyFileName: String,
		powerOfAttorneyFileDisplayName: String,
		powerOfAttorneyFileUploadedDate: 0001-01-01,
		hasPowerOfAttorneyFile: False,
		marriageCertificateFileName: String,
		marriageCertificateFileDisplayName: String,
		marriageCertificateFileUploadedDate: 0001-01-01,
		hasMarriageCertificateFile: False,
		clientImageFileName: String,
		clientImageFileDisplayName: String,
		clientImageFileUploadedDate: 0001-01-01,
		hasClientImageFile: False,
		miscellaneousOneFileName: String,
		miscellaneousOneFileDisplayName: String,
		miscellaneousOneFileUploadedDate: 0001-01-01,
		hasMiscellaneousOneFile: False,
		timFileName: String,
		timFileDisplayName: String,
		timFileUploadedDate: 0001-01-01,
		hasTimFile: False,
		pepFileName: String,
		pepFileDisplayName: String,
		pepFileUploadedDate: 0001-01-01,
		hasPepFile: False,
		sourceOfFundsFileName: String,
		sourceOfFundsFileDisplayName: String,
		sourceOfFundsFileUploadedDate: 0001-01-01,
		hasSourceOfFundsFile: False,
		managementSignOffFileName: String,
		managementSignOffFileDisplayName: String,
		managementSignOffFileUploadedDate: 0001-01-01,
		hasManagementSignOffFile: False
	}
}