The identity and technical contract details declared by the specification.
Supplementary-Data-AuditEvent-Activity-Detail
object
2 properties
Supplementary-Data-AuditEvent-Fraud-Details
object
Details of a single fraud check result.
3 properties
Supplementary-Data-AuditEvent-KYC
object
Contains requirements and results for KYC supplementary data.
Attribute
object
2 properties
2 required
Object-Type
string
The type of object being annotated.
Supplementary-Data-AuditEvent-AML
object
Includes requirements and results for AML supplementary data.
Supplementary-Data-AuditEvent-Fraud
object
Contains details relevant to fraud hits for an audit event.
Supplementary-Data-AuditEvent-Individual-Change
object
Contains information about changes to individual KYC supplementary data, including added, updated, invalidated fields, and validation issues.
Workflow-Step-Risk-Result-Detail
object
Details of a calculated risk result for a workflow step.
3 properties
3 required
Supplementary-Data-AuditEvent-Risk-Override
object
Contains all details related to a risk override event, including: - The previous risk profile (score and level before the override). - The current risk profile…
Workflow-Execution-ResultEnum
string
Outcome of this workflow execution. Possible results: - UNCHECKED: The workflow has not yet been run and has no result. - INPROGRESS: The workflow is currently…
Audit
object
32 properties
10 required
Organization-Registry
object
2 properties
Request-ID
string
The unique request identifier for the API call made.
Workflow-Step-Risk-Result
object
Calculated risk result for a workflow step.
4 properties
Supplementary-Data-AuditEvent-Matchlist-Entries
object
Contains audit event details for managing multiple matchlist entries. Only a summary of the changes is provided, not the full list of entries. For a single ope…
Workflow-Step-Summary-Entity-Lookup-Residential
object
2 properties
2 required
Supplementary-Data-AuditEvent-KYC-Connector
object
Contains requirements and results for KYC Connector supplementary data.
Audit-Matchlist-Entry
object
A single entry in a matchlist. For bulk operations, use Audit-Matchlist-Entries.
Risk-Level
string
The risk level classification: - UNKNOWN: Risk level is not determined. - LOW: Low risk. - MEDIUM: Medium risk. - HIGH: High risk. - UNACCEPTABLE: Risk level i…
Comment
object
2 properties
Supplementary-Data-AuditEvent-Organization-Data-Fetch-Connector
object
Contains details relevant to KYB Connector audit events.
Audit-Event-Connector-Config
object
3 properties
Supplementary-Data-AuditEvent-Result-Update
object
Contains details about changes to results.
Matchlist-Entry-State
string
The state of the matchlist entry. - ACTIVE: The matchlist entry is active and can be used for matching. - EXPIRED: The matchlist entry has expired. It is visib…
Audit-Event-Organization-Entity-Match
object
Details of the entity matching process during creation, specifically for KYB (Know Your Business).
5 properties
Supplementary-Data-AuditEvent-AML-Connector
object
Includes requirements and results for AML Connector supplementary data.
Workflow-Step-Summary-Entity-Lookup-Address
object
Object containing address details, categorized by address type. Each address type may include specific properties relevant to its context.
1 property
Supplementary-Data-AuditEvent-Base
object
3 properties
1 required
Audit-Event-Change
object
3 properties
Supplementary-Data-AuditEvent-Activity
object
Contains details relevant to activity monitoring hits for an audit event.
Audit-Result-Change
object
5 properties
Entity-ID
string
Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required.…
Supplementary-Data-AuditEvent-Matchlist-Entry
object
Contains audit event details for managing a single matchlist entry. For bulk operations, use Supplementary-Data-AuditEvent-Matchlist-Entries.
2 required
List-Operation-Meta
object
Meta information about the request and response returned during a list operation.
6 properties
Audit-Event-Error
object
3 properties
Supplementary-Data-AuditEvent-IDV
object
Contains requirements and results for KYC supplementary data.
Fraud-Check-Types
string
The supported types of fraud checks.
Supplementary-Data-AuditEvent-Decision
object
Includes requirements and results for Decision Step supplementary data.
Matchlist-Action
string
Default action recommended for a match. The action can be one of the following: - BLOCK: Recommended action is to block the entity. - ALERT: Recommended action…
Matchlist-Base
object
Basic details about a matchlist, excluding metadata.
6 properties
Audit-Event-Risk-Override-Result
object
Represents the risk profile of an entity before and after a risk override, including details about the type of override applied.
3 properties
1 required
Risk-Factor-Status
string
The current status of the risk factor: - VALID: The risk factor is applicable to the entity. - STALE: The risk factor is no longer applicable to the entity. If…
Activity-ID
string
Activity ID that identifies an activity within the Frankie platform
Issue
object
3 properties
Supplementary-Data-AuditEvent-Entity-Lookup
object
Contains details relevant to entity lookup for an audit event.
Audit-Event-Origin
object
Specifies the origin of the entity being audited, which may include its source or creation context. Provides details on how and why the entity was created, tra…
3 properties
AuditEvent-Channel
string
The channel through which the audit event was generated.
Matchlist-ID
string
Matchlists are assigned an auto-generated UUID to ensure global uniqueness, represented as matchlistId. The matchlistId allows for precise modification when re…
Audit-Matchlist
object
Contains details about a matchlist used in an audit event.
1 property
AuditEvent-Type
string
Type of the audit event. - CUSTOMERSETUP: Audit event for customer setup. - CUSTOMERUPDATE: Audit event for updating a customer. - ENTITYCREATE: Create entity.…
Supplementary-Data-AuditEvent-IDV-Connector
object
Contains requirements and results for IDV Connector supplementary data.
Supplementary-Data-AuditEvent-Activity-Result
object
4 properties
Supplementary-Data-AuditEvent-Duplicate
object
Contains details relevant to duplicate hits for an audit event.
Supplementary-Data-AuditEvent-Matchlist-Result
object
Contains audit event details for matchlist screening results.
Code-Description
object
2 properties
Audit-Event-Result-Summary
object
5 properties
Supplementary-Data-AuditEvent-Base-Connector
object
1 required
Audit-Matchlist-Entries
object
Audit event details for managing multiple matchlist entries. This provides a summary of the changes, not the full list of entries. For a single operation, use…
4 properties
Workflow-LifecyclePhaseEnum
string
Specifies the lifecycle phase of the customer in which this workflow is executed: - ONBOARDING: Workflow is in the onboarding stage. - MONITORING: Workflow is…
Entity-Type
string
The type of entity within Frankie. This can be "INDIVIDUAL", "ORGANIZATION", or "UNKNOWN".
Audit-Event-Risk-Factor-Override-Data
object
Information about a risk factor that has been manually overridden, including details of the factor, original and override scores, and the override process.
5 properties
3 required
Error-Base
object
3 properties
Supplementary-Data-AuditEvent-Risk-Assessment
object
Contains risk profile, results, and both current and previous risk scores and risk levels at the time of risk assessment step execution.
Matchlist-Entry-Reason-Code
string
The reason code for the matchlist entry. This code will be translated to a configured description string. Supported codes are 1 to 24 characters long, consisti…
Supplementary-Data-AuditEvent-Entity-Profile-State-Change
object
Contains details relevant to changes in the state of an entity or its service profiles. If the serviceProfileId is omitted, the state change applies to all ser…
Process-Result-ID
string
When a process result object is first created, it is assigned an ID. When updating the process result object, set the processResultID to the ID of the process…
Matchlist-Entry-Base
object
Basic details about a matchlist entry, excluding metadata.
5 properties
Supplementary-Data-AuditEvent-KYB
object
Captures details relevant to KYB processes and is associated with specific KYB-related audit events. Associated audit events include: creation of an entity, cr…
Supplementary-Data-AuditEvent-Matchlist
object
Contains details relevant to managing a matchlist for an audit event.
Service-Profile-State
string
Current state of the Service Profile - INIT: Initial state when the profile is created. - AUTO: Automatically assigned state, typically after initial processin…
Matchlist-Entry-Attribute-Type
string
Entity attributes eligible for screening. A matchlist entry may not contain both ORG and IND attributes, and they must match the ENTITYTYPE if it is provided.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs FrankieOne publishes across the network.
