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

# Create a link session

> Mints a hosted consent flow. Send the user to `url`; they sign in to Redbark (same account as the key), complete the bank consent, and land on `return_url`. Poll `GET /v2/link_sessions/{id}` or subscribe to `connection.created`.



## OpenAPI

````yaml /openapi/v2.json post /link_sessions
openapi: 3.1.0
info:
  title: Redbark API
  version: 2026-10-01.wattle
  description: >-
    Everything a user can do in the dashboard, by API key. Send
    `Redbark-Version` on every request; see the conventions guide for ids,
    lists, errors and idempotency.
servers:
  - url: https://api.redbark.com/v2
security:
  - Bearer: []
    RedbarkVersion: []
tags:
  - name: Account
    description: The authenticated account, its plan and the key in use.
  - name: API keys
    description: Create, scope, rotate and revoke API keys.
  - name: Connections
    description: Linked banks and brokerages, and their lifecycle.
  - name: Consents
    description: Open Banking consents behind each connection.
  - name: Accounts
    description: Bank and brokerage accounts, live balances and details.
  - name: Transactions
    description: Transactions read live from the provider.
  - name: Holdings
    description: Brokerage positions.
  - name: Trades
    description: Brokerage trade history.
  - name: Categories
    description: The category taxonomy and provider categories.
  - name: Syncs
    description: Syncs from accounts to destinations.
  - name: Sync runs
    description: Individual sync executions.
  - name: Rules
    description: Rulesets and rules that transform transactions during a sync.
  - name: Destinations
    description: 'Where synced data lands: Sheets, Airtable, Notion, YNAB, webhooks.'
  - name: Link sessions
    description: Hosted flows that connect a bank or brokerage.
  - name: Destination links
    description: Hosted flows that authorise a destination.
  - name: Institutions
    description: Banks available to link.
  - name: Event destinations
    description: Endpoints that receive signed events.
  - name: Events
    description: What happened, and redelivery.
paths:
  /link_sessions:
    post:
      tags:
        - Link sessions
      summary: Create a link session
      description: >-
        Mints a hosted consent flow. Send the user to `url`; they sign in to
        Redbark (same account as the key), complete the bank consent, and land
        on `return_url`. Poll `GET /v2/link_sessions/{id}` or subscribe to
        `connection.created`.
      operationId: create_link_session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLinkSession'
      responses:
        '201':
          description: The link session
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkSession'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Key lacks a scope, plan lacks the feature, or IP not allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: State conflict or Idempotency-Key conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limited; see Retry-After
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal error; quote request_id to support
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CreateLinkSession:
      type: object
      properties:
        provider:
          type: string
          enum:
            - fiskil
            - akahu
            - snaptrade
        institution:
          type:
            - string
            - 'null'
          maxLength: 100
          description: Fiskil institution id to preselect
        return_url:
          type:
            - string
            - 'null'
          format: uri
        metadata:
          type: object
          additionalProperties:
            type:
              - string
              - 'null'
            maxLength: 500
          description: Up to 50 string pairs. Set a key to null to unset it.
      required:
        - provider
    LinkSession:
      type: object
      properties:
        id:
          type: string
          example: ls_7Kp3Lm5nQr7sTu9vWx1yZa
        object:
          type: string
          enum:
            - link_session
        provider:
          type: string
          enum:
            - fiskil
            - akahu
            - snaptrade
        institution:
          type:
            - string
            - 'null'
        status:
          type: string
          enum:
            - pending
            - completed
            - expired
            - failed
        url:
          type:
            - string
            - 'null'
          description: Hosted page to send the user to while pending
        connection:
          type:
            - string
            - 'null'
        return_url:
          type:
            - string
            - 'null'
        failure_reason:
          type:
            - string
            - 'null'
        expires_at:
          type: string
          format: date-time
          example: '2026-08-21T09:30:00.000Z'
        completed_at:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-08-21T09:30:00.000Z'
        metadata:
          type:
            - object
            - 'null'
          additionalProperties:
            type: string
            maxLength: 500
          description: Up to 50 string pairs. Set a key to null in an update to unset it.
        livemode:
          type: boolean
        created:
          type: string
          format: date-time
          example: '2026-08-21T09:30:00.000Z'
        updated:
          type: string
          format: date-time
          example: '2026-08-21T09:30:00.000Z'
      required:
        - id
        - object
        - provider
        - institution
        - status
        - url
        - connection
        - return_url
        - failure_reason
        - expires_at
        - completed_at
        - metadata
        - livemode
        - created
        - updated
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - rate_limit_error
                - idempotency_error
                - upstream_error
                - api_error
            code:
              type: string
            message:
              type: string
            param:
              type:
                - string
                - 'null'
            doc_url:
              type: string
            request_id:
              type: string
          required:
            - type
            - code
            - message
            - param
            - doc_url
            - request_id
      required:
        - error
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Authorization: Bearer rbk_live_...'
    RedbarkVersion:
      type: apiKey
      in: header
      name: Redbark-Version
      description: >-
        The API release your integration is built against, e.g.
        2026-10-01.wattle. Required on every request.

````