Compliance

Routes for managing compliance and user classifications.

Get All Classifications

GET/compliance/classifications

Retrieve all available classifications.

cURL

    curl https://your.platform.url/kong/core/api/gateway/compliance/classifications \
      -H "Authorization: Bearer {token}"

Sample Response

[
  {
    "complianceQuestionnaireInvestorClassId": 1,
    "investorClass": "High Net Worth"
  },
  {
    "complianceQuestionnaireInvestorClassId": 2,
    "investorClass": "Sophisticated Investor"
  },
  {
    "complianceQuestionnaireInvestorClassId": 3,
    "investorClass": "Investment Professional"
  }
]

Get User Classifications

GET/compliance/user/:userId/classifications

Retrieve a specific user's classifications.

Required attributes

Name
userId
Type
string
Description
The id of the user you wish to retrieve classifications for

cURL

    curl https://your.platform.url/kong/core/api/gateway/compliance/user/501a4c57-acb8-40d6-b867-b833854a96b9/classifications \
      -H "Authorization: Bearer {token}"

Sample Response

{
  "manual": [
    {
      "complianceQuestionnaireInvestorClassId": 1,
      "investorClass": "High Net Worth"
    },
    {
      "complianceQuestionnaireInvestorClassId": 3,
      "investorClass": "Investment Professional"
    }
  ],
  "automatic": [
    {
      "complianceQuestionnaireInvestorClassId": 1,
      "investorClass": "High Net Worth"
    }
  ]
}

Update User Classifications

PATCH/compliance/user/:userId/classifications

Updates the classifications for a specific user.

Required attributes

Name
userId
Type
string
Description
The id of the user you wish to update

Body Parameters

Name
manualClassificationIds
Type
int[]
Description
An array of complainceQuestionnaireInvestorClassIds
Name
automaticClassificationIds
Type
int[]
Description
An array of complainceQuestionnaireInvestorClassIds

cURL

    curl -X PATCH https://your.platform.url/kong/core/api/gateway/compliance/user/501a4c57-acb8-40d6-b867-b833854a96b9/classifications \
      -H "Authorization: Bearer {token}" \
      -H "Content-Type: application/json" \
      -d '{
        "manualClassificationIds": [],
        "automaticClassificationIds": []
  }'