Risk Category Find
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 thenameis for a risk category you can’t access. Both returnHTTP 404with an empty body, notHTTP 401. - The
nameparameter 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 401with"Access is denied".
Error Messages
Related Endpoints
- Use
riskCategoryItemto resolve a risk category byidinstead. - Use
riskCategoryFindsto look up several risk categories by name in one call.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
name
Response
RiskCategory
name
id
riskCredit
organizationId