List audit events

curl --request GET \
  --url https://api.uat.frankie.one/v2/audit \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "meta": {
    "page": 123,
    "total": 123,
    "limit": 123,
    "count": 123,
    "sort": "asc",
    "sortFields": [
      "createdAt"
    ]
  },
  "events": [
    {
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "schemaVersion": 2,
      "level": 2,
      "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
      "type": "CUSTOMER_SETUP",
      "timestamp": "2020-01-01T00:00:00.000Z",
      "source": "FrankieOne System",
      "description": "Executing Vendor Check for Entity",
      "channel": "API",
      "eventStatus": "SUCCESS",
      "elapsedTimeInMilliSeconds": 2,
      "functionName": "executeVendorCheck",
      "descriptionDetails": "A new entity has been created with the following attributes:\n - Name\n - Address\n",
      "objectId": "<string>",
      "objectType": "ADDRESS",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "<string>",
      "serviceProfileId": "<string>",
      "serviceName": "kyc",
      "status": "UNCHECKED",
      "workflowExecutionId": "<string>",
      "workflowName": "safe_harbour_1+1",
      "workflowVersion": "v23",
      "stepResultId": "<string>",
      "stepName": "kyc-equifax",
      "stepVersion": "v2.0.0",
      "riskScore": 10,
      "riskLevel": "UNKNOWN",
      "entityType": "INDIVIDUAL",
      "userComment": {
        "commentId": "01K3G4CCQ3DY3B1413S19M9QW1",
        "text": "Update after speaking to customer over the phone directly.",
        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entityType": "INDIVIDUAL"
      },
      "lifecyclePhase": "OTHER",
      "supplementaryData": {
        "type": "RISK_ASSESSMENT",
        "origin": {
          "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "entityType": "INDIVIDUAL",
          "details": [
            {
              "code": "<string>",
              "description": "<string>"
            }
          ]
        },
        "errors": [
          {
            "code": "<string>",
            "description": "<string>",
            "location": "<string>"
          }
        ],
        "previousRisk": {
          "riskScore": 123,
          "riskLevel": "UNKNOWN"
        },
        "risk": {
          "level": "<string>",
          "contributedScore": 123,
          "overallScore": 123,
          "factors": [
            {
              "factor": "<string>",
              "score": 123,
              "value": "<string>",
              "aggregationMethod": "<string>",
              "matchedRule": "<string>",
              "source": "<string>",
              "inputsConsidered": [
                {
                  "value": "<string>",
                  "score": 123
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

GET

audit

List audit events

curl --request GET \
  --url https://api.uat.frankie.one/v2/audit \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>'

{
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "meta": {
    "page": 123,
    "total": 123,
    "limit": 123,
    "count": 123,
    "sort": "asc",
    "sortFields": [
      "createdAt"
    ]
  },
  "events": [
    {
      "eventId": "123e4567-e89b-12d3-a456-426614174000",
      "schemaVersion": 2,
      "level": 2,
      "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
      "type": "CUSTOMER_SETUP",
      "timestamp": "2020-01-01T00:00:00.000Z",
      "source": "FrankieOne System",
      "description": "Executing Vendor Check for Entity",
      "channel": "API",
      "eventStatus": "SUCCESS",
      "elapsedTimeInMilliSeconds": 2,
      "functionName": "executeVendorCheck",
      "descriptionDetails": "A new entity has been created with the following attributes:\n - Name\n - Address\n",
      "objectId": "<string>",
      "objectType": "ADDRESS",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "batchId": "<string>",
      "serviceProfileId": "<string>",
      "serviceName": "kyc",
      "status": "UNCHECKED",
      "workflowExecutionId": "<string>",
      "workflowName": "safe_harbour_1+1",
      "workflowVersion": "v23",
      "stepResultId": "<string>",
      "stepName": "kyc-equifax",
      "stepVersion": "v2.0.0",
      "riskScore": 10,
      "riskLevel": "UNKNOWN",
      "entityType": "INDIVIDUAL",
      "userComment": {
        "commentId": "01K3G4CCQ3DY3B1413S19M9QW1",
        "text": "Update after speaking to customer over the phone directly.",
        "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "entityType": "INDIVIDUAL"
      },
      "lifecyclePhase": "OTHER",
      "supplementaryData": {
        "type": "RISK_ASSESSMENT",
        "origin": {
          "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "entityType": "INDIVIDUAL",
          "details": [
            {
              "code": "<string>",
              "description": "<string>"
            }
          ]
        },
        "errors": [
          {
            "code": "<string>",
            "description": "<string>",
            "location": "<string>"
          }
        ],
        "previousRisk": {
          "riskScore": 123,
          "riskLevel": "UNKNOWN"
        },
        "risk": {
          "level": "<string>",
          "contributedScore": 123,
          "overallScore": 123,
          "factors": [
            {
              "factor": "<string>",
              "score": 123,
              "value": "<string>",
              "aggregationMethod": "<string>",
              "matchedRule": "<string>",
              "source": "<string>",
              "inputsConsidered": [
                {
                  "value": "<string>",
                  "score": 123
                }
              ]
            }
          ]
        }
      }
    }
  ]
}

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.

Query Parameters

entityId

string

Entity ID

workflowNames

string[]

List of Workflow Names to filter the audit events upon

workflowRiskLevels

string[]

List of workflow risk levels to filter the audit events upon

sources

string[]

List of Sources that the audit events will be filtered upon

requestId

string

Request Identifier to filter the audit events upon

afterTimestamp

string<date>

Filter the Audit Events after the given filter based on the Event 'timestamp' value

beforeTimestamp

string<date>

Filter the Audit Events before the given filter based on the Event 'timestamp' value

channels

enum<string>[]

List of Channels to filter the audit events upon

The channel through which the audit event was generated.

Available options:

API,

PORTAL,

ONESDK,

SYSTEM

sort

enum<string>

Order of the sort fields will be sorted upon

Available options:

asc,

desc

sortFields

enum<string>[]

The list of sort fields that will be used in the query, the order of the sort fields will determine the order in which the items are sorted

Available options:

timestamp

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

Response

requestId

string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

Introduction

KYC V2 API

Transaction and Activity Monitoring V2 API

KYB V2 API - Preview

Core V2 API

List audit events

Authorizations

Headers

Query Parameters

Response