Opensosdata: Actions/bulk Lookup

Look up the state Secretary of State registration records of up to 1,000 businesses in one job, such as status and officers.

Tool ID: opensosdata_bulk_lookup

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'opensosdata_bulk_lookup',
  {
    "entities": [
      {
        "entity_name": "Example",
        "state": "AL"
      }
    ]
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute opensosdata_bulk_lookup --input '{
  "entities": [
    {
      "entity_name": "Example",
      "state": "AL"
    }
  ]
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "job_id": "job_123",
  "status": "example",
  "total": 123,
  "completed": 123,
  "failed": 123,
  "results": [
    {
      "entity_name": "Example",
      "state": "California",
      "success": true,
      "error": "example"
    }
  ]
}

Use deepline describe opensosdata_bulk_lookup --json for the latest machine-readable contract.

Input reference

Submit up to 1000 Secretary of State lookups in one OpenSOSData job and poll it to completion.

Name	Type	Required	Default	Details
`payload.entities`	`array`	Yes	—	Business entities to look up in one native bulk job. Minimum items: 1. Maximum items: 1000.
`payload.source`	`"auto" \| "cache" \| "live"`	No	—	Data source preference for every entity in the job. Allowed: `auto`, `cache`, `live`.
`payload.cache_preference`	`"cache_only" \| "cache_first" \| "live_only"`	No	—	Allowed: `cache_only`, `cache_first`, `live_only`.
`payload.search_by`	`"debtor" \| "secured_party"`	No	—	Allowed: `debtor`, `secured_party`.
`payload.max_results`	`integer`	No	—	Maximum results returned for each submitted entity. Minimum: 1. Maximum: 30.
`payload.wait_for_completion`	`boolean`	No	`true`	Wait briefly for terminal results. Set false to return the provider job ID immediately for an explicit follow-up read.
`payload.poll_interval_ms`	`integer`	No	`5000`	Minimum: 250. Maximum: 30000.
`payload.max_wait_ms`	`integer`	No	`30000`	Maximum synchronous wait. Jobs still running after this return their provider job_id for an explicit follow-up read. Minimum: 1000. Maximum: 30000.

Output reference

Name	Type	Required	Default	Details
`result.job_id`	`string`	Yes	—	—
`result.status`	`string`	Yes	—	—
`result.total`	`integer`	Yes	—	—
`result.completed`	`integer`	Yes	—	—
`result.failed`	`integer`	Yes	—	—
`result.results`	`array`	Yes	—	—
`result.results[].entity_name`	`string`	Yes	—	—
`result.results[].state`	`string`	Yes	—	—
`result.results[].success`	`boolean`	Yes	—	—
`result.results[].data`	`object`	Yes	—	—
`result.results[].data.entityName`	`string`	Yes	—	—
`result.results[].data.entityType`	`string`	Yes	—	—
`result.results[].data.entityId`	`string`	Yes	—	—
`result.results[].data.status`	`string`	Yes	—	—
`result.results[].data.officers`	`array`	Yes	—	—
`result.results[].error`	`string`	Yes	—	—

Deepline cost

Pricing model: per_result (per result).
Estimated Deepline credits: 0.44 per pricing unit.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation