Update an individual entity's risk level for a service profile (v2.0.0) — FrankieOne

Update the current risk level of an Individual Entity with the matching entity ID.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

serviceNamestringRequired

The unique name of the service profile

Headers

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

Query parameters

riskLevelenumRequired

Set the current riskLevel for the given entity.

Allowed values: LOWMEDIUMHIGHVERY_HIGH

Response

serviceProfileIdstring

Unique ID of Service Profile.

workflowIdstring

Unique ID of the workflow.

workflowExecutionIdstring

Unique ID of the workflow execution.

entityIdstring

Unique ID of the entity.

riskAssessmentIdstringOptional

Unique ID of the risk assessment.

schemaVersionintegerOptional

Version of the risk assessment summary record schema.

createdAtdatetimeOptional

The timestamp when the risk assessment was created.

updatedAtdatetimeOptional

The timestamp when the risk assessment was updated.

updatedBystringOptional

Who updated this assessment

updatedRequestIdstringOptional

What was the ID of the request that updated this assessment

workflowRiskScoredoubleOptional

The risk score of the workflow.

workflowRiskLevelenumOptional

Allowed values: UNKNOWNLOWMEDIUMHIGHUNACCEPTABLE

The risk level of the workflow execution associated with this risk assessment

riskScoredoubleOptional

The risk score of the entity.

riskLevelenumOptional

Allowed values: UNKNOWNLOWMEDIUMHIGHUNACCEPTABLE

The risk level of the entity.

isOutdatedbooleanOptionalDefaults to false

Whether the assessment is currently out of date, based on the manually updated information or due to changes to risk factors that were assesssed

riskFactorslist of objectsOptional

1	curl -X PATCH "https://api.uat.frankie.one/v2/individuals/entityId/serviceprofiles/serviceName/risk?riskLevel=LOW" \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>"

1	{
2	"serviceProfileId": "serviceProfileId",
3	"workflowId": "workflowId",
4	"workflowExecutionId": "workflowExecutionId",
5	"entityId": "entityId",
6	"riskAssessmentId": "riskAssessmentId",
7	"schemaVersion": 1,
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z",
10	"updatedBy": "updatedBy",
11	"updatedRequestId": "updatedRequestId",
12	"workflowRiskScore": 1.1,
13	"workflowRiskLevel": "UNKNOWN",
14	"riskScore": 1.1,
15	"riskLevel": "UNKNOWN",
16	"isOutdated": true,
17	"riskFactors": [
18	{
19	"riskFactorId": "riskFactorId",
20	"factor": "factor",
21	"value": "value",
22	"score": 1.1,
23	"description": "description",
24	"workflowExecutionId": "workflowExecutionId",
25	"stepResultId": "stepResultId",
26	"manualOverrideScore": 1.1,
27	"status": "VALID",
28	"createdAt": "2024-01-15T09:30:00Z",
29	"updatedAt": "2024-01-15T09:30:00Z",
30	"updatedBy": "updatedBy",
31	"updatedRequestId": "updatedRequestId",
32	"createdServiceProfileId": "createdServiceProfileId",
33	"createdWorkflowExecutionId": "createdWorkflowExecutionId",
34	"createdStepResultId": "createdStepResultId"
35	}
36	]
37	}