Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
Individual Risks

Update an individual entity's risk level for a service profile.

This endpoint allows you to override the calculated risk level for the last completed workflow of an individual entity's service profile.

Note:

  • This operation will not trigger a new workflow but will be used in the next workflow execution unless risk factors change or results are invalidated.
  • To execute the workflow, use the endpoint POST /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute.
patch/v2/individuals/{entityId}/serviceprofiles/{serviceName}/risk

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-Usernamestring
Example:fred.flintstone@frankieone.com

Username provided by API caller

Request body

riskLevel'UNKNOWN' | 'LOW' | 'MEDIUM' | 'HIGH' | 'UNACCEPTABLE'

The risk level classification:

  • UNKNOWN: Risk level is not determined.
  • LOW: Low risk.
  • MEDIUM: Medium risk.
  • HIGH: High risk.
  • UNACCEPTABLE: Risk level is unacceptable.

Example request

{
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

requestIdstring

The unique request identifier for the API call made.

Example response

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}