/
/OpenSOSData API
ChangesDocsSign in
  • Docs
  • History
  • Schema
Search1
  • post/v1/lookupLook up a business entity or UCC filing by name and state
  • get/v1/lookup/status/{jobId}Poll async lookup job status
  • get/v1/account/balanceCheck account balance and remaining lookups
  • get/v1/statesList all 50 states with their scraper status
  • get/v1/healthService health check
  • post/v1/bulk-lookupSubmit a bulk entity lookup job
  • post/v1/bulk-lookup/uploadUpload a CSV file for bulk entity lookup
  • get/v1/bulk-lookup/{jobId}Poll bulk lookup job status and results
  • patch/user/billing/settingsUpdate cached data freshness settings
  • get/v1/historyPaginated lookup history for the authenticated user

Service health check

get/v1/health

Request

  • Base URL: https://api.opensosdata.com
  • URL: https://api.opensosdata.com/v1/health
  • Auth: none required

Response

Health status

status'healthy' | 'degraded'
timestampstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.