Skip to navigation

Risk Category Find

View as Markdown

Find a risk category by name.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Look up a risk category by its name to get its id. Use this endpoint when you know a risk category by name and need the id that other records reference it by.

Common Failure Scenarios

  • No risk category matches the name, or the name is for a risk category you can’t access. Both return HTTP 404 with an empty body, not HTTP 401.
  • The name 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)404No risk category matches the name, or the caller can’t see that risk category. A risk category the caller can’t see returns 404, not 401.
(no message text)404The name parameter is missing or repeated.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

namestringRequired

Response

RiskCategory
namestring<=64 characters
idlongOptional
riskCreditdoubleOptional
organizationIdlongOptional