Request Parameters

Parameter	Required	Type	Description
clientID	yes	string	TransactAPI Client ID
developerAPIKey	yes	string	TransactAPI Developer Key
accountId	yes	integer	Account ID that is generated by the API once an account is created (createAccount)
riskProfile	no	conditional	Risk Profile Score: 1,2,3,4,5 (1=very conservative; 5=very aggressive)
investmentExperience	no	conditional	Investment Experience Score: 1,2,3,4,5 (1=none; 5=extensive)
privOffExperience	no	conditional	Experience Investing in Private Offerings Score: 1,2,3,4,5 (1=none; 5=extensive)
pctPrivSecurities	no	integer	Percentage of the Investor's Investment Portfolio that is invested in Private Placements
pctIlliquidSecurities	no	integer	Percentage of the Investor's Investment Portfolio that is invested in Illiquid Securities
pctLiquidSecurities	no	integer	Percentage of the Investor's Investment Portfolio that is invested in Liquid Securities
pctRealEstate	no	integer	Percentage of the Investor's Investment Portfolio that is invested in Real Estate
timeHorizon	no	conditional	The number of years until the investment portfolio is expected to reach maturity
education	no	conditional	Investor's Highest level of education: High School or GED, 4 Year College or University, Graduate Degree, Other
financialAdvisor	no	string	Does the Investor have a financial advisor? Yes or No
notes	no	string	Free form text for any notes that need to be added for the suitability
investmentObjective	no	string	Primarily on Capital Preservation, Both Capital Preservation and Growth, Primarily Focused on growth
additionalnotes	no	string	Free form text for any notes that need to be added for the suitability

Sample Request

curl -k -X PUT https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/calculateSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A43256
-d riskProfile=1
-d investmentExperience=1
-d investmentObjective=Both Capital Preservation and Growth
-d privOffExperience=1
-d pctPrivSecurities=5
-d pctIlliquidSecurities=4
-d pctLiquidSecurities=4
-d pctRealEstate=6
-d timeHorizon=4
-d education=High School or GED
-d financialAdvisor=yes
-d notes=Suitability for an account
-d additionalnotes=Suitability for an account

Response Parameters

Parameter	Type	Description
statusCode	string	API Status Code
statusDesc	string	API Status Description
accountId	integer	Unique Identifier code for the account

Sample Response

{
        "statusCode": "101",
        "statusDesc": "Ok",
        "accountDetails": [{
                "accountId": "A43256"
        }]
}

Test it Yourself!