> ## Documentation Index
> Fetch the complete documentation index at: https://developers.ever.day/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Smart Match Results

> Retrieve the smart match results for a specific passport and skillset.




## OpenAPI

````yaml get /smart-match/{publicIdentifier}/{skillsetId}
openapi: 3.0.3
info:
  title: Smart Match API
  version: 1.0.0
  description: >
    ## Smart Match API

    This API allows organisations to initiate a smart match between a passport
    (user profile) and one or more skillsets.


    - `POST /smart-match` triggers a smart match analysis. The results will be
    sent via webhook.

    - `GET /smart-match/{publicIdentifier}/{skillsetId}` retrieves the match
    results for a specific passport and skillset.


    ### Base URL

    The API is hosted at:

    `https://api.ever.day`


    ### API Key Authentication

    To authenticate requests, include your API key in the `x-api-key` header of
    every request.
servers:
  - url: https://api.ever.day
security: []
paths:
  /smart-match/{publicIdentifier}/{skillsetId}:
    get:
      summary: Get Smart Match Results
      description: |
        Retrieve the smart match results for a specific passport and skillset.
      parameters:
        - name: publicIdentifier
          in: path
          required: true
          schema:
            type: string
          description: The external unique identifier.
        - name: skillsetId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the skillset.
      responses:
        '200':
          description: Smart match results retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmartMatchResult'
        '401':
          description: Unauthorized. API key is missing or invalid.
        '404':
          description: No smart match results found.
        '500':
          description: Internal server error.
      security:
        - apiKeyAuth: []
components:
  schemas:
    SmartMatchResult:
      type: object
      properties:
        name:
          type: string
          description: The name of the skillset.
          example: Teacher Skillset
        match:
          type: object
          properties:
            overall:
              type: integer
              description: Overall match score.
            knowledge:
              type: integer
              description: Match score for knowledge-based skills.
            transversal:
              type: integer
              description: Match score for transversal skills.
            functional:
              type: integer
              description: Match score for functional skills.
        skills:
          type: array
          description: >-
            List of matched skills with qualification, proficiency, type,
            required and achieved levels, and description.
          items:
            $ref: '#/components/schemas/Skill'
    Skill:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        requiredLevel:
          type: integer
          description: The required proficiency level for the skill.
        achievedLevel:
          type: integer
          description: The achieved proficiency level for the skill.
        type:
          type: string
          enum:
            - KNOWLEDGE
            - TRANSVERSAL
            - FUNCTIONAL
          description: The type of skill.
        description:
          type: string
          description: A detailed description of the skill.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >
        Include your API key in the `x-api-key` header to authenticate requests.
        Each organisation is provided with a unique API key. If your key is lost
        or compromised, contact support to request a new one.

````