openapi: 3.1.1
info:
  title: VerificationSummary — Shared Type
  version: 2.1.0
  description: 'Shared type representing the outcome of a credential verification check. Used in contract and performance schemas across hiring-jobs, hiring-candidates, and skilling packs. Captures overall result, per-category outcomes, and reason codes without carrying any credential payload.

    '
  license:
    name: CC-BY-NC-SA 4.0 International
  contact:
    name: Beckn Labs
    url: https://beckn.io
components:
  schemas:
    VerificationSummary:
      x-iri: https://schema.nfh.global/VerificationSummary/v2.1
      type: object
      description: 'Summary of a credential verification check. Contains the overall result, reason codes for any failures, and which credential categories were successfully verified. No VC or VP payloads are included.

        '
      required:
      - overall_result
      - checked_at
      properties:
        overall_result:
          type: string
          description: Aggregate outcome of the verification check.
          x-jsonld-id: vs:overallResult
          enum:
          - PASS
          - FAIL
          - PARTIAL
          - PENDING
        reason_codes:
          type: array
          description: 'Reason codes for failures or partial results. Empty if overall_result is PASS. Examples: "MANDATORY_REQUIREMENT_MISSING", "EXPIRED_CREDENTIAL", "ISSUER_NOT_TRUSTED", "SIGNATURE_INVALID".

            '
          x-jsonld-id: vs:reasonCodes
          items:
            type: string
        verified_categories:
          type: array
          description: 'Credential categories that were successfully verified in this check.

            '
          x-jsonld-id: vs:verifiedCategories
          items:
            type: string
        verified_subtypes:
          type: array
          description: 'Specific credential subtypes that were successfully verified.

            '
          x-jsonld-id: vs:verifiedSubtypes
          items:
            type: string
        checked_at:
          type: string
          format: date-time
          description: Timestamp when verification was performed.
          x-jsonld-id: vs:checkedAt
        proof_metadata_hash:
          type: string
          description: 'Optional hash of the VP used in verification. Provides integrity reference without storing the VP payload.

            '
          x-jsonld-id: vs:proofMetadataHash