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

# Search businesses

> Search for businesses in your organization with optional filters. Filter by legal_name (partial match), entity_type (exact match), or EIN (exact match). Returns paginated results using cursor-based pagination.



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/business/search
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/search:
    post:
      tags:
        - Business
      summary: Search businesses
      description: >-
        Search for businesses in your organization with optional filters. Filter
        by legal_name (partial match), entity_type (exact match), or EIN (exact
        match). Returns paginated results using cursor-based pagination.
      operationId: searchBusinesses
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessSearchRequest'
      responses:
        '200':
          description: Search results
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - has_more
                  - next_cursor
                  - data
                properties:
                  object:
                    type: string
                    enum:
                      - list
                    example: list
                    description: Object type identifier, always "list"
                  has_more:
                    type: boolean
                    example: true
                    description: Whether there are more results available
                  next_cursor:
                    type: string
                    nullable: true
                    example: crs_7g8h9i0j1k2l3m4n
                    description: >-
                      Cursor for the next page of results. Only present when
                      has_more is true.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BusinessSearchResult'
                    description: Array of resources for the current page
      security:
        - ApiKey: []
components:
  schemas:
    BusinessSearchRequest:
      type: object
      properties:
        display_name:
          type: string
          description: Filter by display name (partial match, case-insensitive)
          example: Acme Corp
        ein:
          type: string
          description: Filter by EIN (exact match). Value is hashed for secure lookup.
          example: 12-3456789
        vault:
          description: >-
            Filter by vault fields using prefixed field names. Supports:
            business.legal_name (partial), business.entity_type,
            business.formation_jurisdiction, business.registration_jurisdiction,
            business.formation_date, business.city (partial), business.region,
            business.postal_code, business.country.
          example:
            business.legal_name: Acme
            business.entity_type: llc
            business.registration_jurisdiction: US-CA
          allOf:
            - $ref: '#/components/schemas/BusinessVaultFields'
        metadata:
          type: object
          description: >-
            Filter by metadata fields. Use dot notation for nested keys.
            Example: { "industry": "technology", "settings.notify": "true" }
          example:
            industry: technology
        cursor:
          type: string
          description: Pagination cursor from previous response
        limit:
          type: number
          description: Maximum number of results to return (1-100)
          default: 25
        sort:
          type: string
          description: Field to sort by
          enum:
            - created_at
            - name
            - jurisdiction
            - entity_type
            - risk_level
            - last_verified
          default: created_at
        order:
          type: string
          description: Sort order direction
          enum:
            - asc
            - desc
          default: desc
    BusinessSearchResult:
      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
    BusinessVaultFields:
      type: object
      properties:
        business.legal_name:
          type: string
          description: Legal business name as registered with the Secretary of State
          example: Acme Corporation
        business.dba_name:
          type: string
          description: Doing Business As (DBA) name
          example: Acme Co
        business.ein:
          type: string
          description: Employer Identification Number (EIN) in format XX-XXXXXXX
          example: 12-3456789
        business.entity_type:
          type: string
          description: Type of business entity
          example: llc
          enum:
            - llc
            - corporation
            - lp
            - llp
            - nonprofit
            - other
        business.formation_date:
          type: string
          description: Date the business was legally formed (YYYY-MM-DD)
          example: '2020-05-15'
        business.formation_jurisdiction:
          type: string
          description: Jurisdiction where the business was originally formed (US-XX format)
          example: US-DE
        business.registration_jurisdiction:
          type: string
          description: >-
            Jurisdiction where the business is registered to operate (US-XX
            format)
          example: US-CA
        business.address_line_1:
          type: string
          description: Business street address line 1
          example: 123 Business Blvd
        business.address_line_2:
          type: string
          description: Business street address line 2 (suite, floor, etc.)
          example: Suite 100
        business.city:
          type: string
          description: Business city
          example: San Francisco
        business.region:
          type: string
          description: Business state, province, or region code
          example: CA
        business.postal_code:
          type: string
          description: Business postal or ZIP code
          example: '94102'
        business.country:
          type: string
          description: Business country (ISO 3166-1 alpha-2 code)
          example: US
        business.phone_number:
          type: string
          description: Business phone number (E.164 format recommended)
          example: '+15551234567'
        business.email:
          type: string
          description: Business email address
          example: contact@acme.com
        business.website:
          type: string
          description: Business website URL
          example: https://acme.com
        business.naics_code:
          type: string
          description: NAICS code for business industry classification
          example: '541511'
    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'

````