KYC V2 API — IDV

naftiko: 1.0.0-alpha2
info:
  label: KYC V2 API — IDV
  description: 'KYC V2 API — IDV. 3 operations. Lead operation: Submit an identity document photo for ocr processing. Results
    will be in the form of an identity document with populated with ocr results.. Self-contained Naftiko capability covering
    one Frankieone business surface.'
  tags:
  - Frankieone
  - IDV
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FRANKIEONE_API_KEY: FRANKIEONE_API_KEY
capability:
  consumes:
  - type: http
    namespace: kyc-v2-idv
    baseUri: https://api.uat.frankie.one
    description: KYC V2 API — IDV business capability. Self-contained, no shared references.
    resources:
    - name: v2-individuals-entityId-actions-idv-ocr
      path: /v2/individuals/{entityId}/actions/idv/ocr
      operations:
      - name: processidvocr
        method: POST
        description: Submit an identity document photo for ocr processing. Results will be in the form of an identity document
          with populated with ocr results.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-individuals-entityId-actions-idv-process
      path: /v2/individuals/{entityId}/actions/idv/process
      operations:
      - name: initbiometrics
        method: POST
        description: At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider
          that check is ready to analyse and check.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-individuals-entityId-actions-idv-token
      path: /v2/individuals/{entityId}/actions/idv/token
      operations:
      - name: getidvtoken
        method: POST
        description: Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated,
          this is to be called before starting the IDV or OCR process.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: bearer
      token: '{{env.FRANKIEONE_API_KEY}}'
  exposes:
  - type: rest
    namespace: kyc-v2-idv-rest
    port: 8080
    description: REST adapter for KYC V2 API — IDV. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/v2/individuals/{entityid}/actions/idv/ocr
      name: v2-individuals-entityid-actions-idv-ocr
      description: REST surface for v2-individuals-entityId-actions-idv-ocr.
      operations:
      - method: POST
        name: processidvocr
        description: Submit an identity document photo for ocr processing. Results will be in the form of an identity document
          with populated with ocr results.
        call: kyc-v2-idv.processidvocr
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/individuals/{entityid}/actions/idv/process
      name: v2-individuals-entityid-actions-idv-process
      description: REST surface for v2-individuals-entityId-actions-idv-process.
      operations:
      - method: POST
        name: initbiometrics
        description: At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider
          that check is ready to analyse and check.
        call: kyc-v2-idv.initbiometrics
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/individuals/{entityid}/actions/idv/token
      name: v2-individuals-entityid-actions-idv-token
      description: REST surface for v2-individuals-entityId-actions-idv-token.
      operations:
      - method: POST
        name: getidvtoken
        description: Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated,
          this is to be called before starting the IDV or OCR process.
        call: kyc-v2-idv.getidvtoken
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: kyc-v2-idv-mcp
    port: 9090
    transport: http
    description: MCP adapter for KYC V2 API — IDV. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: submit-identity-document-photo-ocr
      description: Submit an identity document photo for ocr processing. Results will be in the form of an identity document
        with populated with ocr results.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: kyc-v2-idv.processidvocr
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: end-idv-data-capture-process
      description: At the end of the IDV data capture process with all photos and videos captured, signal to IDV provider
        that check is ready to analyse and check.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: kyc-v2-idv.initbiometrics
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: queries-idv-provider-token-be
      description: Queries the IDV provider for a token to be used with their sdk. This allows a provider SDK to be instantiated,
        this is to be called before starting the IDV or OCR process.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: kyc-v2-idv.getidvtoken
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.