Get Suitability

This method is used to retrieve all suitability information for a specific account. The AccountID is required as a request parameter for this method.

Request Method : POST

Request Parameters

Parameter Required Type Description
clientID yes string Transact API Client ID
developerAPIKey yes string Transact API Developer Key
accountId yes string Account ID that is generated by the API once an account is created (createAccount).

Sample Request

curl -k -X POST https://api-sandboxdash.norcapsecurities.com/tapiv3/index.php/v3/getSuitability
-d clientID=someclientid
-d developerAPIKey=somedeveloperkey
-d accountId=A77654

Response Parameters

Parameter Type Description
statusCode string API Status Code
statusDesc string API Status Description
accountDetails string Array of account includes all information of the matched accounts suitability details

Sample Response

{
    "statusCode": "101",
    "statusDesc": "Ok",
    "accountDetails": {
        "id": "92",
        "developerAPIKey": "2DttpCb9fhJHu3tMb9kiKvFIFfNZWCBiWdJ",
        "accountId": "A25454",
        "riskProfile": "1",
        "investmentObjective": "",
        "investmentExperience": "1",
        "privOffExperience": "1",
        "pctPrivSecurities": "12",
        "pctIlliquidSecurities": "12",
        "pctRealEstate": "12",
        "timeHorizon": "12",
        "education": "High School or GED",
        "financialAdvisor": "No",
        "notes": null,
        "virtualStatus": "ACTIVE",
        "createdDate": "2017-10-13 10:22:04",
        "updatedDate": null,
        "createdIpAddress": "159.203.134.7",
        "updatedIpAddress": null,
        "isdeleted": null
    }
}
Click on the "Test it yourself" button to see how it works
Click on the "Error Codes" button to see list of error codes

Marketplace-as-a-Service