FrankieOne

FrankieOne Individual Workflows API

The Individual Workflows API from FrankieOne — 5 operation(s) for individual workflows.

GitHub OpenAPI

Operations 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. #

Documentation

📖
Documentation
https://docs.frankieone.com/v1.14.1/docs/welcome-to-frankie
📖
Documentation
https://docs.frankieone.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-individual-workflows-api-openapi.yml

Other Resources

🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/capabilities/frankieone-kyc-capabilities.yml
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/rules/frankieone-kyc-rules.yml
🔗
Capabilities
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/capabilities/frankieone-core-capabilities.yml
🔗
Rules
https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/rules/frankieone-core-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/frankieone-individual-workflows-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

frankieone-individual-workflows-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Core V2 Audit Individual Workflows API
  version: 2.0.0
  description: This is the APIs for V2 Core. It allows you to do common operations, such as read audit entries or get workflow lists.
  contact:
    name: FrankieOne
    url: https://www.frankieone.com/
    email: help@frankieone.com
servers:
- url: https://api.uat.frankie.one
security:
- Api-Key: []
tags:
- name: Individual Workflows
paths:
  /v2/workflows:
    get:
      summary: Get a list of executable workflows
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflows:
                    type: array
                    description: Provide a set of workflow lookup objects.
                    items:
                      $ref: '#/components/schemas/Workflow-Lookup'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getWorkflows
      description: Get a list of workflows that can be executed
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      - $ref: '#/components/parameters/serviceNameQuery'
      - $ref: '#/components/parameters/includeQuery'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute:
    parameters:
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/levelQuery'
    post:
      summary: Create an individual and execute a workflow for the given service profile
      responses:
        '200':
          description: Execution request completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  serviceProfile:
                    $ref: '#/components/schemas/Service-Profile'
                  individual:
                    $ref: '#/components/schemas/Individual'
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
        '202':
          description: Asynchronous execution request accepted, use requestId to retrieve results
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionId:
                    $ref: '#/components/schemas/Workflow-Execution-ID'
                  entityId:
                    $ref: '#/components/schemas/Entity-ID'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: createAndExecuteWorkflow
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                individual:
                  $ref: '#/components/schemas/Individual'
                comment:
                  $ref: '#/components/schemas/Comment'
      description: Create an individual and execute a workflow for the given service profile
      parameters:
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/levelQuery'
    post:
      summary: Execute a workflow for the given service profile
      responses:
        '200':
          description: Execution request completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  serviceProfile:
                    $ref: '#/components/schemas/Service-Profile'
                  individual:
                    $ref: '#/components/schemas/Individual'
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
        '202':
          description: Asynchronous execution request accepted, use requestId to retrieve results
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionId:
                    $ref: '#/components/schemas/Workflow-Execution-ID'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: executeWorkflow
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  $ref: '#/components/schemas/Comment'
      description: Execute a workflow for the given service profile.
      parameters:
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Background'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/limit'
    - $ref: '#/components/parameters/page'
    - $ref: '#/components/parameters/sort'
    - $ref: '#/components/parameters/sortFields'
    - $ref: '#/components/parameters/query_filter_workflowresults'
    - $ref: '#/components/parameters/query_filter_workflowexecutionstates'
    - $ref: '#/components/parameters/query_filter_startedatbefore'
    - $ref: '#/components/parameters/query_filter_startedatafter'
    - $ref: '#/components/parameters/query_filter_endedatbefore'
    - $ref: '#/components/parameters/query_filter_endedatafter'
    get:
      summary: Get a list of executions and their results
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResults:
                    type: array
                    items:
                      $ref: '#/components/schemas/Workflow-Result'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getResults
      description: Get a list of entity results. Always sorted in reverse chrono order
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
  /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}:
    parameters:
    - $ref: '#/components/parameters/entityId'
    - $ref: '#/components/parameters/serviceName'
    - $ref: '#/components/parameters/workflowName'
    - $ref: '#/components/parameters/executionId'
    - $ref: '#/components/parameters/levelNoIdQuery'
    get:
      summary: Get the result of a specific execution by its executionId.
      responses:
        '102':
          description: '**[DEPRECATED]** Workflow is still processing'
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowExecutionState:
                    $ref: '#/components/schemas/Workflow-Execution-State'
        '200':
          description: Workflow has completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
                  individual:
                    $ref: '#/components/schemas/Individual'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getWorkflowExecutionResult
      description: Get the result of a specific execution by its executionId.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
    patch:
      summary: Override the status of a specific workflow execution.
      responses:
        '200':
          description: Status has been updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  requestId:
                    $ref: '#/components/schemas/Request-ID'
                  workflowResult:
                    $ref: '#/components/schemas/Workflow-Result'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid EntityId:
                  value:
                    errorCode: API-0400,
                    errorMsg: 'Multiple Errors: See Issues list'
                    details:
                    - issue: 'entityId in path must be of type uuid: "test"'
                      issueLocation: VALIDATE-entityId
                    requestId: 01HM5XJ7VASZ3EJMB1VQGTBFJ4
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Invalid authentication:
                  value:
                    errorCode: AUTH-0002,
                    errorMsg: Unauthorized
                    details:
                    - issue: Invalid Authentication provided. Access denied.
                      issueLocation: request
                    requestId: 00000000S6MNG7624K2TDXT1E3
                No Api-Key:
                  value:
                    errorCode: AUTH-0401
                    errorMsg: Unauthorized
                    details:
                    - issue: No api key provided. Access denied.
                      issueLocation: request
                    requestId: 00000001S6MNG7624K2TDXT1E3
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  $ref: '#/components/schemas/Workflow-Execution-ResultEnum'
                comment:
                  $ref: '#/components/schemas/Comment'
      operationId: overrideWorkflowExecutionResult
      description: Override the result of a specific workflow execution by its id.
      parameters:
      - $ref: '#/components/parameters/Api-Key'
      - $ref: '#/components/parameters/X-Frankie-CustomerID'
      - $ref: '#/components/parameters/X-Frankie-CustomerChildID'
      - $ref: '#/components/parameters/X-Frankie-Channel'
      - $ref: '#/components/parameters/X-Frankie-Username'
      tags:
      - Individual Workflows
      security:
      - Api-Key: []
      - jwt:
        - kyc:api
