Get current monitoring status for a given entity

GET

Get current monitoring status for a given entity.

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

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.

Response

requestIdstringOptional

The unique request ID for the API call made.

monitoringlist of objectsOptional

subscriptionslist of objectsOptional

GET

1 curl https://api.uat.frankie.one/v2/individuals/entityId/monitor \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "api_key: <apiKey>"

200Retrieved

1 {
2   "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3   "monitoring": [
4     {
5       "status": "ENABLED",
6       "type": "AML"
7     }
8   ],
9   "subscriptions": [
10     {
11       "serviceProfileId": "serviceProfileId",
12       "status": "ENABLED",
13       "type": "AML",
14       "workflowName": "workflowName",
15       "workflowId": "workflowId",
16       "enabledAt": "2024-01-15T09:30:00Z",
17       "enabledRequestId": "enabledRequestId",
18       "enabledBy": "enabledBy",
19       "disabledAt": "2024-01-15T09:30:00Z",
20       "disabledRequestId": "disabledRequestId",
21       "disabledBy": "disabledBy"
22     }
23   ]
24 }

Turn on/off monitoring for a given entity

Up Next

Built with

1	curl https://api.uat.frankie.one/v2/individuals/entityId/monitor \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: <apiKey>"

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"monitoring": [
4	{
5	"status": "ENABLED",
6	"type": "AML"
7	}
8	],
9	"subscriptions": [
10	{
11	"serviceProfileId": "serviceProfileId",
12	"status": "ENABLED",
13	"type": "AML",
14	"workflowName": "workflowName",
15	"workflowId": "workflowId",
16	"enabledAt": "2024-01-15T09:30:00Z",
17	"enabledRequestId": "enabledRequestId",
18	"enabledBy": "enabledBy",
19	"disabledAt": "2024-01-15T09:30:00Z",
20	"disabledRequestId": "disabledRequestId",
21	"disabledBy": "disabledBy"
22	}
23	]
24	}