Honeycluster Docs – Get risk score and advisory flags for a token

tokens

Get risk score and advisory flags for a token

get

/token/{tokenSlug}/risk

operationId: token-risk

Returns the token's risk score (0–100) together with any active advisory (severity, message, source). Every field can be null when the score or advisory has not yet been populated. Returns null when no token matches the supplied key.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Path Parameters

Name	Type	Default	Description
`tokenSlug` required	string		Natural token identifier in `currency.issuer` form. Example: `USD.rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B`.

Responses

200

application/json

Successful response

Field	Type	Description
`riskScore`	object	Risk score (0–100; higher is riskier). `null` when the score has not been fetched yet.
`advisorySeverity`	object	Advisory severity level (`caution`, `warning`, or `danger`). `null` when no advisory is active for the token.
`advisoryMessage`	object	Free-text advisory message describing the flag. `null` when no advisory is active.
`source`	object	Source that set the advisory (e.g. `manual`). `null` when no advisory is active.

Example

Json

{
  "riskScore": 12,
  "advisorySeverity": null,
  "advisoryMessage": null,
  "source": null
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}