FxHubPartnersApi

GetRiskMatrix

The following routes are available for this service:
GET	/risk_rating/{Id}

**GetRiskMatrix** Parameters:
Name	Parameter	Data Type	Required	Description
Id	path	int	No
ClientId	query	int	No

**GetRiskMatrixResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Result	form	RiskRating	No

**RiskRating** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
ClientId	form	int	No
FullNames	form	string	No
FirstLastName	form	string	No
PartnerId	form	int	No
PartnerName	form	string	No
IdNumber	form	string	No
UpdatedAt	form	DateTime?	No
Nationality	form	string	No
NationalityRiskLevelDescription	form	string	No
NationalityRiskLevelScore	form	int?	No
AccountDomicile	form	string	No
AccountDomicileRiskLevelDescription	form	string	No
AccountDomicileRiskLevelScore	form	int?	No
CountryOfResidence	form	string	No
CountryOfResidenceRiskLevelDescription	form	string	No
CountryOfResidenceRiskLevelScore	form	int?	No
Occupation	form	string	No
OccupationRiskLevelDescription	form	string	No
OccupationRiskLevelScore	form	int?	No
SourceOfFunds	form	string	No
SourceOfFundsRiskLevelDescription	form	string	No
SourceOfFundsRiskLevelScore	form	int?	No
SourceOfWealth	form	string	No
SourceOfWealthRiskLevelDescription	form	string	No
SourceOfWealthRiskLevelScore	form	int?	No
ThirdParty	form	string	No
ThirdPartyRiskLevelDescription	form	string	No
ThirdPartyRiskLevelScore	form	int?	No
InvestmentValue	form	string	No
InvestmentValueRiskLevelDescription	form	string	No
InvestmentValueRiskLevelScore	form	int?	No
SanctionsScreen	form	string	No
SanctionsScreenRiskLevelDescription	form	string	No
SanctionsScreenRiskLevelScore	form	int?	No
SumScore	form	int?	No
SumScoreDescription	form	string	No
InitialFicaDate	form	DateTime?	No
NextFicaDate	form	DateTime?	No
RequireRefica	form	bool?	No
Comments	form	string	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 /risk_rating/{Id} HTTP/1.1 
Host: api.fxhub.co.za 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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
	}
}