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

# Update a business

> Updates a business's display name or metadata. Metadata updates are merged with existing values; set a key to null to remove it.



## OpenAPI

````yaml /api-reference/v1/openapi.json patch /v1/business/{business_id}
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}:
    patch:
      tags:
        - Business
      summary: Update a business
      description: >-
        Updates a business's display name or metadata. Metadata updates are
        merged with existing values; set a key to null to remove it.
      operationId: updateBusiness
      parameters:
        - name: business_id
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessUpdateRequest'
      responses:
        '200':
          description: Business updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Business'
      security:
        - ApiKey: []
components:
  schemas:
    BusinessUpdateRequest:
      type: object
      properties:
        metadata:
          type: object
          description: >-
            Store up to 50 custom key-value pairs for application-specific data.
            Metadata updates are merged with existing metadata. To remove a
            metadata field, set its value to null.
          additionalProperties:
            type: string
          maxProperties: 50
          example:
            customer_tier: premium
            notes: Upgraded to premium tier
        display_name:
          type: string
          description: Display name for the business
          example: Acme Corp
    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'

````