BizVerify Search API

The Search API from BizVerify — 1 operation(s) for search.

OpenAPI Specification

bizverify-search-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: BizVerify Search API
  description: Business entity verification API. Verify company registrations, search business entities,
    and check good standing across US states and international jurisdictions. Authenticate with an API
    key via the X-API-Key header.
  version: 1.0.0
tags:
- name: Search
paths:
  /v1/search:
    post:
      operationId: searchEntities
      tags:
      - Search
      description: Search for business entities across one or multiple jurisdictions. Returns matching
        entities with confidence scores. Charges 2 credits per jurisdiction searched. Use the jurisdiction
        parameter to search a specific jurisdiction, or omit it to search all active jurisdictions. Supports
        pagination via limit and offset. Search is available in every active jurisdiction regardless of
        verification tier.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                entity_name:
                  type: string
                  minLength: 1
                  maxLength: 500
                  description: The business name to search for, e.g. "Acme"
                jurisdiction:
                  description: Optional jurisdiction code to search. Omit to search all active jurisdictions.
                  type: string
                  minLength: 2
                  maxLength: 10
                entity_type:
                  description: Optional entity type filter to narrow results
                  type: string
                  enum:
                  - llc
                  - corporation
                  - lp
                  - llp
                  - sole_proprietorship
                  - nonprofit
                  - general_partnership
                  - other
                limit:
                  default: 50
                  description: Maximum number of results to return (default 50, max 200)
                  type: integer
                  minimum: 1
                  maximum: 200
                offset:
                  default: 0
                  description: Number of results to skip for pagination
                  type: integer
                  minimum: 0
                  maximum: 9007199254740991
              required:
              - entity_name
      security:
      - apiKey: []
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items: {}
                    description: Array of matching business entities with confidence scores
                  total:
                    type: number
                    description: Total number of matching results across all searched jurisdictions
                  limit:
                    type: number
                    description: The limit that was applied
                  offset:
                    type: number
                    description: The offset that was applied
                  jurisdictions_searched:
                    type: array
                    items:
                      type: string
                    description: List of jurisdiction codes that were searched
                  jurisdictions_failed:
                    type: array
                    items:
                      type: string
                    description: Subset of jurisdictions_searched that could not be completed (credits
                      refunded for these)
                  credits_charged:
                    type: number
                    description: Net credits deducted after partial refunds for failed jurisdictions
                required:
                - results
                - total
                - limit
                - offset
                - jurisdictions_searched
                - jurisdictions_failed
                - credits_charged
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                      details: {}
                      suggestion:
                        type: string
                    required:
                    - code
                    - message
                    additionalProperties: false
                required:
                - error
                additionalProperties: false
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: X-API-Key
      in: header
      description: API key authentication. Obtain a key via POST /v1/auth/request-access and POST /v1/auth/verify-access.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth 2.1 Bearer token. Obtain via the /oauth/authorize flow.