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

# Subscribe to business monitoring events

> Subscribe to monitoring events for a business to receive real-time notifications about watchlist hits, registration updates, ownership changes, and other compliance events.



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/business/{business_id}/subscription
openapi: 3.0.0
info:
  title: Palm Partner API
  description: >-
    The Palm API is identity verification and compliance infrastructure for US
    businesses: onboard businesses, verify businesses and people (KYB/KYC)
    against authoritative sources, monitor them for changes in real time, and
    act on their behalf through filings, formation, and registered agent
    services.
  version: '1.0'
  contact:
    name: Palm Support
    url: https://getpalm.com
    email: support@getpalm.com
  termsOfService: https://getpalm.com/terms
  license:
    name: Proprietary
    url: https://getpalm.com/license
servers:
  - url: https://api.getpalm.com
    description: Production
security: []
tags:
  - name: Registry
    description: Search business registries
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
  - name: Business
    description: Business entity management
  - name: User
    description: User identity management
paths:
  /v1/business/{business_id}/subscription:
    post:
      tags:
        - Monitor
      summary: Subscribe to business monitoring events
      description: >-
        Subscribe to monitoring events for a business to receive real-time
        notifications about watchlist hits, registration updates, ownership
        changes, and other compliance events.
      operationId: createBusinessSubscription
      parameters:
        - name: business_id
          required: true
          in: path
          description: Business ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionCreateRequest'
      responses:
        '201':
          description: Subscription created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription'
        '400':
          description: Invalid request data
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Business not found
        '409':
          description: Subscription already exists for this business
        '429':
          description: Rate limit exceeded
        '500':
          description: Internal server error
      security:
        - ApiKey: []
components:
  schemas:
    SubscriptionCreateRequest:
      type: object
      properties:
        event_types:
          type: array
          description: >-
            List of webhook event types to subscribe to for monitoring
            notifications
          example:
            - business.registration.updated
            - business.filing.due
          minItems: 1
          items:
            type: string
            enum:
              - business.registration.updated
              - business.filing.due
              - business.filing.overdue
        metadata:
          type: object
          description: Custom metadata for the subscription
          example:
            customer_tier: premium
            monitoring_level: enhanced
      required:
        - event_types
    Subscription:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the subscription
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        object:
          type: string
          description: Object type identifier
          enum:
            - subscription
          example: subscription
        resource_type:
          type: string
          description: Type of resource being monitored
          enum:
            - user
            - business
          example: business
        resource_id:
          type: string
          description: ID of the user or business being monitored
          example: 123e4567-e89b-12d3-a456-426614174000
        event_types:
          type: array
          description: >-
            List of webhook event types subscribed to for monitoring
            notifications
          example:
            - business.registration.updated
            - business.filing.due
          items:
            type: string
            enum:
              - business.registration.updated
              - business.filing.due
              - business.filing.overdue
        status:
          type: string
          description: Current status of the subscription
          enum:
            - active
            - paused
            - expired
            - cancelled
          example: active
        mode:
          type: string
          description: >-
            Whether the subscription belongs to test or live mode, determined by
            the API key used to create it
          enum:
            - test
            - live
          example: live
        metadata:
          type: object
          description: Custom metadata for the subscription
          example:
            customer_tier: premium
            monitoring_level: enhanced
        created_at:
          type: string
          description: ISO 8601 timestamp when the subscription was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp when the subscription was last updated
          format: date-time
          example: '2025-10-24T15:45:00Z'
        expires_at:
          type: string
          description: >-
            ISO 8601 timestamp when the subscription expires (for paid
            subscriptions)
          format: date-time
          example: '2026-10-24T10:30:00Z'
          nullable: true
      required:
        - id
        - object
        - resource_type
        - resource_id
        - event_types
        - status
        - mode
        - metadata
        - created_at
        - updated_at
        - expires_at
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````