components:
  schemas:
    Supplementary-Data-KYC-DoB-MatchStrengths:
      type: object
      properties:
        fullDateOfBirth:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
        year:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
        month:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
        day:
          type: integer
          format: int32
          minimum: 0
          maximum: 100
    Date:
      type: object
      allOf:
      - $ref: '#/components/schemas/Date-Base'
      - type: object
        properties:
          normalized:
            type: string
            format: date
            description: Full date in ISO 8601 format ("YYYY-MM-DD"). This is a read-only field.
            example: '1990-03-31'
            readOnly: true
    Address-TypeEnum:
      type: string
      default: OTHER
      enum:
      - OTHER
      - RESIDENTIAL
      - BUSINESS
      - POSTAL
      - REGISTERED_OFFICE
      - PLACE_OF_BUSINESS
      - OFFICIAL_CORRESPONDANCE
      - PLACE_OF_BIRTH
      - OFFICE_LOCALITY
    Workflow-Step-Summary-AML-Search-Parameters:
      type: object
      description: 'Search query parameters used in the AML workflow step.

        '
      properties:
        name:
          type: string
          description: Name sent to the service provider, if provided as a single string.
        givenName:
          type: string
          description: Given name sent to the service provider.
        otherName:
          type: string
          description: Other name sent to the service provider.
        familyName:
          type: string
          description: Family name sent to the service provider.
        dateOfBirth:
          type: string
          description: Date of birth sent to the service provider. May be in any format and may be a partial date.
        address:
          type: string
          description: Main address sent to the service provider.
        gender:
          type: string
          description: Gender sent to the service provider.
        nationality:
          type: string
          description: Nationality sent to the service provider.
        idNumber:
          type: string
          description: ID number sent to the service provider.
        idType:
          type: string
          description: ID type sent to the service provider.
        idCountry:
          type: string
          description: ID country sent to the service provider.
        placeOfBirth:
          type: string
          description: Place of birth sent to the service provider.
        placeOfResidence:
          type: string
          description: Place of residence sent to the service provider.
        fuzziness:
          type: string
          description: Search fuzziness level; may be a percentage or a descriptive level.
    Individual-Name:
      type: object
      required:
      - familyName
      x-examples:
        Example 1:
          givenName: John
          middleName: Jacob
          familyName: Smith
      properties:
        nameId:
          type: string
          example: 87654321-4321-4321-4321-210987654321
          description: Include the nameId of an existing name for this individual to modify it
          readOnly: true
        language:
          type: string
          example: eng
          description: The ISO-639-3 standard code that best represents the language and character set of the individual's name
          default: eng
        givenName:
          type: string
          example: John
          description: First name or given name
        middleName:
          type: string
          example: R
          description: Middle name(s) or middle initial(s)
        familyName:
          type: string
          example: Doe
          description: Last name, family name, or surname.
        otherName:
          type: string
          example: null
          description: Another name that this person may be known as, e.g., "Bob" as an alternative to "Robert".
        prefix:
          type: string
          example: Dr.
          description: Letters or words that come before an individual's full name (e.g., title or honorific).
        suffix:
          type: string
          example: Jr.
          description: Letters or words that come after an individual's full name (e.g., generational suffix).
        sourceId:
          type: string
          example: 87654321-4321-4321-4321-210987654322
          description: The source from where a specific information was sourced from. This is a link to an informationSource object in the informationSources map
          readOnly: true
        displayName:
          type: string
          example: John Doe
          description: Long format of the individual's full name, including any prefix, suffix, middle, or other names. Best used when the proper structure of the individual's name is unknown.
    Supplementary-Data-KYB-Organization:
      type: object
      description: '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 will be used until the V2 OQRO is defined.

        '
      allOf:
      - $ref: '#/components/schemas/Supplementary-Data-Base'
      - type: object
        properties:
          organization:
            description: 'V2 OQRO; to be defined in the future.

              '
            properties:
              entityId:
                $ref: '#/components/schemas/Entity-ID'
              entityType:
                $ref: '#/components/schemas/Entity-Type'
    Workflow-Errors:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        description:
          type: string
          description: Description of the error.
        location:
          type: string
          description: Location or context where the error occurred.
    Consent:
      type: object
      properties:
        type:
          type: string
          description: The type of consent given by an entity
          example: UNDER18
          enum:
          - GENERAL
          - DOCS
          - CREDITHEADER
          - UNDER18
          - PAYROLL
          - INSURANCE
          - SUPERANNUATION
        schemaVersion:
          type: integer
          readOnly: true
        sourceId:
          type: string
          description: The source from which specific information was obtained. This is a link to an informationSource object in the informationSources map.
          example: 93da15f64-5717-4562-b3fc-2c963f6663fe
          readOnly: true
    Document-Attachment-Type:
      type: string
      description: "General types of valid document attachments.\n  - \"PHOTO\": Any photo.\n  - \"VIDEO\": Any video.\n  - \"AUDIO\": Any audio.\n  - \"PDF\": PDF or PS file (may contain text, images, or both).\n  - \"DOC\": Word document, RTF, etc.\n  - \"ZIP\": Any compressed file(s)."
    Risk-Factor-ID:
      type: string
      description: Unique identifier of the risk factor.
      readOnly: true
    GenderEnum:
      type: string
      enum:
      - MALE
      - FEMALE
      - NON_BINARY
      - OTHER
      - UNSPECIFIED
    Workflow-Step-Summary-NameValidation:
      type: object
      description: 'Provides summary details for the name validation step.

        '
      required:
      - stepName
      properties:
        langCode:
          type: string
          description: Language code used for translation.
        nameMatchOrder:
          type: string
          description: 'Depending on the name to be translated and how it is presented, the native language and anglicized version ordering might be mixed up. The service will try various orderings to determine if a match can be made.

            The order codes represent the actual order that matched.

            Each letter combination represents *F*amily, *G*iven, and *O*ther names.

            For

# --- truncated at 32 KB (228 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/frankieone/refs/heads/main/openapi/frankieone-individual-workflows-api-openapi.yml