FrankieOne Individual Entities 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 Entities. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
4 operations
across 2 paths,
and defines 82 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.
The identity and technical contract details declared by the specification.
Individual-Name
object
10 properties
1 required
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.
Attribute
object
2 properties
2 required
Risk-Factor
object
16 properties
Service-Profile-Subscription
object
11 properties
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.
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…
Information-Source
object
13 properties
Document-Type
string
Valid document ID types. - "OTHER": Generic document type. Unspecified. - "DRIVERSLICENSE": Driver's license. - "PASSPORT": Passport. - "VISA": Visa document (…
Request-ID
string
The unique request identifier for the API call made.
Individual-Name-Alternate
object
11 properties
1 required
Document-Supplementary-Data-Marriage-Certificate
object
Supplementary information relevant to a marriage certificate.
Document-Information
object
18 properties
2 required
Document-Supplementary-Data
object
Supplementary information relevant to a specific document or report type.
Document-Attachment-Side
string
Indicates whether the attachment is the front or back side of a document.
Document-Attachment
object
Document attachment details.
13 properties
1 required
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
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
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.
Relationship-Origin
object
Details about the process that originated the relationship.
4 properties
Entity
object
11 properties
Document-Supplementary-Data-National-ID
object
Supplementary information relevant to a national ID.
Risk-Assessment-ID
string
Unique identifier of the risk assessment.
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
individuals_create
object
Individual-Relationships
object
1 property
Date-Base
object
5 properties
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…
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.…
Document-Supplementary-Data-National-Health-ID
object
Supplementary information relevant to a national health id.
Address-Base
object
Address information in all available formats
20 properties
1 required
Address-StatusEnum
string
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…
Issue
object
3 properties
Gender
object
3 properties
Address
object
Address information in all available formats
Entity-Documents
object
4 properties
Date-Type
string
The calendar system used for the date, e.g., BUDDHIST, DISCORDIAN, GREGORIAN, HEBREW, ISLAMIC, JULIAN, LUNAR, MESOAMERICAN, PERSIAN, or OTHER.
Workflow-Execution-StateEnum
string
Current state of the workflow execution. Possible values: - COMPLETED: The workflow execution has completed successfully. - CANCELED: The workflow execution wa…
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…
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
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…
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…
Monitoring-Type
string
The type of workflow subscription. This determines which types are subscribing to a workflow.
Date-Of-Birth-Alternate
object
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.
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".
Error-Base
object
3 properties
Service-Profile-Base
object
23 properties
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
individuals_update
object
individuals_entity_response
object
3 properties
1 required
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…
Phone-Number
object
8 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…
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.
Relationship
object
3 properties
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…
Workflow-Issue
object
12 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs FrankieOne publishes across the network.
