Skip to main content
POST
/
v2
/
search
/
serviceprofiles
Search for individual 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 '
{
  "search": {
    "type": "EXACT",
    "terms": [
      {
        "term": "<string>",
        "field": "NAME"
      }
    ]
  },
  "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": [
      "INIT"
    ],
    "workflowNames": [
      "<string>"
    ],
    "workflowExecutionStatuses": [
      {
        "overrideType": "ALL",
        "status": [
          "UNCHECKED"
        ]
      }
    ],
    "statusOverrideType": "ALL",
    "workflowStatuses": [
      "UNCHECKED"
    ],
    "issueCategories": [
      "AML"
    ],
    "issueSeverities": [
      "INFO"
    ],
    "riskLevels": [
      "UNKNOWN"
    ],
    "issues": [
      "AML_ISSUE"
    ],
    "workflowExecutionScope": "LAST"
  }
}
'
{
  "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>",
          "organizationType": "SOLE TRADER",
          "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_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

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-Username
string

Username provided by API caller

Example:

"[email protected]"

Query Parameters

​
sortFields
string[]

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

​
sort
enum<string>

Order of the sort fields will be sorted upon

Available options:
asc,
desc
​
page
integer

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

​
limit
integer
default:20

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

Required range: x >= 1

Body

application/json

Search for an individual profile

​
search
object
​
filters
object

Response

OK

​
meta
object

Meta information about the request and response returned during a list operation.

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
matches
object[][]