Get a service profile for a given individual entity. (v2.0.0) — FrankieOne

Get a profile for a given individual entity.

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

Response

Service profile retrieved

serviceProfileobjectOptional

requestIdstringOptional

The unique request ID for the API call made.

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

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