BizVerify Meta API

openapi: 3.2.0
info:
  title: BizVerify Meta 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: Meta
paths:
  /health:
    get:
      operationId: healthCheck
      tags:
      - Meta
      description: Health check endpoint. Returns 200 if the API, database, and Redis are all operational.
        Returns 503 if any component is degraded. No authentication required.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    description: Overall system status
                  checks:
                    type: object
                    additionalProperties:
                      type: string
                    description: Individual component checks (database, redis) with status "ok" or "error"
                  timestamp:
                    type: string
                    description: ISO 8601 timestamp of the health check
                required:
                - status
                - checks
                - timestamp
                additionalProperties: false
        '503':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - healthy
                    - degraded
                    description: Overall system status
                  checks:
                    type: object
                    additionalProperties:
                      type: string
                    description: Individual component checks (database, redis) with status "ok" or "error"
                  timestamp:
                    type: string
                    description: ISO 8601 timestamp of the health check
                required:
                - status
                - checks
                - timestamp
                additionalProperties: false
  /v1/jurisdictions:
    get:
      operationId: listJurisdictions
      tags:
      - Meta
      description: List all registered jurisdictions and their verification capabilities (quick, deep,
        search, entity lookup). No authentication required. For active jurisdictions only, use GET /v1/config.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  jurisdictions:
                    type: array
                    items: {}
                required:
                - jurisdictions
                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.