openapi: 3.2.0
info:
  title: CLIENT ORG MANAGEMENT Clients API
  description: These API's are used to manage client org information
  termsOfService: http://lynx-fh.com
  license:
    name: LynxFH
    url: http://lynx-fh.com
  version: '"1.0"'
servers:
- url: https://sandbox.lynx-fh.co
security:
- bearerAuth: []
tags:
- name: Clients
paths:
  /clients/applications:
    get:
      tags:
      - Clients
      summary: Get Client Org Applications
      description: Retrieves a list of all applications associated with a specific client organization.
      operationId: getClientOrgApplications
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgApplicationsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /clients/events:
    get:
      tags:
      - Clients
      summary: Get Client Org Subscribed Events
      description: Retrieves ALL subscribed events for a client organization
      operationId: getClientOrgSubscribedEvents
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClientOrgSubscribedEventsResponse'
        '400':
          description: Bad request
        '404':
          description: Not found
    put:
      tags:
      - Clients
      summary: Update Client Org Subscribed Events
      description: Updates the subscribed events for a client organization.
      operationId: updateClientOrgSubscribedEvents
      requestBody:
        description: This is the client org subscribed events request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientOrgSubscribedEventsRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /clients/plans/list:
    get:
      tags:
      - Clients
      summary: Get Client Org Plan Summary
      description: Retrieves a list of all plans and associated products and card packages for a request client organization and all child client organizations.
      operationId: getClientOrgPlanSummary
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: includeChildren
        in: query
        description: Include child client org indicator
        required: false
        schema:
          type: string
          default: 'false'
          enum:
          - 'false'
          - 'true'
        example: false
      - name: page
        in: query
        description: Page number to be returned. If not specified, default is 1.
        required: false
        schema:
          type: integer
          default: 1
        example: 1
      - name: pageSize
        in: query
        description: Maximum number of items to be returned per page. If not specified, default is 25.
        required: false
        schema:
          type: integer
          default: 25
        example: 25
      - name: sortValue
        in: query
        description: The property by which the response is sorted
        required: false
        schema:
          type: string
          default: creationDate
          enum:
          - creationDate
          - updateDate
      - name: sortOrder
        in: query
        description: The sort direction
        required: false
        schema:
          type: string
          default: Descending
          enum:
          - Ascending
          - Descending
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClientOrgPlanSummaryResponse'
        '400':
          description: 'Bad request.

            - GBL-282: No clientOrgApplication with FISPPS partner org found for client org

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /clients/substantiation-model:
    patch:
      tags:
      - Clients
      summary: Client Org Substantiation Model
      description: This API is used to update auto-substantiation rules and customize the substantiation notification workflow stages, including the method and frequency of notifications.
      operationId: patchClientOrgSubstantiationModel
      requestBody:
        description: This is patch ClientOrgSubstantiationModel request body
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClientOrgSubstantiationModelRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchClientOrgSubstantiationModelResponse'
        '400':
          description: 'Bad request.

            - GBL-322: De minimis amount is required when de minimis indicator is true

            - GBL-325: Initial stage must have Days in Stage greater than 0

            - GBL-326: Initial stage Block Account Indicator cannot be true

            - GBL-323: For stage, Days in Stage > 0, Block Account Indicator cannot be true

            - GBL-324: For stage, Days in Stage is 0, Block Account Indicator must be true

            '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
    get:
      tags:
      - Clients
      summary: Client Org Substantiation Model
      description: This API is used to view auto-substantiation rules and substantiation notification workflow stages, including the method and frequency of notifications.
      operationId: getClientOrgSubstantiationModel
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgSubstantiationModelDto'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
  /clients/webhooks:
    get:
      tags:
      - Clients
      summary: Get WebHook URLs
      description: Retrieves ALL configuration values for a client organization for the webhooks
      operationId: getClientOrgWebHookUrls
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgWebHooks'
        '400':
          description: Bad request
        '404':
          description: Not found
    post:
      tags:
      - Clients
      summary: Add WebHook URL
      description: Adds a configuration webhook URL for a client organization
      operationId: addClientOrgWebHookUrl
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WebHookRequest'
        required: true
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgWebHooks'
        '400':
          description: Bad request
        '404':
          description: Not found
    delete:
      tags:
      - Clients
      summary: Delete WebHook URL
      description: Deletes the webhook URL configuration values for a client organization
      operationId: deleteClientOrgWebHookUrl
      parameters:
      - name: clientOrgName
        in: query
        description: The name of the client organization
        required: true
        schema:
          type: string
        example: Health_Plan_ABC_Division
      - name: webHookId
        in: query
        description: The unique identifier for the webhook URL
        required: true
        schema:
          type: string
        example: 4dbdd4694-4875-47d2-b663-04d9aee9ee30
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientOrgWebHooks'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
        '401':
          description: Not authorized
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionBaseResponse'
components:
  schemas:
    ClientOrgDocumentDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier (UUID) for the uploaded business document.
          example: e5fa0a77-27f5-4df3-9f14-a3d8d19ec264
        type:
          type: string
          description: Type of document requested.
          example: ID verification
        status:
          type: string
          description: Status of document.
          example: Awaiting_Documents
        statusReason:
          type: string
          description: The current status of the document
          example: Required
    ClientOrgSubscribedEventDto:
      type: object
      properties:
        eventName:
          type: string
          description: Name of the event
          example: Transaction Created
        eventType:
          type: string
          description: Type of the event
          example: lynx.transactionCreated
        subscribed:
          type: boolean
          description: Event subscribed
          example: true
        disabled:
          type: boolean
          description: Event disabled
          example: false
      required:
      - eventType
      - subscribed
    ClientOrgCardSubprogramDetailsDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the plan
          example: Health Plan ABC HSA Plan
        partnerId:
          type: string
          description: Internal identifier for the plan
          example: 12345
        binType:
          type: string
          description: Internal identifier assigned by the card-issuing financial institution for the type of the Bank Identification Number (BIN)
          example: BHM
        status:
          type: string
          description: The current status of the plan.
          example: Pending
        statusReason:
          type: string
          description: The reason for a particular status
          example: HSA rejected due to lack of documentation
        creationDate:
          type: string
          format: date-time
          description: Date when the record was created
          example: '2024-10-10'
        updateDate:
          type: string
          format: date-time
          description: Date when the record was last updated
          example: '2024-10-10'
        products:
          type: array
          items:
            $ref: '#/components/schemas/ProductNameDto'
        cardPackages:
          type: array
          items:
            $ref: '#/components/schemas/CardPackageDetailsDto'
    Data:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrg'
        clientOrgWebHook:
          $ref: '#/components/schemas/WebHook'
    WebHook:
      type: object
      properties:
        url:
          type: string
        encryptionIndicator:
          type: boolean
        deliveryMode:
          type: string
          enum:
          - AtLeastOnce
          - AtMostOnce
    ClientOrgDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the client organization
          example: Health_Plan_ABC_Division
      required:
      - name
    GetClientOrgPlanSummaryResponse:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        clientOrgs:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgPlanSummaryDto'
    PatchClientOrgSubstantiationModelResponse:
      type: object
      properties:
        clientOrgName:
          type: string
          description: The name of the client organization
          example: Lorem
        enabled:
          type: boolean
          description: Indicates whether the client organization substantiation model is enabled.  If the substantiation model is not enabled, no substantiation will be performed and no notifications will be generated
          example: true
      required:
      - clientOrgName
      - enabled
    CardPackageDetailsDto:
      type: object
      properties:
        clientOrgCardPackageId:
          type: string
          format: uuid
        name:
          type: string
          description: The name of the card package
          example: Health Plan ABC Blue Card
        partnerId:
          type: string
          description: Internal identifier for the card package
          example: 12345
        binType:
          type: string
          description: Internal identifier assigned by the card-issuing financial institution for the type of the Bank Identification Number (BIN)
          example: BHM
        virtualCardIndicator:
          type: boolean
          description: Indicates whether this is a virtual card package
          example: 'False'
        prin:
          type: string
        beginAgent:
          type: integer
          format: int32
        endAgent:
          type: integer
          format: int32
        status:
          type: string
        statusReason:
          type: string
        cardPackageId:
          type: string
          format: uuid
    ClientOrgSubstantiationModelStageDto:
      type: object
      properties:
        stageCode:
          type: string
          description: Abbreviation for the substantiation stage; PNDS1=Pending - Stage 1, PNDS2=Pending - Stage 2, PNDS3=Pending - Stage 3, PNDS4=Pending - Stage 4, PMIS1=Pending More Info - Stage 1, PMIS2=Pending More Info - Stage 2, PMIS3=Pending More Info - Stage 3, PMIS4=Pending More Info - Stage 4, IELS1=Ineligible - Stage 1, IELS2=Ineligible - Stage 2, IELS3=Ineligible - Stage 3, IELS4=Ineligible - Stage 4
          enum:
          - PNDS1
          - PNDS2
          - PNDS3
          - PNDS4
          - PMIS1
          - PMIS2
          - PMIS3
          - PMIS4
          - IELS1
          - IELS2
          - IELS3
          - IELS4
          - PNDAR
          - PMIAR
          - IELPR
          - AUTO
          example: PNDS1
        stageName:
          type: string
          description: Substantiation stage name
          example: Pending - Stage 1
        daysInStage:
          type: integer
          format: int32
          description: Number of days a transaction will remain in the substantiation stage before moving to the next stage; a substantiation notification is generated when a transaction is moved into a new stage and not at the end of a stage.  If the Block Account Indicator is true for the stage, then Days in Stage must be 0.
          example: 15
        blockAccountIndicator:
          type: boolean
          description: Indicates whether the account/purse associated to the transaction should be blocked when a transaction is moved into this stage; standard configuration default is false, except for all end stages, PNDS4, PMIS4, and IELS4, which are a default of true
          example: false
        sendEmailIndicator:
          type: boolean
          description: Indicates whether an email notification is sent, provided the member has an email address on file, when a transaction is moved into this stage; standard configuration default is false
          example: true
        sendEventIndicator:
          type: boolean
          description: Indicates whether a webhook is sent when a transaction is moved into this stage; standard configuration default is true
          example: true
      required:
      - blockAccountIndicator
      - daysInStage
      - sendEmailIndicator
      - sendEventIndicator
      - stageCode
      - stageName
    ClientOrgPlanSummaryDto:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgPlanDto'
        plans:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgCardSubprogramDetailsDto'
    ClientOrgSubstantiationModelRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ClientOrgSubstantiationModelData'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
      required:
      - data
      - idempotency
    ClientOrgWebHookDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The lynx webhook url for which client organization is subscribed to
        url:
          type: string
        encryptionIndicator:
          type: boolean
        deliveryMode:
          type: string
        active:
          type: boolean
        token:
          type: string
        addDatetime:
          type: string
          format: date-time
      required:
      - id
    ClientOrgSubstantiationModelStageData:
      type: object
      properties:
        stageCode:
          type: string
          description: Abbreviation for the substantiation stage; PNDS1=Pending - Stage 1, PNDS2=Pending - Stage 2, PNDS3=Pending - Stage 3, PNDS4=Pending - Stage 4, PMIS1=Pending More Info - Stage 1, PMIS2=Pending More Info - Stage 2, PMIS3=Pending More Info - Stage 3, PMIS4=Pending More Info - Stage 4, IELS1=Ineligible - Stage 1, IELS2=Ineligible - Stage 2, IELS3=Ineligible - Stage 3, IELS4=Ineligible - Stage 4
          enum:
          - PNDS1
          - PNDS2
          - PNDS3
          - PNDS4
          - PMIS1
          - PMIS2
          - PMIS3
          - PMIS4
          - IELS1
          - IELS2
          - IELS3
          - IELS4
          example: PNDS1
        daysInStage:
          type: integer
          format: int32
          description: Number of days a transaction will remain in the substantiation stage before moving to the next stage; a substantiation notification is generated when a transaction is moved into a new stage and not at the end of a stage.  If the Block Account Indicator is true for the stage, then Days in Stage must be 0.
          example: 15
        blockAccountIndicator:
          type: boolean
          description: Indicates whether the account/purse associated to the transaction should be blocked when a transaction is moved into this stage; standard configuration default is false, except for all end stages, PNDS4, PMIS4, and IELS4, which are a default of true
          example: false
        sendEmailIndicator:
          type: boolean
          description: Indicates whether an email notification is sent, provided the member has an email address on file, when a transaction is moved into this stage; standard configuration default is false
          example: true
        sendEventIndicator:
          type: boolean
          description: Indicates whether a webhook is sent when a transaction is moved into this stage; standard configuration default is true
          example: true
      required:
      - stageCode
    ResponseException:
      type: object
      properties:
        errorCode:
          type: string
          description: The GBL error code that is populated when the exceptionSource is SYSTEM
        exceptionSource:
          type: string
          description: Characterizes the type of exception (JSON, SYSTEM, PARAMETER)
        exceptionMessage:
          type: string
          description: Additional information about the exception
    ClientOrgWebHooks:
      type: object
      properties:
        clientOrgWebHooks:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgWebHookDto'
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
    ExceptionBaseResponse:
      type: object
      properties:
        data:
          type: object
          description: 'null'
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/ResponseException'
    GetClientOrgSubscribedEventsResponse:
      type: object
      properties:
        clientOrgSubscribedEvents:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgSubscribedEventDto'
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
    Idempotency:
      type: object
      properties:
        idempotencyKey:
          type: string
          description: Unique identifier that represents the operation
          example: cf82639c-e3b6-4d51-9871-0e452a2b1566
    ProductNameDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the product
          example: HSA_01
      required:
      - name
    PartnerOrgDto:
      type: object
      properties:
        name:
          type: string
          description: Partner orgnaization name
          example: Bank Name
    ClientOrgSubstantiationModelData:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Lorem
        enabled:
          type: boolean
          description: Indicates whether the client organization substantiation model is enabled.  If the substantiation model is not enabled, no substantiation will be performed and no notifications will be generated
          example: true
        copayIndicator:
          type: boolean
          description: Indicates whether the copay auto-substantiation method should be utilized; default is false
          example: false
        recurringExpenseIndicator:
          type: boolean
          description: Indicates whether the recurring expense auto-substantiation method should be utilized; default is false
          example: false
        carrierClaimsIndicator:
          type: boolean
          description: Indicates whether a carrier claims file will be transmitted to be used for the substantiation of medical and dental claims; default is false
          example: false
        pbmIndicator:
          type: boolean
          description: Indicates whether a PBM file will be transmitted to be used for the substantiation of prescription transactions; default is false
          example: false
        deMinimisIndicator:
          type: boolean
          description: Indicates whether a de minimis amount should be enabled where if a transaction is equal to or less than that dollar amount, it will automatically be substantiated; default is false
          example: false
        deMinimisAmount:
          type: number
          description: Dollar amount to automatically substantiate if de minimis functionality is enabled; default is $25
          example: 25
        useDefaultConfigurationIndicator:
          type: boolean
          description: Indicates whether the parent client organization substantiation model should be utilized instead of defining a custom configuration for a child client organization.  If this is the root level client organization, this should be set to false and Stage Detail is required, else substantiation will not be utilized and no substantiation actions will occur.  If this is a child client organization and a custom configuration is needed, this should be set to false and Stage Detail is required
          example: false
        stages:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgSubstantiationModelStageData'
      required:
      - clientOrg
    ClientOrgPlanDto:
      type: object
      properties:
        name:
          type: string
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        partnerId:
          type: string
          description: Internal identifier for the client organization
          example: 12345
    ClientOrgApplicationDto:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier
          example: cf82639c-e3b6-4d51-9871-1e452a2a0001
        partnerOrg:
          $ref: '#/components/schemas/PartnerOrgDto'
        partnerApplicationId:
          type: string
          description: Partner application identifier
          example: APP123456
        partnerClientOrgId:
          type: string
          description: Partner organization identifier
          example: Partner organization identifier
        clientOrgDocuments:
          type: array
          description: List of documents associated with this application
          items:
            $ref: '#/components/schemas/ClientOrgDocumentDto'
        status:
          type: string
          description: The current status of the application
          example: App_Approved
        statusReason:
          type: string
          description: The reason for a particular status
          example: HSA rejected due to lack of documentation
        clientOrgContactId:
          type: string
          format: uuid
          description: The unique id of the client org contact
          example: 40cd232c-4b42-469c-81d1-d04bf3e95b98
        parentName:
          type: string
        clientName:
          type: string
        treeLevel:
          type: integer
          format: int32
    ClientOrgApplicationsResponse:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
        clientOrgApplications:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgApplicationDto'
    ClientOrg:
      type: object
      properties:
        name:
          type: string
    ClientOrgSubstantiationModelDto:
      type: object
      properties:
        clientOrgName:
          type: string
          description: The name of the client organization
          example: Lorem
        copayIndicator:
          type: boolean
          description: Indicates whether the copay auto-substantiation method should be utilized; default is false
          example: false
        recurringExpenseIndicator:
          type: boolean
          description: Indicates whether the recurring expense auto-substantiation method should be utilized; default is false
          example: false
        carrierClaimsIndicator:
          type: boolean
          description: Indicates whether a carrier claims file will be transmitted to be used for the substantiation of medical and dental claims; default is false
          example: false
        pbmIndicator:
          type: boolean
          description: Indicates whether a PBM file will be transmitted to be used for the substantiation of prescription transactions; default is false
          example: false
        deMinimisIndicator:
          type: boolean
          description: Indicates whether a de minimis amount should be enabled where if a transaction is equal to or less than that dollar amount, it will automatically be substantiated; default is false
          example: false
        deMinimisAmount:
          type: number
          description: Dollar amount to automatically substantiate if de minimis functionality is enabled; default is $25
          example: 25
        useDefaultConfigurationIndicator:
          type: boolean
          description: Indicates whether the parent client organization substantiation model should be utilized instead of defining a custom configuration for a child client organization.  If this is the root level client organization, this should be set to false and Stage Detail is required, else substantiation will not be utilized and no substantiation actions will occur.  If this is a child client organization and a custom configuration is needed, this should be set to false and Stage Detail is required
          example: false
        enabled:
          type: boolean
          description: Indicates whether the client organization substantiation model is enabled.  If the substantiation model is not enabled, no substantiation will be performed and no notifications will be generated
          example: true
        stages:
          type: array
          items:
            $ref: '#/components/schemas/ClientOrgSubstantiationModelStageDto'
        deMinimasAmount:
          type: number
          writeOnly: true
      required:
      - carrierClaimsIndicator
      - clientOrgName
      - copayIndicator
      - deMinimisAmount
      - deMinimisIndicator
      - enabled
      - pbmIndicator
      - recurringExpenseIndicator
      - useDefaultConfigurationIndicator
    WebHookRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/Data'
        idempotency:
          $ref: '#/components/schemas/Idempotency'
    ClientOrgSubscribedEventsRequest:
      type: object
      properties:
        clientOrg:
          $ref: '#/components/schemas/ClientOrgDto'
          description: The name of the client organization
          example: Health_Plan_ABC_Division
        clientOrgSubscribedEvents:
          type: array
          description: List of client org events to subscribe to or unsubscribe from. "eventName" and "disabled" fields will be ignored.
          example:
            eventType: lynx.transactionCreated
            subscribed: true
          items:
            $ref: '#/components/schemas/ClientOrgSubscribedEventDto'
      required:
      - clientOrg
      - clientOrgSubscribedEvents
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: searched
  source: https://docs.lynx-fh.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.lynx-fh.com/reference/addclientorgwebhookurl.md
  - https://docs.lynx-fh.com/reference/deleteclientorgwebhookurl.md
  - https://docs.lynx-fh.com/reference/generateapplicationtoken.md
  - https://docs.lynx-fh.com/reference/getclientorgapplications.md
  - https://docs.lynx-fh.com/reference/getclientorgplansummary.md
  - https://docs.lynx-fh.com/reference/getclientorgsubscribedevents.md
  - https://docs.lynx-fh.com/reference/getclientorgsubstantiationmodel.md
  - https://docs.lynx-fh.com/reference/getclientorgwebhookurls.md
  - https://docs.lynx-fh.com/reference/patchclientorgsubstantiationmodel.md
  - https://docs.lynx-fh.com/reference/updateclientorgsubscribedevents.md
  merge:
    pages: 10
    deduped: 36
    conflicts_kept_first: 0