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

# Create an access link for a consumer

> Creates a stable link to the consumer's page, meant to be stored or sent (emails, messages, ...). Unlike the link returned when adding a connection, it stays valid until it expires (7 days at most) and opens a fresh session on every visit. Pass a syncid to open a sync of the consumer, or an integrationid to open the connection page of one integration.

**Learn more:**

* What is a consumer? [↗](https://docs.chift.eu/unified-apis/guides/connections.md)
* How to connect a consumer to a software? [↗](https://docs.chift.eu/unified-apis/guides/end-user-connection.md)
* Which errors can this endpoint return? [↗](https://docs.chift.eu/home/errors.md)


## OpenAPI

````yaml post /consumers/{consumer_id}/access-links
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/access-links:
    post:
      tags:
        - Consumers
      summary: Create an access link for a consumer
      description: >-
        Creates a stable link to the consumer's page, meant to be stored or sent
        (emails, messages, ...). Unlike the link returned when adding a
        connection, it stays valid until it expires (7 days at most) and opens a
        fresh session on every visit. Pass a syncid to open a sync of the
        consumer, or an integrationid to open the connection page of one
        integration.
      operationId: consumers_create_access_link
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
      requestBody:
        content:
          application/json:
            schema:
              anyOf:
                - $ref: '#/components/schemas/PostAccessLinkItem'
                - type: 'null'
              title: Item
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessLinkItem'
        '400':
          content:
            application/json:
              example:
                message: The specified integrationid is not active or does not exist.
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Bad Request
        '404':
          content:
            application/json:
              examples:
                consumer:
                  value:
                    message: The consumer does not exist
                    status: error
                sync:
                  value:
                    message: The sync does not exist for this consumer
                    status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - mcp_auth:
            - consumers
components:
  schemas:
    PostAccessLinkItem:
      properties:
        syncid:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Syncid
          description: >-
            Sync the link opens. The consumer must be linked to it. Cannot be
            combined with integrationid.
        integrationid:
          anyOf:
            - type: integer
            - type: 'null'
          title: Integrationid
          description: >-
            Integration the link opens the connection page of. It must be active
            on your account. Cannot be combined with syncid.
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
          description: >-
            Date and time after which the link stops working, at most 7 days
            from now. Defaults to 3 days from now. A value without timezone is
            read as UTC.
      type: object
      title: PostAccessLinkItem
    AccessLinkItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          description: Unique id of the access link, used to revoke it
        url:
          type: string
          title: Url
          description: >-
            Stable URL to share with the consumer. Each visit opens a fresh
            30-minute session until the link expires.
        expires_at:
          type: string
          format: date-time
          title: Expires At
          description: Date and time after which the link stops working
      type: object
      required:
        - id
        - url
        - expires_at
      title: AccessLinkItem
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      required:
        - message
      title: ChiftError
    HTTPValidationError:
      title: Validation Error
      required:
        - message
      type: object
      properties:
        message:
          title: Message
          type: string
          default: Validation error
        status:
          title: Status
          type: string
          default: error
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.