Skip to navigation

Risk Category Suggest

View as Markdown

Suggest risk categories matching a search term.

Available to: Organization administrators (own organization’s risk categories)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Return the risk categories you can access that match the search text in t. Use this endpoint to power a type-ahead or search box over risk categories, rather than retrieving the full list and filtering client-side.

The search ignores case and matches from the start of a word in the risk category’s name or its organization’s name. By default, the response returns at most 10 risk categories, even if l is larger. Set l lower to return fewer.

Common Failure Scenarios

  • Risk categories you can’t access are left out of the results. The call doesn’t return an error for them.
  • The t parameter is missing or repeated, or the l parameter is repeated (HTTP 404). An l value that isn’t a whole number in the 32-bit range returns HTTP 500.
  • The caller’s user type, or the API key’s permissions, can’t read risk categories. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read risk categories.
(no message text)404The t parameter is missing or repeated, or the l parameter is repeated.
"Internal Server Error, error id: {id}"500l isn’t a whole number in the 32-bit range. The error ID is generated per request.

Related Endpoints

  • Use riskCategoryList to retrieve every risk category in your organization.
  • Use riskCategoryFind to look up a risk category by its full name (the match ignores case).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

tstringRequired
Text
lintegerRequired
Max number of entities

Response

RiskCategory
namestring<=64 characters
idlongOptional
riskCreditdoubleOptional
organizationIdlongOptional