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

# Monitor business

> Subscribe to monitoring events for a business identified by `palm_id`, or by `registration_jurisdiction` with `registration_number`. Each identifier names one registration; a business registered in several jurisdictions is monitored per registration. When the organization does not already hold a portfolio business for the registry record, one is created from it and returned with the subscription.



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/business/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: Business
    description: Manage the businesses in your portfolio
  - name: User
    description: Manage the people in your portfolio
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
paths:
  /v1/business/subscription:
    post:
      tags:
        - Monitor
      summary: Monitor business
      description: >-
        Subscribe to monitoring events for a business identified by `palm_id`,
        or by `registration_jurisdiction` with `registration_number`. Each
        identifier names one registration; a business registered in several
        jurisdictions is monitored per registration. When the organization does
        not already hold a portfolio business for the registry record, one is
        created from it and returned with the subscription.
      operationId: monitorBusiness
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionActivateRequest'
      responses:
        '201':
          description: Subscription created; the monitored portfolio business is embedded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionActivateResponse'
        '400':
          description: Invalid request data or unsupported identifier combination
        '401':
          description: Unauthorized - Invalid or missing API key
        '403':
          description: State not available for this organization
        '404':
          description: No registry record matches the identifier
        '409':
          description: Subscription already exists for this business
        '422':
          description: >-
            The identifier matches more than one registration (candidates
            included), or the registration carries no registry source
        '429':
          description: Rate limit exceeded
        '500':
          description: Internal server error
        '503':
          description: Registry lookup is temporarily unavailable; retryable
      security:
        - ApiKey: []
components:
  schemas:
    SubscriptionActivateRequest:
      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
        palm_id:
          type: string
          description: >-
            Palm ID of the registry business to monitor. Provide either this or
            registration_jurisdiction with registration_number.
          example: 4604-3477-1850
        registration_jurisdiction:
          type: string
          description: >-
            Registration jurisdiction in ISO 3166-2 format (e.g., US-CA, US-NY,
            US-TX)
          example: US-DE
        registration_number:
          type: string
          description: The entity's registration number in that jurisdiction
          example: '7286832'
      required:
        - event_types
    SubscriptionActivateResponse:
      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
          format: uuid
          example: 987e6543-e21a-45b6-c789-012345678901
        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
            - canceled
          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
        business:
          description: >-
            The portfolio business monitored by this subscription, created from
            the registry record or reused
          allOf:
            - $ref: '#/components/schemas/Business'
      required:
        - id
        - object
        - resource_type
        - resource_id
        - event_types
        - status
        - mode
        - metadata
        - created_at
        - updated_at
        - expires_at
        - business
    Business:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        object:
          type: string
          description: Object type identifier, always "business"
          example: business
          enum:
            - business
        mode:
          type: string
          description: >-
            Whether this resource was created with test or live credentials.
            Test and live data are fully isolated — a test resource never
            appears in live results and vice versa.
          enum:
            - test
            - live
          example: live
        created_at:
          type: string
          description: ISO 8601 timestamp of when the resource was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the resource was last updated
          format: date-time
          example: '2025-10-24T15:45:00Z'
        metadata:
          type: object
          description: >-
            Store up to 50 custom key-value pairs for application-specific data.
            Useful for storing references to external systems, feature flags, or
            other custom attributes.
          additionalProperties:
            type: string
          example:
            external_id: user_123_in_my_system
            customer_tier: premium
            signup_source: mobile_app
        palm_id:
          type: string
          description: >-
            Palm identifier for the business, used for monitoring and external
            integrations
          nullable: true
          example: 1234-5678-9012
        status:
          type: string
          description: Current status of the business
          enum:
            - active
            - suspended
            - deleted
          example: active
        display_name:
          type: string
          description: Display name for the business
          nullable: true
          example: Acme Corp
        ein_fingerprint:
          type: string
          description: >-
            SHA-256 fingerprint of the business's EIN (Employer Identification
            Number). Used for duplicate detection and search without exposing
            the actual EIN. Automatically generated when EIN is stored in vault.
          nullable: true
          example: c9f6ef5h141i49398hkm345621iii90jh3el0007
        verification:
          description: >-
            Most recent verification information. Null if business has never
            been verified.
          nullable: true
          type: object
          allOf:
            - $ref: '#/components/schemas/BusinessVerification'
        vault:
          type: object
          description: >-
            Cached vault field values for non-encrypted fields. Keys are full
            field IDs (e.g., "business.legal_name"). Only includes fields where
            encrypted=false in vault_field_definition.
          additionalProperties: true
          nullable: true
          example:
            business.legal_name: Acme Corporation Inc.
            business.entity_type: llc
            business.formation_jurisdiction: US-DE
            business.formation_date: '2020-03-15'
            business.address_line_1: 123 Main St
            business.city: San Francisco
            business.region: CA
            business.postal_code: '94105'
            business.country: US
      required:
        - id
        - object
        - mode
        - created_at
        - updated_at
        - metadata
        - palm_id
        - status
        - display_name
        - ein_fingerprint
        - verification
        - vault
    BusinessVerification:
      type: object
      properties:
        id:
          type: string
          description: ID of the verification attempt
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        risk_level:
          type: string
          description: >-
            Risk level determined by the verification. Null while the
            verification is still in progress.
          enum:
            - low
            - medium
            - high
            - critical
          nullable: true
          example: low
        workflow:
          description: Workflow used for this verification
          allOf:
            - $ref: '#/components/schemas/BusinessVerificationWorkflow'
        executed_at:
          type: string
          description: Timestamp when the verification was executed
          format: date-time
          example: '2024-01-15T10:30:00.000Z'
      required:
        - id
        - risk_level
        - workflow
        - executed_at
    BusinessVerificationWorkflow:
      type: object
      properties:
        name:
          type: string
          description: Name of the workflow
          example: Business Verification
        version:
          type: number
          description: Version of the workflow
          example: 1
      required:
        - name
        - version
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````