Search for profiles
curl --request POST \
--url https://api.uat.frankie.one/v2/search/serviceprofiles \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"filters": {
"entityIds": [
"<string>"
],
"entityTypes": [
"INDIVIDUAL",
"ORGANIZATION"
],
"createdAtBefore": "2023-11-07T05:31:56Z",
"createdAtAfter": "2023-11-07T05:31:56Z",
"updatedAtAfter": "2023-11-07T05:31:56Z",
"updatedAtBefore": "2023-11-07T05:31:56Z",
"assignees": [
"<string>"
],
"reviewers": [
"<string>"
],
"states": [],
"workflowNames": [
"<string>"
],
"workflowExecutionStatuses": [
{
"overrideType": "ALL",
"status": [
"UNCHECKED"
]
}
],
"statusOverrideType": "ALL",
"workflowStatuses": [
"UNCHECKED"
],
"issueCategories": [],
"issueSeverities": [],
"riskLevels": [],
"issues": [],
"workflowExecutionScope": "LAST",
"countries": [
"<string>"
]
}
}
'import requests
url = "https://api.uat.frankie.one/v2/search/serviceprofiles"
payload = { "filters": {
"entityIds": ["<string>"],
"entityTypes": ["INDIVIDUAL", "ORGANIZATION"],
"createdAtBefore": "2023-11-07T05:31:56Z",
"createdAtAfter": "2023-11-07T05:31:56Z",
"updatedAtAfter": "2023-11-07T05:31:56Z",
"updatedAtBefore": "2023-11-07T05:31:56Z",
"assignees": ["<string>"],
"reviewers": ["<string>"],
"states": [],
"workflowNames": ["<string>"],
"workflowExecutionStatuses": [
{
"overrideType": "ALL",
"status": ["UNCHECKED"]
}
],
"statusOverrideType": "ALL",
"workflowStatuses": ["UNCHECKED"],
"issueCategories": [],
"issueSeverities": [],
"riskLevels": [],
"issues": [],
"workflowExecutionScope": "LAST",
"countries": ["<string>"]
} }
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filters: {
entityIds: ['<string>'],
entityTypes: ['INDIVIDUAL', 'ORGANIZATION'],
createdAtBefore: '2023-11-07T05:31:56Z',
createdAtAfter: '2023-11-07T05:31:56Z',
updatedAtAfter: '2023-11-07T05:31:56Z',
updatedAtBefore: '2023-11-07T05:31:56Z',
assignees: ['<string>'],
reviewers: ['<string>'],
states: [],
workflowNames: ['<string>'],
workflowExecutionStatuses: [{overrideType: 'ALL', status: ['UNCHECKED']}],
statusOverrideType: 'ALL',
workflowStatuses: ['UNCHECKED'],
issueCategories: [],
issueSeverities: [],
riskLevels: [],
issues: [],
workflowExecutionScope: 'LAST',
countries: ['<string>']
}
})
};
fetch('https://api.uat.frankie.one/v2/search/serviceprofiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uat.frankie.one/v2/search/serviceprofiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'entityIds' => [
'<string>'
],
'entityTypes' => [
'INDIVIDUAL',
'ORGANIZATION'
],
'createdAtBefore' => '2023-11-07T05:31:56Z',
'createdAtAfter' => '2023-11-07T05:31:56Z',
'updatedAtAfter' => '2023-11-07T05:31:56Z',
'updatedAtBefore' => '2023-11-07T05:31:56Z',
'assignees' => [
'<string>'
],
'reviewers' => [
'<string>'
],
'states' => [
],
'workflowNames' => [
'<string>'
],
'workflowExecutionStatuses' => [
[
'overrideType' => 'ALL',
'status' => [
'UNCHECKED'
]
]
],
'statusOverrideType' => 'ALL',
'workflowStatuses' => [
'UNCHECKED'
],
'issueCategories' => [
],
'issueSeverities' => [
],
'riskLevels' => [
],
'issues' => [
],
'workflowExecutionScope' => 'LAST',
'countries' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uat.frankie.one/v2/search/serviceprofiles"
payload := strings.NewReader("{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uat.frankie.one/v2/search/serviceprofiles")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/search/serviceprofiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"meta": {
"page": 123,
"total": 123,
"limit": 123,
"count": 123,
"sort": "asc",
"sortFields": [
"createdAt"
]
},
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"matches": [
[
{
"serviceProfile": {
"serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
"latestRiskAssessmentId": "<string>",
"latestWorkflowExecutionId": "<string>",
"entityId": "<string>",
"entityName": "<string>",
"entityType": "<string>",
"country": "AUS",
"schemaVersion": 2,
"createdAt": "2024-01-15T02:18:11.365Z",
"createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
"createdBy": "Ryan Reynolds",
"updatedAt": "2024-01-15T02:18:11.365Z",
"updatedBy": "Ryan Reynolds",
"updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
"assignee": "Ryan Gosling",
"reviewer": "Ryan Trahan",
"currentWorkflowId": "<string>",
"currentWorkflowName": "<string>",
"workflowSummaries": [
{
"schemaVersion": 123,
"workflowName": "<string>",
"workflowExecutionId": "<string>",
"workflowExecutionState": "COMPLETED",
"status": "UNCHECKED",
"statusOverrideAt": "2023-11-07T05:31:56Z",
"statusOverrideRequestId": "<string>",
"statusOverrideBy": "<string>",
"riskAssessment": {
"serviceProfileId": "<string>",
"workflowId": "<string>",
"workflowExecutionId": "<string>",
"entityId": "<string>",
"riskAssessmentId": "<string>",
"schemaVersion": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"workflowRiskScore": 123,
"workflowRiskLevel": "UNKNOWN",
"riskScore": 123,
"riskLevel": "UNKNOWN",
"isOutdated": false,
"riskFactors": [
{
"riskFactorId": "<string>",
"factor": "<string>",
"value": "<string>",
"score": 123,
"description": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"manualOverrideScore": 123,
"status": "VALID",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"createdServiceProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdWorkflowExecutionId": "<string>",
"createdStepResultId": "<string>"
}
]
},
"isManual": true,
"steps": {
"order": [
"<string>"
],
"passed": [
"<string>"
],
"failed": [
"<string>"
],
"incomplete": [
"<string>"
],
"notApplicable": [
"<string>"
]
},
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"issues": [
{
"category": "AML",
"issue": "AML_ISSUE",
"severity": "INFO",
"issueId": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"isCleared": true,
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>"
}
],
"lifecyclePhase": "OTHER",
"monitoringTypes": [
"AML"
]
}
],
"serviceName": "<string>",
"customerReference": "<string>",
"subscriptions": [
{
"serviceProfileId": "<string>",
"status": "ENABLED",
"type": "AML",
"workflowName": "<string>",
"workflowId": "<string>",
"enabledAt": "2023-11-07T05:31:56Z",
"enabledRequestId": "<string>",
"enabledBy": "<string>",
"disabledAt": "2023-11-07T05:31:56Z",
"disabledRequestId": "<string>",
"disabledBy": "<string>"
}
],
"state": "INIT"
},
"confidence": 0.5,
"fieldsMatched": [
{
"field": "NAME",
"confidence": 0.5
}
]
}
]
]
}
Search
Search for profiles
Search for Individuals and Organizations that match the provided search parameters. Search parameters are supplied in the form of an entity object.
POST
/
v2
/
search
/
serviceprofiles
Search for profiles
curl --request POST \
--url https://api.uat.frankie.one/v2/search/serviceprofiles \
--header 'Content-Type: application/json' \
--header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
--header 'api_key: <api-key>' \
--data '
{
"filters": {
"entityIds": [
"<string>"
],
"entityTypes": [
"INDIVIDUAL",
"ORGANIZATION"
],
"createdAtBefore": "2023-11-07T05:31:56Z",
"createdAtAfter": "2023-11-07T05:31:56Z",
"updatedAtAfter": "2023-11-07T05:31:56Z",
"updatedAtBefore": "2023-11-07T05:31:56Z",
"assignees": [
"<string>"
],
"reviewers": [
"<string>"
],
"states": [],
"workflowNames": [
"<string>"
],
"workflowExecutionStatuses": [
{
"overrideType": "ALL",
"status": [
"UNCHECKED"
]
}
],
"statusOverrideType": "ALL",
"workflowStatuses": [
"UNCHECKED"
],
"issueCategories": [],
"issueSeverities": [],
"riskLevels": [],
"issues": [],
"workflowExecutionScope": "LAST",
"countries": [
"<string>"
]
}
}
'import requests
url = "https://api.uat.frankie.one/v2/search/serviceprofiles"
payload = { "filters": {
"entityIds": ["<string>"],
"entityTypes": ["INDIVIDUAL", "ORGANIZATION"],
"createdAtBefore": "2023-11-07T05:31:56Z",
"createdAtAfter": "2023-11-07T05:31:56Z",
"updatedAtAfter": "2023-11-07T05:31:56Z",
"updatedAtBefore": "2023-11-07T05:31:56Z",
"assignees": ["<string>"],
"reviewers": ["<string>"],
"states": [],
"workflowNames": ["<string>"],
"workflowExecutionStatuses": [
{
"overrideType": "ALL",
"status": ["UNCHECKED"]
}
],
"statusOverrideType": "ALL",
"workflowStatuses": ["UNCHECKED"],
"issueCategories": [],
"issueSeverities": [],
"riskLevels": [],
"issues": [],
"workflowExecutionScope": "LAST",
"countries": ["<string>"]
} }
headers = {
"api_key": "<api-key>",
"X-Frankie-CustomerID": "<x-frankie-customerid>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
api_key: '<api-key>',
'X-Frankie-CustomerID': '<x-frankie-customerid>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filters: {
entityIds: ['<string>'],
entityTypes: ['INDIVIDUAL', 'ORGANIZATION'],
createdAtBefore: '2023-11-07T05:31:56Z',
createdAtAfter: '2023-11-07T05:31:56Z',
updatedAtAfter: '2023-11-07T05:31:56Z',
updatedAtBefore: '2023-11-07T05:31:56Z',
assignees: ['<string>'],
reviewers: ['<string>'],
states: [],
workflowNames: ['<string>'],
workflowExecutionStatuses: [{overrideType: 'ALL', status: ['UNCHECKED']}],
statusOverrideType: 'ALL',
workflowStatuses: ['UNCHECKED'],
issueCategories: [],
issueSeverities: [],
riskLevels: [],
issues: [],
workflowExecutionScope: 'LAST',
countries: ['<string>']
}
})
};
fetch('https://api.uat.frankie.one/v2/search/serviceprofiles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uat.frankie.one/v2/search/serviceprofiles",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filters' => [
'entityIds' => [
'<string>'
],
'entityTypes' => [
'INDIVIDUAL',
'ORGANIZATION'
],
'createdAtBefore' => '2023-11-07T05:31:56Z',
'createdAtAfter' => '2023-11-07T05:31:56Z',
'updatedAtAfter' => '2023-11-07T05:31:56Z',
'updatedAtBefore' => '2023-11-07T05:31:56Z',
'assignees' => [
'<string>'
],
'reviewers' => [
'<string>'
],
'states' => [
],
'workflowNames' => [
'<string>'
],
'workflowExecutionStatuses' => [
[
'overrideType' => 'ALL',
'status' => [
'UNCHECKED'
]
]
],
'statusOverrideType' => 'ALL',
'workflowStatuses' => [
'UNCHECKED'
],
'issueCategories' => [
],
'issueSeverities' => [
],
'riskLevels' => [
],
'issues' => [
],
'workflowExecutionScope' => 'LAST',
'countries' => [
'<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Frankie-CustomerID: <x-frankie-customerid>",
"api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uat.frankie.one/v2/search/serviceprofiles"
payload := strings.NewReader("{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("api_key", "<api-key>")
req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uat.frankie.one/v2/search/serviceprofiles")
.header("api_key", "<api-key>")
.header("X-Frankie-CustomerID", "<x-frankie-customerid>")
.header("Content-Type", "application/json")
.body("{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uat.frankie.one/v2/search/serviceprofiles")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filters\": {\n \"entityIds\": [\n \"<string>\"\n ],\n \"entityTypes\": [\n \"INDIVIDUAL\",\n \"ORGANIZATION\"\n ],\n \"createdAtBefore\": \"2023-11-07T05:31:56Z\",\n \"createdAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtAfter\": \"2023-11-07T05:31:56Z\",\n \"updatedAtBefore\": \"2023-11-07T05:31:56Z\",\n \"assignees\": [\n \"<string>\"\n ],\n \"reviewers\": [\n \"<string>\"\n ],\n \"states\": [],\n \"workflowNames\": [\n \"<string>\"\n ],\n \"workflowExecutionStatuses\": [\n {\n \"overrideType\": \"ALL\",\n \"status\": [\n \"UNCHECKED\"\n ]\n }\n ],\n \"statusOverrideType\": \"ALL\",\n \"workflowStatuses\": [\n \"UNCHECKED\"\n ],\n \"issueCategories\": [],\n \"issueSeverities\": [],\n \"riskLevels\": [],\n \"issues\": [],\n \"workflowExecutionScope\": \"LAST\",\n \"countries\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"meta": {
"page": 123,
"total": 123,
"limit": 123,
"count": 123,
"sort": "asc",
"sortFields": [
"createdAt"
]
},
"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
"matches": [
[
{
"serviceProfile": {
"serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
"latestRiskAssessmentId": "<string>",
"latestWorkflowExecutionId": "<string>",
"entityId": "<string>",
"entityName": "<string>",
"entityType": "<string>",
"country": "AUS",
"schemaVersion": 2,
"createdAt": "2024-01-15T02:18:11.365Z",
"createdRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
"createdBy": "Ryan Reynolds",
"updatedAt": "2024-01-15T02:18:11.365Z",
"updatedBy": "Ryan Reynolds",
"updatedRequestId": "01HMR2ERSKCYAVXKS1FKSRT2T4",
"assignee": "Ryan Gosling",
"reviewer": "Ryan Trahan",
"currentWorkflowId": "<string>",
"currentWorkflowName": "<string>",
"workflowSummaries": [
{
"schemaVersion": 123,
"workflowName": "<string>",
"workflowExecutionId": "<string>",
"workflowExecutionState": "COMPLETED",
"status": "UNCHECKED",
"statusOverrideAt": "2023-11-07T05:31:56Z",
"statusOverrideRequestId": "<string>",
"statusOverrideBy": "<string>",
"riskAssessment": {
"serviceProfileId": "<string>",
"workflowId": "<string>",
"workflowExecutionId": "<string>",
"entityId": "<string>",
"riskAssessmentId": "<string>",
"schemaVersion": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"workflowRiskScore": 123,
"workflowRiskLevel": "UNKNOWN",
"riskScore": 123,
"riskLevel": "UNKNOWN",
"isOutdated": false,
"riskFactors": [
{
"riskFactorId": "<string>",
"factor": "<string>",
"value": "<string>",
"score": 123,
"description": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"manualOverrideScore": 123,
"status": "VALID",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>",
"createdServiceProfileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdWorkflowExecutionId": "<string>",
"createdStepResultId": "<string>"
}
]
},
"isManual": true,
"steps": {
"order": [
"<string>"
],
"passed": [
"<string>"
],
"failed": [
"<string>"
],
"incomplete": [
"<string>"
],
"notApplicable": [
"<string>"
]
},
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"issues": [
{
"category": "AML",
"issue": "AML_ISSUE",
"severity": "INFO",
"issueId": "<string>",
"workflowExecutionId": "<string>",
"stepResultId": "<string>",
"isCleared": true,
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"updatedBy": "<string>",
"updatedRequestId": "<string>"
}
],
"lifecyclePhase": "OTHER",
"monitoringTypes": [
"AML"
]
}
],
"serviceName": "<string>",
"customerReference": "<string>",
"subscriptions": [
{
"serviceProfileId": "<string>",
"status": "ENABLED",
"type": "AML",
"workflowName": "<string>",
"workflowId": "<string>",
"enabledAt": "2023-11-07T05:31:56Z",
"enabledRequestId": "<string>",
"enabledBy": "<string>",
"disabledAt": "2023-11-07T05:31:56Z",
"disabledRequestId": "<string>",
"disabledBy": "<string>"
}
],
"state": "INIT"
},
"confidence": 0.5,
"fieldsMatched": [
{
"field": "NAME",
"confidence": 0.5
}
]
}
]
]
}
Authorizations
Api-Keyjwt
Headers
Your API key provided by FrankieOne
Example:
"245c765b124a098d09ef8765...."
Your Customer ID provided by FrankieOne
Example:
"12345678-1234-1234-1234-123456789012"
Your Customer Child ID provided by FrankieOne
Example:
"87654321-4321-4321-4321-210987654321"
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.
Username provided by API caller
Example:
"fred.flintstone@frankieone.com"
Query Parameters
List of fields that the Process Results will be filtered with Available values : createdAt, updatedAt
Order of the sort fields will be sorted upon
Available options:
asc, desc The page number that you want to retrieve for the list query
Limit the number of items that will be returned as part of the request
Required range:
x >= 1Body
application/json
Search for a profile
Was this page helpful?