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

# Verify business

> Executes a configurable business verification workflow which utilizes authoritative sources (Secretary of State, IRS TIN matching, business registries), optionally verifies associated people, and returns risk assessment with field-level match results. The required fields are determined by the selected verification workflow.

## Response status

The HTTP response is always `201`; the verification outcome is carried by `status` in the body, so check it first.

- **`completed`** — Resolved immediately. `risk` and `match` are populated: a confident match returns the agreeing fields and a risk level, while a no-match returns an empty `match` with `risk.level: critical`.
- **`in_progress`** — Could not be resolved immediately and is continuing asynchronously; `risk` and `match` are not yet set. Wait for the `business.verification.completed` webhook, which delivers the final result in this same shape.
- **`failed`** — A system error occurred (rare); safe to retry.

`risk` and `match` are only meaningful once `status` is `completed`.



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/business/verification
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/verification:
    post:
      tags:
        - Verification
      summary: Verify business
      description: >-
        Executes a configurable business verification workflow which utilizes
        authoritative sources (Secretary of State, IRS TIN matching, business
        registries), optionally verifies associated people, and returns risk
        assessment with field-level match results. The required fields are
        determined by the selected verification workflow.


        ## Response status


        The HTTP response is always `201`; the verification outcome is carried
        by `status` in the body, so check it first.


        - **`completed`** — Resolved immediately. `risk` and `match` are
        populated: a confident match returns the agreeing fields and a risk
        level, while a no-match returns an empty `match` with `risk.level:
        critical`.

        - **`in_progress`** — Could not be resolved immediately and is
        continuing asynchronously; `risk` and `match` are not yet set. Wait for
        the `business.verification.completed` webhook, which delivers the final
        result in this same shape.

        - **`failed`** — A system error occurred (rare); safe to retry.


        `risk` and `match` are only meaningful once `status` is `completed`.
      operationId: verifyBusiness
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BusinessVerificationRequest'
      responses:
        '201':
          description: >-
            Verification accepted. Carries either a terminal outcome (`status:
            completed` — confident match OR "no match" with `risk.level:
            critical` + empty `match`) or an async-pending outcome (`status:
            in_progress` — final result delivered via the
            `business.verification.completed` webhook).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessVerificationResponse'
        '400':
          description: Invalid request data or missing required fields for workflow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetail'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProblemDetail'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimitProblemDetail'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorProblemDetail'
      security:
        - ApiKey: []
