Get a service profile for a given individual entity.

curl --request GET \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'

import requests

url = "https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}"

headers = {
    "api_key": "<api-key>",
    "X-Frankie-CustomerID": "<x-frankie-customerid>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {api_key: '<api-key>', 'X-Frankie-CustomerID': '<x-frankie-customerid>'}
};

fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}', 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/individuals/{entityId}/serviceprofiles/{serviceName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}")
  .header("api_key", "<api-key>")
  .header("X-Frankie-CustomerID", "<x-frankie-customerid>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'

response = http.request(request)
puts response.read_body

{
  "serviceProfile": {
    "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
    "latestRiskAssessmentId": "<string>",
    "latestWorkflowExecutionId": "<string>",
    "entityId": "<string>",
    "entityName": "<string>",
    "entityType": "<string>",
    "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>",
        "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,
          "riskScore": 123,
          "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": [
          {
            "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": []
      }
    ],
    "serviceName": "<string>",
    "customerReference": "<string>",
    "subscriptions": [
      {
        "serviceProfileId": "<string>",
        "workflowName": "<string>",
        "workflowId": "<string>",
        "enabledAt": "2023-11-07T05:31:56Z",
        "enabledRequestId": "<string>",
        "enabledBy": "<string>",
        "disabledAt": "2023-11-07T05:31:56Z",
        "disabledRequestId": "<string>",
        "disabledBy": "<string>"
      }
    ]
  },
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

GET

individuals

{entityId}

serviceprofiles

{serviceName}

Get a service profile for a given individual entity.

curl --request GET \
  --url https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName} \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'

import requests

url = "https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}"

headers = {
    "api_key": "<api-key>",
    "X-Frankie-CustomerID": "<x-frankie-customerid>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {api_key: '<api-key>', 'X-Frankie-CustomerID': '<x-frankie-customerid>'}
};

fetch('https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}', 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/individuals/{entityId}/serviceprofiles/{serviceName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("X-Frankie-CustomerID", "<x-frankie-customerid>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}")
  .header("api_key", "<api-key>")
  .header("X-Frankie-CustomerID", "<x-frankie-customerid>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.uat.frankie.one/v2/individuals/{entityId}/serviceprofiles/{serviceName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["api_key"] = '<api-key>'
request["X-Frankie-CustomerID"] = '<x-frankie-customerid>'

response = http.request(request)
puts response.read_body

{
  "serviceProfile": {
    "serviceProfileId": "55fc5d54-46f7-49c8-bf78-e07ec79c42fd",
    "latestRiskAssessmentId": "<string>",
    "latestWorkflowExecutionId": "<string>",
    "entityId": "<string>",
    "entityName": "<string>",
    "entityType": "<string>",
    "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>",
        "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,
          "riskScore": 123,
          "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": [
          {
            "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": []
      }
    ],
    "serviceName": "<string>",
    "customerReference": "<string>",
    "subscriptions": [
      {
        "serviceProfileId": "<string>",
        "workflowName": "<string>",
        "workflowId": "<string>",
        "enabledAt": "2023-11-07T05:31:56Z",
        "enabledRequestId": "<string>",
        "enabledBy": "<string>",
        "disabledAt": "2023-11-07T05:31:56Z",
        "disabledRequestId": "<string>",
        "disabledBy": "<string>"
      }
    ]
  },
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

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:

"fred.flintstone@frankieone.com"

Path Parameters

entityId

string

required

Unique FrankieOne identifier for an entity

serviceName

string

required

The unique name of the service profile

Response

Service profile retrieved

serviceProfile

object

Show child attributes

requestId

string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

Override the status of a specific workflow execution.Update a profile for a given individual entity.

⌘I

Introduction

KYC V2 API

Transaction and Activity Monitoring V2 API

KYB V2 API

Core V2 API

Get a service profile for a given individual entity.

Authorizations

Headers

Path Parameters

Response