Skip to navigation

Risk Category Item

View as Markdown

Retrieve a risk category by ID.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve a single riskCategoryId to its risk category record. A risk category holds the position limits and risk parameters that apply to the accounts assigned to it.

Common Failure Scenarios

  • No risk category matches the id, or the id is for a risk category you can’t access. Both return HTTP 404 with an empty body, not HTTP 401.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • 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 id, 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 id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

RiskCategory
namestring<=64 characters
idlongOptional
riskCreditdoubleOptional
organizationIdlongOptional