components:
  schemas:
    BusinessVerificationRequest:
      type: object
      properties:
        reference_id:
          type: string
          description: Your reference ID for tracking
          example: biz_12345
        workflow_key:
          type: string
          description: Workflow key to use for verification (determines required fields)
          pattern: ^[a-z0-9_]+$
          default: business_verification_default
          example: business_verification_default
        legal_name:
          type: string
          example: The Coca-Cola Company
          description: Legal business name
        ein:
          type: string
          example: 58-0628465
          description: Employer Identification Number
        entity_type:
          type: string
          example: corporation
          description: Entity type
          enum:
            - llc
            - corporation
            - lp
            - llp
            - nonprofit
            - other
        registration_jurisdiction:
          type: string
          example: US-FL
          description: >-
            Registration jurisdiction in ISO 3166-2 format (e.g., US-CA, US-NY,
            US-TX)
        formation_jurisdiction:
          type: string
          example: US-DE
          description: >-
            Formation jurisdiction in ISO 3166-2 format (e.g., US-DE, US-CA,
            US-WY)
        formation_date:
          type: string
          example: '1961-01-03'
          format: date
          description: Formation date (YYYY-MM-DD)
        address_line_1:
          type: string
          example: One Coca-Cola Plaza NW
          description: Street address line 1
        address_line_2:
          type: string
          example: Suite 100
          description: Street address line 2
        city:
          type: string
          example: Atlanta
          description: City
        region:
          type: string
          example: GA
          description: Region (state/province/county)
        postal_code:
          type: string
          example: '30313'
          description: Postal code
        country:
          type: string
          example: US
          description: Country (2-letter ISO code)
        phone_number:
          type: string
          example: '+15551234567'
          description: Business phone number
        email:
          type: string
          example: contact@coca-cola.com
          description: Business email address
        website:
          type: string
          example: https://www.coca-cola.com
          description: Business website URL
        associates:
          description: Associated people to verify
          type: array
          items:
            $ref: '#/components/schemas/AssociateRequest'
        metadata:
          type: object
          description: >-
            Custom metadata.


            In **test mode** (`sk_test_` key), business verification is **always
            simulated** — it never queries live registry, IRS, or any
            authoritative source, so no-directive test requests return a
            deterministic clean pass rather than real registry data. The
            reserved key `_simulate` selects the outcome. Value is
            `<outcome>[:sync]`:


            - Risk levels: `low` (default), `medium`, `high`, `critical`

            - Scenarios: `inactive`, `sanctions`, `lien`, `tin_mismatch`,
            `no_match`

            - `fail` → terminal `status: failed`

            - Append `:sync` (e.g. `low:sync`) to complete synchronously;
            otherwise the result is delivered asynchronously via the
            `business.verification.completed` webhook after a short delay.


            Ignored in live mode.
          example:
            external_id: biz_789
            source: onboarding_flow
      required:
        - workflow_key
        - legal_name
        - region
    BusinessVerificationResponse:
      type: object
      properties:
        verification_id:
          type: string
          description: Unique verification ID
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        business_id:
          type: string
          description: ID of the business entity created or verified
          example: bus_abc123
        reference_id:
          type: string
          description: Your reference ID (if provided in request)
          example: biz_12345
        status:
          type: string
          description: >-
            Current status of the verification. Branch on this before reading
            `risk` or `match`:


            - `completed` — Terminal. Either a confident match (populated
            `match`, evaluated `risk.level`) OR a "no match" verdict (empty
            `match: {}`, `risk.level: critical` with `"Business not found"`
            reason).

            - `in_progress` — Not yet resolved. `risk.level` is `null`, `match`
            is `{}`. Final outcome delivered via
            `business.verification.completed` webhook. Causes include async LLM
            disambiguation, status acquisition from live Secretary-of-State, or
            routing to manual review.

            - `failed` — System error. Safe to retry.

            - `pending` — Created but not yet started (rare; transient).
          enum:
            - pending
            - in_progress
            - completed
            - failed
          example: completed
        mode:
          type: string
          enum:
            - test
            - live
          example: live
          description: >-
            Test/live partition the verification was created under. Determined
            by the API key used.
        risk:
          description: >-
            Business risk assessment. Only meaningful when `status: completed`.
            See `BusinessVerificationRisk.level` for the three response shapes
            (matched / no-match / pending).
          allOf:
            - $ref: '#/components/schemas/BusinessVerificationRisk'
        match:
          description: >-
            Field-level match results against the matched authoritative record.
            Empty object `{}` in two cases: (1) terminal "no match" outcome
            (`status: completed`, `risk.level: critical`) where no record was
            identified; (2) async-pending outcome (`status: in_progress`) where
            verification hasn't resolved yet — wait for the webhook. When
            populated, only includes fields the partner submitted in the
            request.
          allOf:
            - $ref: '#/components/schemas/BusinessVerificationMatch'
        associates:
          description: >-
            Associated people verification results (full KYC results for each
            associate)
          type: array
          items:
            $ref: '#/components/schemas/UserVerificationResponse'
        created_at:
          type: string
          description: ISO 8601 timestamp of when the verification was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the verification was last updated
          format: date-time
          example: '2025-10-24T10:35:00Z'
      required:
        - verification_id
        - business_id
        - status
        - mode
        - risk
        - match
        - created_at
    ValidationProblemDetail:
      type: object
      properties:
        type:
          type: string
          example: https://api.getpalm.com/problems/validation_error
        title:
          type: string
          example: Validation Error
        status:
          type: number
          example: 400
        detail:
          type: string
          example: Request validation failed
        instance:
          type: string
          example: /business/registry/search
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationErrorField'
      required:
        - type
        - title
        - status
        - detail
        - instance
        - errors
    AuthenticationProblemDetail:
      type: object
      properties:
        type:
          type: string
          example: https://api.getpalm.com/problems/authentication_error
        title:
          type: string
          example: Unauthorized
        status:
          type: number
          example: 401
        detail:
          type: string
          example: >-
            No valid authentication provided. Please provide one of the accepted
            authentication methods.
        instance:
          type: string
          example: /business/registry/search
      required:
        - type
        - title
        - status
        - detail
        - instance
    RateLimitProblemDetail:
      type: object
      properties:
        type:
          type: string
          example: https://api.getpalm.com/problems/rate_limit_exceeded
        title:
          type: string
          example: Too Many Requests
        status:
          type: number
          example: 429
        detail:
          type: string
          example: Rate limit exceeded. Please retry after 60 seconds.
        instance:
          type: string
          example: /business/registry/search
        retry_after:
          type: number
          example: 60
        limit:
          type: number
          example: 100000
        remaining:
          type: number
          example: 0
        reset:
          type: number
          example: 1738540800
      required:
        - type
        - title
        - status
        - detail
        - instance
    InternalErrorProblemDetail:
      type: object
      properties:
        type:
          type: string
          example: https://api.getpalm.com/problems/internal_error
        title:
          type: string
          example: Internal Server Error
        status:
          type: number
          example: 500
        detail:
          type: string
          example: >-
            An internal server error occurred. Please contact support if this
            persists.
        instance:
          type: string
          example: /business/registry/search
      required:
        - type
        - title
        - status
        - detail
        - instance
    AssociateRequest:
      type: object
      properties:
        user_id:
          type: string
          description: >-
            Reference to existing user. If provided, identity fields are not
            required as data is pulled from the vault.
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        first_name:
          type: string
          example: Jane
          description: First name. Required when user_id is not provided.
        last_name:
          type: string
          example: Smith
          description: Last name. Required when user_id is not provided.
        middle_name:
          type: string
          example: M
          description: Middle name
        date_of_birth:
          type: string
          example: '1985-05-20'
          format: date
          description: Date of birth (YYYY-MM-DD). Required when user_id is not provided.
        ssn:
          type: string
          example: 987-65-4321
          description: Social Security Number. Required when user_id is not provided.
        email:
          type: string
          example: jane.smith@example.com
          description: Email address
        phone_number:
          type: string
          example: '+15559876543'
          description: Phone number
        address_line_1:
          type: string
          example: 123 Main St
          description: Street address line 1. Required when user_id is not provided.
        address_line_2:
          type: string
          example: Suite 100
          description: Street address line 2
        city:
          type: string
          example: San Francisco
          description: City. Required when user_id is not provided.
        region:
          type: string
          example: CA
          description: >-
            Region (state/province/county). Required when user_id is not
            provided.
        postal_code:
          type: string
          example: '94102'
          description: Postal code. Required when user_id is not provided.
        country:
          type: string
          example: US
          description: Country (2-letter ISO code)
        ownership_percentage:
          type: number
          example: 50
          description: Ownership percentage (0-100)
        title:
          type: string
          example: CEO
          description: Job title
      required:
        - first_name
        - last_name
        - date_of_birth
        - ssn
        - address_line_1
        - city
        - region
        - postal_code
    BusinessVerificationRisk:
      type: object
      properties:
        level:
          type: string
          description: >-
            Overall business risk assessment level. Three meaningful shapes:


            - A `RiskLevel` value (`low` / `medium` / `high` / `critical`) when
            `status: completed` and a record was matched — reflects risk
            evaluation against the matched authoritative record.

            - `critical` when `status: completed` and `match: {}` — terminal "no
            match" verdict. `reasons` will contain a `"Business not found in any
            authoritative source"`-shaped entry.

            - `null` when `status: in_progress` — verification hasn't completed
            and risk has not been evaluated. Treat as unset.


            Always check `status` first; do not act on `level` while `status:
            in_progress`.
          enum:
            - low
            - medium
            - high
            - critical
          nullable: true
          example: low
        reasons:
          description: >-
            Human-readable risk findings. Empty array when no risk signals fired
            (or when `status: in_progress`). For terminal "no match" outcomes,
            contains a single `"Business not found in any authoritative
            source"`-shaped entry.
          example:
            - 'Active UCC lien detected: $500,000 secured by Wells Fargo Bank'
            - 'Tax lien filed in Delaware: $25,000 owed to IRS'
            - Associate Jane Smith failed identity verification
            - EIN issued less than 90 days ago
            - Multiple bankruptcy filings in formation jurisdiction
          type: array
          items:
            type: string
      required:
        - level
        - reasons
    BusinessVerificationMatch:
      type: object
      properties:
        legal_name:
          type: string
          description: Legal name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        ein:
          type: string
          description: EIN match result (includes IRS TIN matching validation)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        entity_type:
          type: string
          description: Entity type match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        registration_jurisdiction:
          type: string
          description: >-
            Registration jurisdiction match result (where business is registered
            to operate)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        formation_jurisdiction:
          type: string
          description: >-
            Formation jurisdiction match result (where business was legally
            formed)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        formation_date:
          type: string
          description: Formation date match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_1:
          type: string
          description: Business address line 1 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_2:
          type: string
          description: Business address line 2 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        city:
          type: string
          description: City/locality match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        region:
          type: string
          description: Region match result (state/province/county)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        postal_code:
          type: string
          description: Postal code match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
    UserVerificationResponse:
      type: object
      properties:
        user_id:
          type: string
          description: ID of the user entity created or verified
          format: uuid
          example: 550e8400-e29b-41d4-a716-446655440000
        verification_id:
          type: string
          description: Unique verification ID
          format: uuid
          example: 660f9511-f30c-52e5-b827-557766551111
        reference_id:
          type: string
          description: Your reference ID (if provided in request)
          example: user_12345
        status:
          type: string
          description: Current status of the verification
          enum:
            - pending
            - in_progress
            - completed
            - failed
          example: completed
        mode:
          type: string
          enum:
            - test
            - live
          example: live
          description: >-
            Test/live partition the verification was created under. Determined
            by the API key used.
        risk:
          description: Risk assessment with level and detailed reasons
          allOf:
            - $ref: '#/components/schemas/UserVerificationRisk'
        match:
          description: >-
            Field-level match results (only fields included in verification
            request)
          allOf:
            - $ref: '#/components/schemas/UserVerificationMatch'
        synthetic:
          description: Synthetic identity detection results
          allOf:
            - $ref: '#/components/schemas/Synthetic'
        velocity:
          description: >-
            Velocity checks showing frequency of identity attributes across
            recent requests
          allOf:
            - $ref: '#/components/schemas/Velocity'
        device:
          description: Device intelligence (available for session-based verifications)
          allOf:
            - $ref: '#/components/schemas/Device'
        watchlist:
          description: Watchlist screening results (sanctions, PEP, adverse media)
          allOf:
            - $ref: '#/components/schemas/Watchlist'
        created_at:
          type: string
          description: ISO 8601 timestamp of when the verification was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the verification was last updated
          format: date-time
          example: '2025-10-24T10:35:00Z'
      required:
        - user_id
        - verification_id
        - status
        - mode
        - risk
        - match
        - created_at
    ValidationErrorField:
      type: object
      properties:
        field:
          type: string
          example: name
          description: Field name that failed validation
        message:
          type: string
          example: name should not be empty
          description: Validation error message
        code:
          type: string
          example: NOT_EMPTY
          description: Error code
      required:
        - field
        - message
    UserVerificationRisk:
      type: object
      properties:
        level:
          type: string
          description: Overall risk assessment level
          enum:
            - low
            - medium
            - high
            - critical
          example: low
        reasons:
          description: Risk reasons and signals detected during verification
          example:
            - SSN first seen recently in bureau data
            - Address mismatch detected
            - High velocity on phone number (5 applications in 24 hours)
            - Device fingerprint associated with known fraud
            - Synthetic identity indicators detected with 85% confidence
          type: array
          items:
            type: string
      required:
        - level
        - reasons
    UserVerificationMatch:
      type: object
      properties:
        first_name:
          type: string
          description: First name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        last_name:
          type: string
          description: Last name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        middle_name:
          type: string
          description: Middle name match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        date_of_birth:
          type: string
          description: Date of birth match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        ssn:
          type: string
          description: SSN match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        email:
          type: string
          description: Email match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        phone_number:
          type: string
          description: Phone number match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_1:
          type: string
          description: Address line 1 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        address_line_2:
          type: string
          description: Address line 2 match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        city:
          type: string
          description: City match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        region:
          type: string
          description: Region match result (state/province/county)
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
        postal_code:
          type: string
          description: Postal code match result
          enum:
            - match
            - partial_match
            - no_match
            - not_checked
    Synthetic:
      type: object
      properties:
        is_synthetic:
          type: boolean
          description: Whether identity is likely synthetic (fabricated)
          example: false
        confidence_score:
          type: number
          description: Confidence score that identity is synthetic (0-100)
          example: 15
        indicators:
          description: Specific synthetic identity indicators detected
          example:
            - SSN issued after applicant date of birth
            - Credit file recently established
          type: array
          items:
            type: string
      required:
        - is_synthetic
    Velocity:
      type: object
      properties:
        email:
          type: number
          description: Number of recent verifications using this email
          example: 1
        phone:
          type: number
          description: Number of recent verifications using this phone
          example: 2
        ssn:
          type: number
          description: Number of recent verifications using this SSN
          example: 1
        address:
          type: number
          description: Number of recent verifications using this address
          example: 3
    Device:
      type: object
      properties:
        risk_score:
          type: number
          description: Device-based risk score (0-100)
          example: 10
        is_emulator:
          type: boolean
          description: Whether device is an emulator
          example: false
        is_vpn:
          type: boolean
          description: Whether connection is through VPN
          example: false
        is_proxy:
          type: boolean
          description: Whether connection is through proxy
          example: false
    Watchlist:
      type: object
      properties:
        status:
          type: string
          description: Overall screening result
          enum:
            - clear
            - potential_match
            - confirmed_match
            - not_screened
          example: clear
        matches:
          description: Specific watchlist hits
          type: array
          items:
            $ref: '#/components/schemas/WatchlistMatch'
      required:
        - status
    WatchlistMatch:
      type: object
      properties:
        type:
          type: string
          description: Category of watchlist match
          example: sanctions
          enum:
            - sanctions
            - pep
            - adverse_media
        name:
          type: string
          description: Specific watchlist that produced the match (e.g., ofac_sdn, tauxbe)
          example: ofac_sdn
        confidence_score:
          type: number
          description: Match confidence score (0-100)
          example: 85
      required:
        - type
        - name
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````