Search for individual profiles

POST

Search for Individuals that match the provided search parameters. Search parameters are supplied in the form of an entity object, similar to how you would create an individual.

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

sortFieldsstringOptional

List of fields that the Process Results will be filtered with Available values : createdAt, updatedAt

sortenumOptional

Order of the sort fields will be sorted upon

Allowed values: ascdesc

pageintegerOptional

The page number that you want to retrieve for the list query

limitintegerOptional>=1Defaults to 20

Limit the number of items that will be returned as part of the request

Request

This endpoint expects an object.

searchobjectOptional

filtersobjectOptional

Response

metaobjectOptional

Meta information about the request and response that will be returned during a list operation

requestIdstringOptional

The unique request ID for the API call made.

matcheslist of lists of objectsOptional

POST

1 curl -X POST https://api.uat.frankie.one/v2/search/serviceprofiles \
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>" \
6      -H "Content-Type: application/json" \
7      -d '{}'

200Successful

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

Get all documents for an entity

Up Next

Built with

1	curl -X POST https://api.uat.frankie.one/v2/search/serviceprofiles \
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>" \
6	-H "Content-Type: application/json" \
7	-d '{}'

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