FrankieOne Individual Workflows API
The Individual Workflows API from FrankieOne — 5 operation(s) for individual workflows.
FrankieOne Individual Workflows API is one of 13 APIs that FrankieOne publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Individual Workflows. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 6 operations across 5 paths, and defines 209 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, https://api.uat.frankie.one.
6 operations
5 paths
209 schemas
3 GET1 PATCH2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
FrankieOne Individual Workflows API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as api_key (Api-Key).
It accepts HTTP bearer tokens (JWT) (jwt).
By default, every request must be authenticated.
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Individual Workflows 6
GET
/v2/workflows
Get a list of executable workflows
POST
/v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute
Create an individual and execute a workflow for the given service profile
POST
/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute
Execute a workflow for the given service profile
GET
/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions
Get a list of executions and their results
GET
/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}
Get the result of a specific execution by its executionId.
PATCH
/v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}
Override the status of a specific workflow execution.
Schemas 209
The contract defines 209 schemas that model the data the API accepts and returns. The most detailed are Service-Profile-Base (23 properties), Process-Result-Object (22 properties), Workflow-Execution-Result (20 properties), Address-Base (20 properties). Each schema is shown below with its type and property counts.
Supplementary-Data-KYC-DoB-MatchStrengths
object
4 properties
Date
object
Address-TypeEnum
string
Workflow-Step-Summary-AML-Search-Parameters
object
Search query parameters used in the AML workflow step.
14 properties
Individual-Name
object
10 properties
1 required
Supplementary-Data-KYB-Organization
object
Defines OQRO (Ownership Query Result Object) at various stages in the KYB (Know Your Business) flow. The 'oqro' property temporarily stores the V1 OQRO and wil…
Workflow-Errors
object
3 properties
Consent
object
3 properties
Document-Attachment-Type
string
General types of valid document attachments. - "PHOTO": Any photo. - "VIDEO": Any video. - "AUDIO": Any audio. - "PDF": PDF or PS file (may contain text, image…
Risk-Factor-ID
string
Unique identifier of the risk factor.
GenderEnum
string
Workflow-Step-Summary-NameValidation
object
Provides summary details for the name validation step.
3 properties
1 required
Supplementary-Data-Matchlist
object
Each match against a matchlist entry generates a PRO (Process Result Object), and this object describes the details of the matched entry.
Attribute
object
2 properties
2 required
Device-Indicators
object
11 properties
Object-Type
string
The type of object being annotated.
Workflow-Definition
object
Workflow definition
3 properties
Workflow-Step-Risk-Result-Detail
object
Details of a calculated risk result for a workflow step.
3 properties
3 required
Risk-Factor
object
16 properties
Workflow-Step-Summary-Finish
object
2 properties
1 required
Service-Profile-Subscription
object
11 properties
Supplementary-Data-Fraud-IP-Address-Data
object
Defines the details of a single fraud check for IP address related data.
6 properties
Supplementary-Data-Activity-Result-Detail-Indicator
object
5 properties
Supplementary-Data-IDV-OCR
object
Result of a document OCR comparison. This object represents the comparison between scanned data (via OCR) and updated or alternately supplied results. For the…
Risk-Assessment
object
16 properties
4 required
Subscription-Type
string
Specifies the type of service profile subscription. This value determines the category of the service profile subscription.
Supplementary-Data-Activity-Result-Detail-Rule
object
5 properties
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…
Supplementary-Data-Duplicate-MatchField
object
Provides details of a match between entities, the objects they represent, and the match strength.
4 properties
Workflow-Step-Summary-AML
object
Provides details of the overall AML (Anti-Money Laundering) step results.
11 properties
1 required
Document-Type
string
Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERSLICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (…
Workflow-Step-Summary-Visa
object
Provides details of the visa as returned from VEVO. Class and subclass values can be found on the VEVO website.
8 properties
1 required
Information-Source
object
13 properties
Workflow-Execution-State
string
Indicates the current state of this workflow execution. Refer to the documentation for a full description of each possible workflow execution state.
Workflow-Step-Summary
object
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-AML-MatchData
object
Contains information about this specific matched entity.
14 properties
2 required
Individual-Name-Alternate
object
11 properties
1 required
Supplementary-Data-Matchlist-Field
object
Entity data that resulted in a match at the time of execution.
3 properties
2 required
Service-Profile
Supplementary-Data-Activity-Fraud
object
Defines the details of an activity fraud result.
Document-Supplementary-Data-Marriage-Certificate
object
Supplementary information relevant to a marriage certificate.
Workflow-Step-Summary-AML-ProviderSummary
object
Summary of individual provider results for AML checks.
16 properties
Document-Information
object
18 properties
2 required
Document-Supplementary-Data
object
Supplementary information relevant to a specific document or report type.
Workflow-Step-Summary-KYC-MatchRule-Matches
object
Summary of all KYC matches for a given set of criteria.
9 properties
Supplementary-Data-Activity-AML
object
Provides details of an activity Anti-Money Laundering (AML) result.
Supplementary-Data-IDV-Facial-Comparison
object
Result of a facial comparison check, indicating how likely or accurate the presented face matches the ID document. For resultMap keys, use the keys found in th…
Document-Attachment-Side
string
Indicates whether the attachment is the front or back side of a document.
Supplementary-Data-IDV-Base
object
A report from an IDV provider based on a photographic or video biometrics process.
Process-Result-Manual-StatusEnum-KYC
string
Any manual status set after the results have been reviewed. - PASS: When the result is determined to be a pass and no further action is needed. - FAIL: When th…
Device-Detail
object
Device details
Workflow-Step-Summary-Start
object
3 properties
1 required
Document-Attachment
object
Document attachment details.
13 properties
1 required
Indicator-ID
string
Indicator ID that identifies an indicator from a check on an activity
Result-Reference-Type
string
The type of the reference (e.g. url)
Result-Reference
object
3 properties
Phone-Number-ID
string
As phone numbers are added to an entity, they are assigned an ID to assist with tracking. If you are adjusting phone numbers, you will need to include the ID t…
Data-URI-Base64
A Base64-encoded string or URI representing the data.
Workflow-Execution-Steps
object
5 properties
Activity-Result-ID
string
Activity Result ID that identifies a result from an evaluation of an activity
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…
Supplementary-Data-Base-MatchStrength
integer
Represents the standard match strength, scaled from 0 (no match) to 100 (exact match). In some cases, a value of 50 may be interpreted as a "partial" match.
Supplementary-Data-Fraud-IP-Address
object
Defines the details of a single IP address fraud check.
Comment
object
2 properties
Email
object
6 properties
Document-Attachment-Retrieval-Status
string
The reason why the data in a response is missing. - "NORMAL": The data was retrieved and is included. If it is empty, then it was never provided or was provide…
Document-Supplementary-Data-Citizenship
object
Supplementary information relevant to a citizenship certificate.
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…
Process-Result-ClassEnum
string
Provides additional clarity for the result class, especially for more generic element types like 'person'.
Likelihood
string
Likelihood of a particular scenario
Process-Result-StateEnum
string
Denotes the final disposition of this element's check result
Supplementary-Data-KYC-Name-MatchStrengths
object
5 properties
Entity
object
11 properties
Relationship-Origin
object
Details about the process that originated the relationship.
4 properties
Supplementary-Data-IDV-Document
object
Result of a document check, indicating how likely or accurate the presented document is a valid ID document. For resultMap keys, use the keys found in the enum…
Process-ResultEnum
string
The actual pass/fail result of the element check - MATCH: The element check matched the expected criteria. - PARTIALMATCH: The element check partially matched…
Workflow-Step-Summary-Decision
object
2 properties
1 required
Device
object
Device information associated with an activity, used for submitting device checks using an external service.
Document-Supplementary-Data-National-ID
object
Supplementary information relevant to a national ID.
Risk-Assessment-ID
string
Unique identifier of the risk assessment.
Supplementary-Data-AML-PEPData
object
Contains Politically Exposed Person (PEP) information about a specific matched entity.
14 properties
External-Reference-Information
object
Used to store references and identifying information about an entity that is external to FrankieOne. If you wish to filter or search on customer information re…
3 properties
2 required
Supplementary-Data-KYC-Gender-MatchStrengths
object
1 property
Workflow-Step-Summary-Duplicate
object
Provides details of the overall duplicate step results.
6 properties
1 required
Individual-Relationships
object
1 property
Workflow-Step-Summary-KYC-MatchRule-Matches-MatchTypes
object
7 properties
Supplementary-Data-Fraud-Device
object
Provides details of a single device fraud check.
Process-Result-Error
object
3 properties
Supplementary-Data-AML-MatchData-NationalId
object
Provides details of a matched identification document, if supplied.
5 properties
Supplementary-Data-AML-RelatedParties
object
Defines the name and relationship of individuals or organizations related to the matched entity.
2 properties
Workflow-Step-Summary-Activity
object
Provides details of the overall activity step results.
4 properties
1 required
Date-Base
object
5 properties
Supplementary-Data-AML-MatchData-Country
object
Represents the country code and match type for an AML (Anti-Money Laundering) country match.
2 properties
1 required
Process-Result-Manual-StatusEnum-Duplicate
string
Manual review status options for duplicate entity resolution. Used to indicate the outcome of a manual duplicate check between an existing entity (A) and an in…
Process-Result-Manual-StatusEnum-IDV
string
Any manual status set after the results have been reviewed. - CLEAR: When the result is determined to be clear and no further action is needed. - REJECTED: Whe…
Document-ID
string
As documents are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify a document, include the documen…
Geolocation
object
Geolocation details if it can be determined, typically related to a device during an activity
5 properties
Base-Individual
object
Supplementary-Data-AML-WatchlistData
object
Contains non-PEP/non-sanction watchlist and other source information about a specific matched entity.
10 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-ID-MatchStrengths
object
12 properties
Supplementary-Data-AML-SanctionsData
object
Contains sanction information about a specific matched entity.
10 properties
Custom-Attributes
object
Supplementary-Data-Fraud-Email-Address
object
Defines the details of a single email fraud check.
Workflow-Step-Summary-KYC
object
Captures the overall summary of the KYC step, including which matches have been made, with which sources, and under which ruleset.
3 properties
1 required
Document-Supplementary-Data-National-Health-ID
object
Supplementary information relevant to a national health id.
Supplementary-Data-Matchlist-Attribute
object
Information about a matched attribute within a matched field.
2 properties
2 required
Workflow-Step-Type
string
Process-Risk-Factor-Value
object
Risk Factor Value
2 properties
2 required
Device-Properties
object
Device properties
12 properties
Supplementary-Data-AML-ReferenceDocs
object
Captures references to source documents or websites, including the URL and, where available, a description of the original source.
2 properties
Device-ID
string
ID of the device
Session-Data
object
Session data for an activity, this is always scoped to a singular entity.
Workflow-Step-Summary-KYC-MatchRule
object
Provides the details of a KYC matching rule result. The details can be used to represent a rule that did match or did not match. By default, there will always…
3 properties
Supplementary-Data-Activity-Result-Detail
object
5 properties
Workflow-Step-Summary-ID-Matches
object
6 properties
Address-Base
object
Address information in all available formats
20 properties
1 required
Address-StatusEnum
string
Supplementary-Data-Base
object
1 property
1 required
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…
Supplementary-Data-NameValidation
object
Details on how the native language name was verified against a dictionary of anglicized translations.
Supplementary-Data-IDV-Data
object
Contains information about a specific matched IDV element.
7 properties
Supplementary-Data-AML-AdditionalData
object
Represents a simple key-value pair for AML data to capture any additional information not included in the main object.
2 properties
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
Gender
object
3 properties
Process-Result-Manual-StatusEnum-AML
string
The manual status that the AML process result should be set to after the results have been reviewed. - FALSEPOSITIVE: The result is determined to be a false po…
Address
object
Address information in all available formats
Error
object
Entity-Documents
object
4 properties
Supplementary-Data-Duplicate-MatchedRule
object
Provides details about the rule that was matched to classify the object as a duplicate.
2 properties
Supplementary-Data-Duplicate
object
Provides details of a single duplicate match, including the matching entity ID and a list of matched elements.
Date-Type
string
The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESOAMERICAN, PERSIAN, or OTHER.
Supplementary-Data-Visa
object
Defines the Visa details returned from VEVO. Class and subclass values can be found on the VEVO website.
Workflow-Execution-Result
object
20 properties
12 required
Workflow-Execution-StateEnum
string
Current state of the workflow execution. Possible values: - COMPLETED: The workflow execution has completed successfully. - CANCELED: The workflow execution wa…
Supplementary-Data-KYC-Gender
object
Defines the matching results for a gender check. This is rarely used.
Workflow-Issue-Type
string
For each category, this provides the specific issue type. AML: - PEP: The entity has Politically Exposed Person (PEP) hits. - SANCTION: The entity has sanction…
Workflow-Result
object
Process-Result-System-StatusEnum
string
If there has been an additional system status applied to the process. - VALID: The process result is valid and has not been marked for any special handling. -…
Workflow-Execution-ObjectTypeEnum
string
The type of primary object that was checked. Either: - NAME - ADDRESS - DATEOFBIRTH - ORGANIZATION - DOCUMENT - EMAILADDRESS - PHONENUMBER - DEVICE - INDIVIDUAL
Supplementary-Data-Fraud-Phone-Number
object
Defines the details of a single phone number fraud check.
Issue-ID
string
Unique identifier for the risk issue.
Address-Place-Of-Birth
object
The country or address where the individual was born.
15 properties
1 required
Supplementary-Data-AML-MediaData
object
Contains adverse media information about a specific matched entity.
7 properties
2 required
Evaluation-ID
string
The ID of the evaluation
Workflow-Step-Summary-KYC-Result-Summary-Detail
object
3 properties
Workflow-Step
object
6 properties
Service-Providers
object
5 properties
Supplementary-Data-Activity-Device
object
Defines the details of an activity device result.
Process-Result-Object
object
22 properties
Workflow-Issue-Category
string
General category of issue found: - AML: Anti-Money Laundering issues. - BADDATA: Indicates that the data provided is invalid or incorrect. - BIOMETRICS: Issues…
Supplementary-Data-KYC-DoB
object
Defines the matching levels for each date of birth element, where available. Provides a match strength score ranging from 0 (no match) to 100 (full match).
Supplementary-Data-KYC-Name
object
Defines the matching levels for each name element, where available. Provides a match strength score ranging from 0 (no match) to 100 (full match).
Monitoring-Type
string
The type of workflow subscription. This determines which types are subscribing to a workflow.
Document-Attachment-ID
string
When a document attachment is created or uploaded, it is assigned an attachmentId. This identifier will appear in a successful response or accepted response. I…
Supplementary-Data
object
Date-Of-Birth-Alternate
object
Individual
object
Search-Confidence
number
Confidence level of the search result, represented as a number between 0 and 1. A higher value indicates greater confidence in the accuracy of the search resul…
Workflow-Step-Summary-ID
object
ID match counts for each checked document, whether matched or not. The keys in this map are the document IDs. The match type in the value will be either "govid…
8 properties
1 required
Supplementary-Data-KYC-Address
object
Defines the matching levels for each address element, where available. Provides a match strength score ranging from 0 (no match) to 100 (full match).
Workflow-Step-Summary-Matchlist
object
Provides a summary of all matchlist screening results for a workflow step.
7 properties
1 required
Process-Result-Manual-StatusEnum
Process-Result-Manual-StatusEnum-Matchlist
string
Any manual status set after the results have been reviewed. - FALSEPOSITIVE: The result is determined to be a false positive, but you do not necessarily want t…
Rule-ID
string
Rule ID that identifies an instance of a rule within the Frankie platform
Session
object
Session details for an activity, this is always scoped to a singular entity.
1 property
Document-Supplementary-Data-Passport
object
Supplementary information relevant to a national health id.
External-Reference
object
Reference information used to identify the individual in systems external to FrankieOne.
Behavior-Biometrics
object
3 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".
Supplementary-Data-IDV-ElementMap
object
A map of IDV report elements obtained from the requested IDV service provider. The map keys are arbitrary strings, but where possible, should use a value from…
ConfidenceLevel
object
2 properties
Workflow-Step-Summary-Fraud
object
Provides details of the overall Fraud step results.
11 properties
3 required
Workflow-Lookup
object
7 properties
Service-Profile-Base
object
23 properties
Error-Base
object
3 properties
Date-Of-Birth
object
Supplementary-Data-IDV-OCR-Comparison
object
Result of an OCR and updated data comparison. This object represents the comparison between scanned data (via OCR) and updated or alternately supplied results.…
Workflow-Step-ResultEnum
string
Overall result of the workflow step. Depending on the context of the step and its purpose, it will return a different result code: - UNCHECKED: Step was not at…
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…
Document-Supplementary-Data-Base
object
Supplementary data associated with a document.
1 property
1 required
Workflow-Execution-Summary
object
Summary of the workflow execution. Using and interpreting the status field The result of the workflow is represented in the status field. Users can manually ov…
16 properties
Workflow-Execution-Step-Result
object
19 properties
Workflow-Step-Summary-Matchlist-Summary
object
Summary of individual matchlist results.
9 properties
Supplementary-Data-IDV-Facial-Liveness
object
Result of a facial liveness check, indicating how likely the facial photo or video is of a live person. For resultMap keys, use the keys found in the enum: Sup…
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…
Supplementary-Data-ID
object
Provides the matching levels found for each ID element, where available. Match strength is scaled from 0 (no match) to 100 (full match).
Phone-Number
object
8 properties
Matchlist-Entry-Base
object
Basic details about a matchlist entry, excluding metadata.
5 properties
Document-Supplementary-Data-Birth-Certificate
object
Supplementary information relevant to a birth certificate.
Email-Address-ID
string
As email addresses are added to an entity, they are assigned a unique identifier to assist with modification and reference. To modify an email, include the ema…
Supplementary-Data-Fraud-Device-Data
object
Provides details of a single fraud check for device and related device data.
5 properties
Provider-Result
object
9 properties
Workflow-Issue-Severity
string
The severity level of the issue. Possible values: - INFO: Informational only. - REVIEW: Requires review. - BLOCK: Blocks further processing. - WARNING: Warning…
Profile-ID
string
Unique identifier of the Service Profile.
Supplementary-Data-AML
object
Each AML match/hit generates a PRO, and this object describes the details of the matched individual or business.
1 required
FuzzinessLevel
object
2 properties
Relationship
object
3 properties
Supplementary-Data-KYC-Address-MatchStrengths
object
10 properties
Workflow-Execution-ID
string
The execution ID (formerly known as Check ID) representing a single workflow execution instance.
IP-Information
object
IP information, typically in relation to a device
6 properties
Supplementary-Data-IDV-OCR-Comparison-Enum-Comparison-Source
string
Indicates the source of the data used for comparison with the OCR scan results. The source can be either the original entity data or the updated data extracted…
Workflow-Issue
object
12 properties
3 required
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from FrankieOne 12
Other APIs FrankieOne publishes across the network.
FrankieOne Audit API
FrankieOne HostedURL API
FrankieOne IDV API
FrankieOne Individual Documents API
FrankieOne Individual Entities API
FrankieOne Individual Entity Elements API
FrankieOne Individual Profiles API
FrankieOne Individual Results API
FrankieOne Individual Risks API
FrankieOne Matchlists API
FrankieOne Monitoring API
FrankieOne Search API
#Individual Workflows
Where this information came from
This is an independent, third-party profile of FrankieOne Individual Workflows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.