FxHubPartnersApi

<back to all web services

GetAllRiskMatrix

Requires Authentication
The following routes are available for this service:
GET/risk_rating/all
GetAllRiskMatrixResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<RiskRating>No
RiskRating Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
ClientIdformintNo
FullNamesformstringNo
FirstLastNameformstringNo
PartnerIdformintNo
PartnerNameformstringNo
IdNumberformstringNo
UpdatedAtformDateTime?No
NationalityformstringNo
NationalityRiskLevelDescriptionformstringNo
NationalityRiskLevelScoreformint?No
AccountDomicileformstringNo
AccountDomicileRiskLevelDescriptionformstringNo
AccountDomicileRiskLevelScoreformint?No
CountryOfResidenceformstringNo
CountryOfResidenceRiskLevelDescriptionformstringNo
CountryOfResidenceRiskLevelScoreformint?No
OccupationformstringNo
OccupationRiskLevelDescriptionformstringNo
OccupationRiskLevelScoreformint?No
SourceOfFundsformstringNo
SourceOfFundsRiskLevelDescriptionformstringNo
SourceOfFundsRiskLevelScoreformint?No
SourceOfWealthformstringNo
SourceOfWealthRiskLevelDescriptionformstringNo
SourceOfWealthRiskLevelScoreformint?No
ThirdPartyformstringNo
ThirdPartyRiskLevelDescriptionformstringNo
ThirdPartyRiskLevelScoreformint?No
InvestmentValueformstringNo
InvestmentValueRiskLevelDescriptionformstringNo
InvestmentValueRiskLevelScoreformint?No
SanctionsScreenformstringNo
SanctionsScreenRiskLevelDescriptionformstringNo
SanctionsScreenRiskLevelScoreformint?No
SumScoreformint?No
SumScoreDescriptionformstringNo
InitialFicaDateformDateTime?No
NextFicaDateformDateTime?No
RequireReficaformbool?No
CommentsformstringNo

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

HTTP + CSV

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

GET /risk_rating/all HTTP/1.1 
Host: api.fxlink.co.za 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"result":[{"id":0,"clientId":0,"fullNames":"String","firstLastName":"String","partnerId":0,"partnerName":"String","idNumber":"String","updatedAt":"0001-01-01","nationality":"String","nationalityRiskLevelDescription":"String","nationalityRiskLevelScore":0,"accountDomicile":"String","accountDomicileRiskLevelDescription":"String","accountDomicileRiskLevelScore":0,"countryOfResidence":"String","countryOfResidenceRiskLevelDescription":"String","countryOfResidenceRiskLevelScore":0,"occupation":"String","occupationRiskLevelDescription":"String","occupationRiskLevelScore":0,"sourceOfFunds":"String","sourceOfFundsRiskLevelDescription":"String","sourceOfFundsRiskLevelScore":0,"sourceOfWealth":"String","sourceOfWealthRiskLevelDescription":"String","sourceOfWealthRiskLevelScore":0,"thirdParty":"String","thirdPartyRiskLevelDescription":"String","thirdPartyRiskLevelScore":0,"investmentValue":"String","investmentValueRiskLevelDescription":"String","investmentValueRiskLevelScore":0,"sanctionsScreen":"String","sanctionsScreenRiskLevelDescription":"String","sanctionsScreenRiskLevelScore":0,"sumScore":0,"sumScoreDescription":"String","initialFicaDate":"0001-01-01","nextFicaDate":"0001-01-01","requireRefica":false,"comments":"String"}]}