Update a profile for a given individual entity. | FrankieOne

1 curl -X PATCH https://api.uat.frankie.one/v2/individuals/entityId/serviceprofiles/serviceName \ 2 -H "api_key: <apiKey>" \ 3 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \ 4 -H "Content-Type: application/json" \ 5 -d '{}'

1 { 2 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 3 "serviceProfile": { 4 "assignee": "Ryan Gosling", 5 "country": "AUS", 6 "createdAt": "2024-01-15T02:18:11.365Z", 7 "createdBy": "Ryan Reynolds", 8 "createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4", 9 "currentWorkflowId": "foo", 10 "currentWorkflowName": "foo", 11 "customerReference": "foo", 12 "entityId": "foo", 13 "entityName": "foo", 14 "entityType": "foo", 15 "latestRiskAssessmentId": "foo", 16 "latestWorkflowExecutionId": "foo", 17 "organizationType": "SOLE TRADER", 18 "reviewer": "Ryan Trahan", 19 "schemaVersion": 2, 20 "serviceName": "foo", 21 "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd", 22 "state": "INIT", 23 "subscriptions": [ 24 { 25 "serviceProfileId": "foo", 26 "status": "ENABLED", 27 "type": "AML", 28 "workflowName": "foo", 29 "workflowId": "foo", 30 "enabledAt": "foo", 31 "enabledRequestId": "foo", 32 "enabledBy": "foo", 33 "disabledAt": "foo", 34 "disabledRequestId": "foo", 35 "disabledBy": "foo" 36 } 37 ], 38 "updatedAt": "2024-01-15T02:18:11.365Z", 39 "updatedBy": "Ryan Reynolds", 40 "updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4", 41 "workflowSummaries": [ 42 { 43 "schemaVersion": 42, 44 "workflowName": "foo", 45 "workflowExecutionId": "foo", 46 "workflowExecutionState": "COMPLETED", 47 "status": "UNCHECKED", 48 "statusOverrideAt": "foo", 49 "statusOverrideRequestId": "foo", 50 "statusOverrideBy": "foo", 51 "riskAssessment": { 52 "serviceProfileId": "foo", 53 "workflowId": "foo", 54 "workflowExecutionId": "foo", 55 "entityId": "foo", 56 "riskAssessmentId": "foo", 57 "schemaVersion": 42, 58 "createdAt": "foo", 59 "updatedAt": "foo", 60 "updatedBy": "foo", 61 "updatedRequestId": "foo", 62 "workflowRiskScore": 42, 63 "workflowRiskLevel": "UNKNOWN", 64 "riskScore": 42, 65 "riskLevel": "UNKNOWN", 66 "isOutdated": false, 67 "riskFactors": [ 68 { 69 "riskFactorId": "foo", 70 "factor": "foo", 71 "value": "foo", 72 "score": 42, 73 "description": "foo", 74 "workflowExecutionId": "foo", 75 "stepResultId": "foo", 76 "manualOverrideScore": 42, 77 "status": "VALID", 78 "createdAt": "foo", 79 "updatedAt": "foo", 80 "updatedBy": "foo", 81 "updatedRequestId": "foo", 82 "createdServiceProfileId": "foo", 83 "createdWorkflowExecutionId": "foo", 84 "createdStepResultId": "foo" 85 } 86 ] 87 }, 88 "isManual": true, 89 "steps": { 90 "order": [ 91 "foo" 92 ], 93 "passed": [ 94 "foo" 95 ], 96 "failed": [ 97 "foo" 98 ], 99 "incomplete": [ 100 "foo" 101 ], 102 "notApplicable": [ 103 "foo" 104 ] 105 }, 106 "startedAt": "foo", 107 "endedAt": "foo", 108 "issues": [ 109 { 110 "category": "AML", 111 "issue": "AML_ISSUE", 112 "severity": "INFO", 113 "issueId": "foo", 114 "workflowExecutionId": "foo", 115 "stepResultId": "foo", 116 "isCleared": true, 117 "createdBy": "foo", 118 "createdAt": "foo", 119 "updatedAt": "foo", 120 "updatedBy": "foo", 121 "updatedRequestId": "foo" 122 } 123 ], 124 "lifecyclePhase": "OTHER", 125 "monitoringTypes": [ 126 "foo" 127 ] 128 } 129 ] 130 } 131 }

Update a profile for a given individual entity.

Path parameters

entityIdstringRequired

serviceNamestringRequired

Headers

Request

This endpoint expects an object.

serviceProfileobjectOptional

commentobjectOptional

Response

requestIdstring or null

The unique request ID for the API call made.

serviceProfileobject or null

Path parameters

Headers

Request

Response

Errors