KYC V2 APIIndividual 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.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

serviceNamestringRequired

The unique name of the service profile

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

X-Frankie-ChannelstringOptional

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-UsernamestringOptional

Username provided by API caller

Request

This endpoint expects an object.
commentobjectOptional
riskLevelenumOptional
Allowed values:

Response

OK

requestIdstringOptional

The unique request ID for the API call made.

riskAssessmentobjectOptional

Errors