| GET | /fica/{Id} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Result | form | Fica | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| ClientId | form | int | No | |
| ClientName | form | string | No | |
| IdentityDocumentFileName | form | string | No | |
| IdentityDocumentFileDisplayName | form | string | No | |
| IdentityDocumentFileUploadedDate | form | DateTime? | No | |
| HasIdentityDocumentFile | form | bool? | No | |
| ProofOfResidenceFileName | form | string | No | |
| ProofOfResidenceFileDisplayName | form | string | No | |
| ProofOfResidenceFileUploadedDate | form | DateTime? | No | |
| HasProofOfResidenceFile | form | bool? | No | |
| PowerOfAttorneyFileName | form | string | No | |
| PowerOfAttorneyFileDisplayName | form | string | No | |
| PowerOfAttorneyFileUploadedDate | form | DateTime? | No | |
| HasPowerOfAttorneyFile | form | bool? | No | |
| MarriageCertificateFileName | form | string | No | |
| MarriageCertificateFileDisplayName | form | string | No | |
| MarriageCertificateFileUploadedDate | form | DateTime? | No | |
| HasMarriageCertificateFile | form | bool? | No | |
| ClientImageFileName | form | string | No | |
| ClientImageFileDisplayName | form | string | No | |
| ClientImageFileUploadedDate | form | DateTime? | No | |
| HasClientImageFile | form | bool? | No | |
| MiscellaneousOneFileName | form | string | No | |
| MiscellaneousOneFileDisplayName | form | string | No | |
| MiscellaneousOneFileUploadedDate | form | DateTime? | No | |
| HasMiscellaneousOneFile | form | bool? | No | |
| TimFileName | form | string | No | |
| TimFileDisplayName | form | string | No | |
| TimFileUploadedDate | form | DateTime? | No | |
| HasTimFile | form | bool? | No | |
| PepFileName | form | string | No | |
| PepFileDisplayName | form | string | No | |
| PepFileUploadedDate | form | DateTime? | No | |
| HasPepFile | form | bool? | No | |
| SourceOfFundsFileName | form | string | No | |
| SourceOfFundsFileDisplayName | form | string | No | |
| SourceOfFundsFileUploadedDate | form | DateTime? | No | |
| HasSourceOfFundsFile | form | bool? | No | |
| ManagementSignOffFileName | form | string | No | |
| ManagementSignOffFileDisplayName | form | string | No | |
| ManagementSignOffFileUploadedDate | form | DateTime? | No | |
| HasManagementSignOffFile | form | bool? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetClientFicaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel">
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/FxHubPartnersApi.ServiceModel.Types">
<d2p1:ClientId>0</d2p1:ClientId>
<d2p1:ClientImageFileDisplayName>String</d2p1:ClientImageFileDisplayName>
<d2p1:ClientImageFileName>String</d2p1:ClientImageFileName>
<d2p1:ClientImageFileUploadedDate>0001-01-01T00:00:00</d2p1:ClientImageFileUploadedDate>
<d2p1:ClientName>String</d2p1:ClientName>
<d2p1:HasClientImageFile>false</d2p1:HasClientImageFile>
<d2p1:HasIdentityDocumentFile>false</d2p1:HasIdentityDocumentFile>
<d2p1:HasManagementSignOffFile>false</d2p1:HasManagementSignOffFile>
<d2p1:HasMarriageCertificateFile>false</d2p1:HasMarriageCertificateFile>
<d2p1:HasMiscellaneousOneFile>false</d2p1:HasMiscellaneousOneFile>
<d2p1:HasPepFile>false</d2p1:HasPepFile>
<d2p1:HasPowerOfAttorneyFile>false</d2p1:HasPowerOfAttorneyFile>
<d2p1:HasProofOfResidenceFile>false</d2p1:HasProofOfResidenceFile>
<d2p1:HasSourceOfFundsFile>false</d2p1:HasSourceOfFundsFile>
<d2p1:HasTimFile>false</d2p1:HasTimFile>
<d2p1:Id>0</d2p1:Id>
<d2p1:IdentityDocumentFileDisplayName>String</d2p1:IdentityDocumentFileDisplayName>
<d2p1:IdentityDocumentFileName>String</d2p1:IdentityDocumentFileName>
<d2p1:IdentityDocumentFileUploadedDate>0001-01-01T00:00:00</d2p1:IdentityDocumentFileUploadedDate>
<d2p1:ManagementSignOffFileDisplayName>String</d2p1:ManagementSignOffFileDisplayName>
<d2p1:ManagementSignOffFileName>String</d2p1:ManagementSignOffFileName>
<d2p1:ManagementSignOffFileUploadedDate>0001-01-01T00:00:00</d2p1:ManagementSignOffFileUploadedDate>
<d2p1:MarriageCertificateFileDisplayName>String</d2p1:MarriageCertificateFileDisplayName>
<d2p1:MarriageCertificateFileName>String</d2p1:MarriageCertificateFileName>
<d2p1:MarriageCertificateFileUploadedDate>0001-01-01T00:00:00</d2p1:MarriageCertificateFileUploadedDate>
<d2p1:MiscellaneousOneFileDisplayName>String</d2p1:MiscellaneousOneFileDisplayName>
<d2p1:MiscellaneousOneFileName>String</d2p1:MiscellaneousOneFileName>
<d2p1:MiscellaneousOneFileUploadedDate>0001-01-01T00:00:00</d2p1:MiscellaneousOneFileUploadedDate>
<d2p1:PepFileDisplayName>String</d2p1:PepFileDisplayName>
<d2p1:PepFileName>String</d2p1:PepFileName>
<d2p1:PepFileUploadedDate>0001-01-01T00:00:00</d2p1:PepFileUploadedDate>
<d2p1:PowerOfAttorneyFileDisplayName>String</d2p1:PowerOfAttorneyFileDisplayName>
<d2p1:PowerOfAttorneyFileName>String</d2p1:PowerOfAttorneyFileName>
<d2p1:PowerOfAttorneyFileUploadedDate>0001-01-01T00:00:00</d2p1:PowerOfAttorneyFileUploadedDate>
<d2p1:ProofOfResidenceFileDisplayName>String</d2p1:ProofOfResidenceFileDisplayName>
<d2p1:ProofOfResidenceFileName>String</d2p1:ProofOfResidenceFileName>
<d2p1:ProofOfResidenceFileUploadedDate>0001-01-01T00:00:00</d2p1:ProofOfResidenceFileUploadedDate>
<d2p1:SourceOfFundsFileDisplayName>String</d2p1:SourceOfFundsFileDisplayName>
<d2p1:SourceOfFundsFileName>String</d2p1:SourceOfFundsFileName>
<d2p1:SourceOfFundsFileUploadedDate>0001-01-01T00:00:00</d2p1:SourceOfFundsFileUploadedDate>
<d2p1:TimFileDisplayName>String</d2p1:TimFileDisplayName>
<d2p1:TimFileName>String</d2p1:TimFileName>
<d2p1:TimFileUploadedDate>0001-01-01T00:00:00</d2p1:TimFileUploadedDate>
</Result>
</GetClientFicaResponse>