KYC V2 API — Individual Documents

naftiko: 1.0.0-alpha2
info:
  label: KYC V2 API — Individual Documents
  description: 'KYC V2 API — Individual Documents. 6 operations. Lead operation: Create a new document for an individual..
    Self-contained Naftiko capability covering one Frankieone business surface.'
  tags:
  - Frankieone
  - Individual Documents
  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-individual-documents
    baseUri: https://api.uat.frankie.one
    description: KYC V2 API — Individual Documents business capability. Self-contained, no shared references.
    resources:
    - name: v2-individuals-entityId-documents
      path: /v2/individuals/{entityId}/documents
      operations:
      - name: createdocuments
        method: POST
        description: Create a new document for an individual.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getdocuments
        method: GET
        description: Get all documents for an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-individuals-entityId-documents-documentId
      path: /v2/individuals/{entityId}/documents/{documentId}
      operations:
      - name: updatedocument
        method: PATCH
        description: Update a single document by it's id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: getdocument
        method: GET
        description: Get a single document by it's id.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedocument
        method: DELETE
        description: Delete a document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: v2-individuals-entityId-documents-documentId-attachments-attachmentId
      path: /v2/individuals/{entityId}/documents/{documentId}/attachments/{attachmentId}
      operations:
      - name: deleteattachments
        method: DELETE
        description: Delete an attachment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.FRANKIEONE_API_KEY}}'
  exposes:
  - type: rest
    namespace: kyc-v2-individual-documents-rest
    port: 8080
    description: REST adapter for KYC V2 API — Individual Documents. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/individuals/{entityid}/documents
      name: v2-individuals-entityid-documents
      description: REST surface for v2-individuals-entityId-documents.
      operations:
      - method: POST
        name: createdocuments
        description: Create a new document for an individual.
        call: kyc-v2-individual-documents.createdocuments
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getdocuments
        description: Get all documents for an entity
        call: kyc-v2-individual-documents.getdocuments
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/individuals/{entityid}/documents/{documentid}
      name: v2-individuals-entityid-documents-documentid
      description: REST surface for v2-individuals-entityId-documents-documentId.
      operations:
      - method: PATCH
        name: updatedocument
        description: Update a single document by it's id.
        call: kyc-v2-individual-documents.updatedocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getdocument
        description: Get a single document by it's id.
        call: kyc-v2-individual-documents.getdocument
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletedocument
        description: Delete a document
        call: kyc-v2-individual-documents.deletedocument
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/individuals/{entityid}/documents/{documentid}/attachments/{attachmentid}
      name: v2-individuals-entityid-documents-documentid-attachments-attachmentid
      description: REST surface for v2-individuals-entityId-documents-documentId-attachments-attachmentId.
      operations:
      - method: DELETE
        name: deleteattachments
        description: Delete an attachment
        call: kyc-v2-individual-documents.deleteattachments
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: kyc-v2-individual-documents-mcp
    port: 9090
    transport: http
    description: MCP adapter for KYC V2 API — Individual Documents. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-new-document-individual
      description: Create a new document for an individual.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: kyc-v2-individual-documents.createdocuments
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-documents-entity
      description: Get all documents for an entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kyc-v2-individual-documents.getdocuments
      outputParameters:
      - type: object
        mapping: $.
    - name: update-single-document-it-s-id
      description: Update a single document by it's id.
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: kyc-v2-individual-documents.updatedocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-single-document-it-s-id
      description: Get a single document by it's id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: kyc-v2-individual-documents.getdocument
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-document
      description: Delete a document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: kyc-v2-individual-documents.deletedocument
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-attachment
      description: Delete an attachment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: kyc-v2-individual-documents.deleteattachments
      outputParameters:
      - type: object
        mapping: $.