aid: frankieone:kyc-capabilities
name: FrankieOne KYC V2 API Capabilities
description: >-
  Capability map for the FrankieOne KYC V2 API covering individual entity
  management, workflow execution, identity verification results, document
  handling, and monitoring across the FrankieOne identity platform.
modified: '2026-04-28'
capabilities:
  - id: individual-entities
    name: Individual Entity Management
    description: >-
      Create, retrieve, update, and delete individual entities representing
      end users in KYC verification workflows.
    operations:
      - POST /v2/individuals
      - GET /v2/individuals/{entityId}
      - PATCH /v2/individuals/{entityId}
      - DELETE /v2/individuals/{entityId}
  - id: entity-elements
    name: Entity Element Management
    description: >-
      Manage discrete entity elements such as names, dates of birth, addresses,
      email addresses, phone numbers, consents, and external references.
    operations:
      - PATCH /v2/individuals/{entityId}/names/{nameId}
      - PATCH /v2/individuals/{entityId}/datesOfBirth/{dateOfBirthId}
      - PATCH /v2/individuals/{entityId}/addresses/{addressId}
      - PATCH /v2/individuals/{entityId}/emailaddresses/{emailAddressId}
      - PATCH /v2/individuals/{entityId}/phonenumbers/{phoneNumberId}
      - PATCH /v2/individuals/{entityId}/consents/{consentType}
      - GET /v2/individuals/{entityId}/externalreferences
  - id: workflow-execution
    name: Workflow Execution
    description: >-
      Execute named verification workflows against new or existing individuals
      under a chosen service profile, and inspect prior workflow executions.
    operations:
      - GET /v2/workflows
      - POST /v2/individuals/new/serviceprofiles/{serviceName}/workflows/{workflowName}/execute
      - POST /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/execute
      - GET /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions
      - GET /v2/individuals/{entityId}/serviceprofiles/{serviceName}/workflows/{workflowName}/executions/{workflowExecutionId}
  - id: verification-results
    name: Verification Results
    description: >-
      Retrieve and patch verification results across mKYC, AML, IDV, matchlist,
      duplicate, and fraud check categories.
    operations:
      - GET /v2/individuals/{entityId}/results
      - GET /v2/individuals/{entityId}/results/mkyc
      - POST /v2/individuals/{entityId}/results/mkyc/invalidate
      - GET /v2/individuals/{entityId}/results/aml
      - GET /v2/individuals/{entityId}/results/idv
      - GET /v2/individuals/{entityId}/results/matchlist
      - GET /v2/individuals/{entityId}/results/duplicate
      - GET /v2/individuals/{entityId}/results/fraud
  - id: documents
    name: Document Handling
    description: >-
      Upload and retrieve identity documents associated with an individual
      entity for IDV processing.
    operations:
      - POST /v2/individuals/{entityId}/documents
      - GET /v2/individuals/{entityId}/documents
  - id: hosted-url
    name: Hosted URL Flows
    description: >-
      Generate and manage hosted URLs for embedded or hosted verification
      experiences.
    operations:
      - POST /v2/hosted
  - id: search
    name: Service Profile Search
    description: >-
      Search service profiles available to the customer account.
    operations:
      - GET /v2/search/serviceprofiles
  - id: monitoring
    name: Ongoing Monitoring
    description: >-
      Configure and inspect ongoing monitoring of individuals for AML and
      sanction list changes.
    operations:
      - GET /v2/individuals/{entityId}/monitoring