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

# Create Onboarding Token

> Generates an onboarding token, returning a unique link with a signature.
The API consumer is responsible for sending the invitation or redirecting users to this link.




## OpenAPI

````yaml post /onboarding/token
openapi: 3.0.3
info:
  title: Everday Onboarding API
  version: 1.0.0
  description: >
    ## Onboarding API

    This API allows organisations to create, retrieve, and revoke onboarding
    tokens. Authentication is required for all endpoints using an API key.
servers:
  - url: https://api.ever.day
security: []
paths:
  /onboarding/token:
    post:
      summary: Create Onboarding Token
      description: >
        Generates an onboarding token, returning a unique link with a signature.

        The API consumer is responsible for sending the invitation or
        redirecting users to this link.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                publicIdentifier:
                  type: string
                  description: A unique identifier for the user.
                  example: john-doe-1234
                redirectUrl:
                  type: string
                  description: >-
                    The URL to which the user will be redirected after
                    onboarding is completed.
                  example: https://platform.client.com/complete
      responses:
        '201':
          description: Onboarding token successfully created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingResponse'
        '400':
          description: Invalid request parameters.
        '401':
          description: Unauthorized. API key is missing or invalid.
        '500':
          description: Internal server error.
      security:
        - apiKeyAuth: []
components:
  schemas:
    OnboardingResponse:
      type: object
      properties:
        signature:
          type: string
          description: A unique signature used for verifying the onboarding link.
          example: a1b2c3d4...
        status:
          type: string
          enum:
            - pending
            - completed
            - revoked
          description: The status of the onboarding process.
          example: pending
        link:
          type: string
          nullable: true
          description: The generated onboarding link for the user. Null if revoked.
          example: https://onboarding.ever.day/243324-234324-123123?signature=a1b2c3...
  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.

````