Upload a CSV file for bulk entity lookup

Upload a CSV file containing entity names and states for bulk lookup. The CSV must have columns: entity_name, state. Results are delivered via polling, webhook callback, or email.

post/v1/bulk-lookup/upload

Request

  • Base URL: https://api.opensosdata.com
  • URL: https://api.opensosdata.com/v1/bulk-lookup/upload
  • Auth: API key in header x-api-key

Query parameters

search_by'debtor' | 'secured_party'

Search by debtor (default) or secured party name

max_resultsinteger

Maximum results per entity (1-30)

type'business_entity' | 'ucc'

Type of search to perform

cache_preference'cache_only' | 'cache_first' | 'live_only'

Cache behavior preference

Response

Bulk job queued

job_idstring
statusstring
totalinteger

Number of entities in the batch

poll_urlstring

Example response

{
  "job_id": "bulk_abc123",
  "status": "queued",
  "poll_url": "/v1/bulk-lookup/bulk_abc123"
}

Changes