Skip to navigation

Risk Category Finds

View as Markdown

Find several risk categories by name.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Look up multiple risk categories by name in a single call, returning each matching record, including its id. Prefer this over repeated riskCategoryFind calls when you need to resolve several names at once.

Common Failure Scenarios

  • A name in names that doesn’t match a risk category, or matches one you can’t access, is left out of the response array. The call still succeeds, so compare the returned records against the names you requested.
  • The names parameter is missing or repeated (HTTP 404).
  • 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 names parameter is missing or repeated.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

nameslist of stringsRequired

Response

RiskCategory
namestring<=64 characters
idlongOptional
riskCreditdoubleOptional
organizationIdlongOptional