> ## 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.

# Initiate Smart Matches

> Starts a smart match process for a given passport and a list of skillsets.
The results will be sent via a webhook.




## OpenAPI

````yaml post /smart-match
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:
    post:
      summary: Initiate Smart Matches
      description: >
        Starts a smart match process for a given passport and a list of
        skillsets.

        The results will be sent via a webhook.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                publicIdentifer:
                  type: string
                  description: The external unique identifier.
                  example: abc123
                skillsetIds:
                  type: array
                  items:
                    type: string
                  description: A list of skillset IDs to match against.
                  example:
                    - skillset1
                    - skillset2
      responses:
        '200':
          description: Smart match process initiated successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Confirmation message.
                    example: Smart match initiated successfully.
        '400':
          description: Invalid request parameters.
        '401':
          description: Unauthorized. API key is missing or invalid.
        '500':
          description: Internal server error.
      security:
        - apiKeyAuth: []
components:
  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.

````