> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Enformion Business Search: Inputs, Cost & CLI Example
> Step 1 of the personal-email flow: look up a business by name (+ city/state) to get its officers and registered agents, each with a tahoeId.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=enformion_business_search:{"name":"{{name}}"}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------- | -------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.name` | `string` | Yes | | Business / entity name (e.g. 'Castaways River Tiki Bar'). |
| `payload.city_state` | `string` | No | | Locality hint: "City, Region" (e.g. "Cutchogue, NY"), or a city alone, or a region alone. BusinessV2 filters on a single locality token and cannot parse the combined form, so Deepline splits the hint and tries region, then city, then an unfiltered search, keeping only records in the requested region. Narrows the business match. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Enformion Business Search (galaxy-search-type: BusinessV2). Step 1 of the personal-email flow: returns the business plus its officers and registered agents, each with a tahoeId. Feed those tahoeIds into enformion_person_search to get each officer's personal contact info. NOTE: Business Search is separately entitled; profiles without it get isError:true (\"Access Profile does not permit client to call Business Search\") — treat as no-result and fall back to person-search-by-name.",
"properties": {
"name": {
"type": "string",
"description": "Business / entity name (e.g. 'Castaways River Tiki Bar').",
"minLength": 1
},
"city_state": {
"type": "string",
"description": "Locality hint: \"City, Region\" (e.g. \"Cutchogue, NY\"), or a city alone, or a region alone. BusinessV2 filters on a single locality token and cannot parse the combined form, so Deepline splits the hint and tries region, then city, then an unfiltered search, keeping only records in the requested region. Narrows the business match."
}
},
"required": [
"name"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ---------------------------- | --------- | -------- | ------- | ----------- |
| `result.businessV2Records` | `array` | Yes | | |
| `result.responseRecordCount` | `integer` | Yes | | |
| `result.isError` | `boolean` | Yes | | |
| `result.requestId` | `string` | Yes | | |
| `result.requestType` | `string` | Yes | | |
| `result.requestTime` | `string` | Yes | | |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"properties": {
"businessV2Records": {
"type": "array",
"items": {
"type": "object",
"properties": {
"poseidonId": {
"type": "integer"
},
"uccFilings": {
"type": "array",
"items": {}
},
"newBusinessFilings": {
"type": "array",
"items": {}
},
"usCorpFilings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"poseidonId": {
"type": "integer"
},
"ein": {
"type": "string"
},
"name": {
"type": "string"
},
"rawName": {
"type": "string"
},
"corpFileKey": {
"type": "string"
},
"corpStatus": {
"type": "string"
},
"corpStatusDate": {
"type": "string"
},
"corpType": {
"type": "string"
},
"registryNumber": {
"type": "string"
},
"stateCode": {
"type": "string"
},
"statute": {
"type": "string"
},
"stateTaxId": {
"type": "string"
},
"term": {
"type": "string"
},
"fileData": {
"type": "null"
},
"fileDataDate": {
"type": "string"
},
"filingDate": {
"type": "string"
},
"incorporationState": {
"type": "string"
},
"filingType": {
"type": "string"
},
"jurisdiction": {
"type": "string"
},
"lastReportedDate": {
"type": "string"
},
"expireDate": {
"type": "string"
},
"contacts": {
"type": "array",
"items": {}
},
"officers": {
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"fileDate": {
"type": "null"
},
"name": {
"type": "object",
"properties": {
"nameSuffix": {
"type": "string"
},
"nameHashReq1": {
"type": "string"
},
"nameFirst": {
"type": "string"
},
"nameGender": {
"type": "string"
},
"nameLast": {
"type": "string"
},
"nameMiddle": {
"type": "string"
},
"nameRaw": {
"type": "string"
},
"nameProblemCodes": {
"type": "string"
},
"nameHashOpt5": {
"type": "integer"
},
"namePrefix": {
"type": "string"
},
"nameHashOpt4": {
"type": "integer"
},
"nameSuffixNorm": {
"type": "string"
},
"tahoeId": {
"type": "null"
}
},
"required": [
"nameSuffix",
"nameHashReq1",
"nameFirst",
"nameGender",
"nameLast",
"nameMiddle",
"nameRaw",
"nameProblemCodes",
"nameHashOpt5",
"namePrefix",
"nameHashOpt4",
"nameSuffixNorm",
"tahoeId"
],
"additionalProperties": true
},
"title": {
"type": "string"
},
"startDate": {
"type": "string"
},
"status": {
"type": "null"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"county": {
"type": "string"
},
"country": {
"type": "string"
},
"addressHash": {
"type": "string"
},
"houseNumber": {
"type": "string"
},
"streetName": {
"type": "string"
},
"streetPostDirection": {
"type": "string"
},
"streetPreDirection": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitType": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"fullAddress": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"county",
"country",
"addressHash",
"houseNumber",
"streetName",
"streetPostDirection",
"streetPreDirection",
"unit",
"unitType",
"addressLine1",
"addressLine2",
"fullAddress"
],
"additionalProperties": true
},
"mailingAddress": {
"type": "null"
},
"fax": {
"type": "null"
},
"email": {
"type": "null"
}
},
"required": [
"fileDate",
"name",
"title",
"startDate",
"status",
"address",
"mailingAddress",
"fax",
"email"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"fileDate": {
"type": "null"
},
"name": {
"type": "object",
"properties": {
"nameSuffix": {
"type": "string"
},
"nameHashReq1": {
"type": "string"
},
"nameFirst": {
"type": "string"
},
"nameGender": {
"type": "string"
},
"nameLast": {
"type": "string"
},
"nameMiddle": {
"type": "string"
},
"nameRaw": {
"type": "string"
},
"nameProblemCodes": {
"type": "string"
},
"nameHashOpt5": {
"type": "integer"
},
"namePrefix": {
"type": "string"
},
"nameHashOpt4": {
"type": "integer"
},
"nameSuffixNorm": {
"type": "string"
},
"tahoeId": {
"type": "string"
}
},
"required": [
"nameSuffix",
"nameHashReq1",
"nameFirst",
"nameGender",
"nameLast",
"nameMiddle",
"nameRaw",
"nameProblemCodes",
"nameHashOpt5",
"namePrefix",
"nameHashOpt4",
"nameSuffixNorm",
"tahoeId"
],
"additionalProperties": true
},
"title": {
"type": "string"
},
"startDate": {
"type": "string"
},
"status": {
"type": "null"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"county": {
"type": "string"
},
"country": {
"type": "string"
},
"addressHash": {
"type": "string"
},
"houseNumber": {
"type": "string"
},
"streetName": {
"type": "string"
},
"streetPostDirection": {
"type": "string"
},
"streetPreDirection": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitType": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"fullAddress": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"county",
"country",
"addressHash",
"houseNumber",
"streetName",
"streetPostDirection",
"streetPreDirection",
"unit",
"unitType",
"addressLine1",
"addressLine2",
"fullAddress"
],
"additionalProperties": true
},
"mailingAddress": {
"type": "null"
},
"fax": {
"type": "null"
},
"email": {
"type": "null"
}
},
"required": [
"fileDate",
"name",
"title",
"startDate",
"status",
"address",
"mailingAddress",
"fax",
"email"
],
"additionalProperties": true
},
{
"type": "object",
"properties": {
"fileDate": {
"type": "null"
},
"name": {
"type": "object",
"properties": {
"nameSuffix": {
"type": "string"
},
"nameHashReq1": {
"type": "string"
},
"nameFirst": {
"type": "string"
},
"nameGender": {
"type": "string"
},
"nameLast": {
"type": "string"
},
"nameMiddle": {
"type": "string"
},
"nameRaw": {
"type": "string"
},
"nameProblemCodes": {
"type": "string"
},
"nameHashOpt5": {
"type": "integer"
},
"namePrefix": {
"type": "string"
},
"nameHashOpt4": {
"type": "integer"
},
"nameSuffixNorm": {
"type": "string"
},
"tahoeId": {
"type": "null"
}
},
"required": [
"nameSuffix",
"nameHashReq1",
"nameFirst",
"nameGender",
"nameLast",
"nameMiddle",
"nameRaw",
"nameProblemCodes",
"nameHashOpt5",
"namePrefix",
"nameHashOpt4",
"nameSuffixNorm",
"tahoeId"
],
"additionalProperties": true
},
"title": {
"type": "string"
},
"startDate": {
"type": "string"
},
"status": {
"type": "null"
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"county": {
"type": "string"
},
"country": {
"type": "string"
},
"addressHash": {
"type": "string"
},
"houseNumber": {
"type": "string"
},
"streetName": {
"type": "string"
},
"streetPostDirection": {
"type": "string"
},
"streetPreDirection": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitType": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"fullAddress": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"county",
"country",
"addressHash",
"houseNumber",
"streetName",
"streetPostDirection",
"streetPreDirection",
"unit",
"unitType",
"addressLine1",
"addressLine2",
"fullAddress"
],
"additionalProperties": true
},
"mailingAddress": {
"type": "null"
},
"fax": {
"type": "null"
},
"email": {
"type": "null"
}
},
"required": [
"fileDate",
"name",
"title",
"startDate",
"status",
"address",
"mailingAddress",
"fax",
"email"
],
"additionalProperties": true
}
]
}
},
"phones": {
"type": "null"
},
"emails": {
"type": "array",
"items": {}
},
"stock": {
"type": "object",
"properties": {
"stateCode": {
"type": "string"
},
"stockClass": {
"type": "string"
},
"stockDate": {
"type": "string"
},
"stockParValue": {
"type": "string"
},
"stockRestrictInd": {
"type": "string"
},
"stockSharesAuth": {
"type": "string"
}
},
"required": [
"stateCode",
"stockClass",
"stockDate",
"stockParValue",
"stockRestrictInd",
"stockSharesAuth"
],
"additionalProperties": true
},
"merger": {
"type": "object",
"properties": {
"eventDescription": {
"type": "string"
},
"mergeDate": {
"type": "string"
},
"mergedCorpId": {
"type": "string"
},
"mergedCorpName": {
"type": "string"
},
"stateCode": {
"type": "string"
},
"survivingCorpId": {
"type": "string"
}
},
"required": [
"eventDescription",
"mergeDate",
"mergedCorpId",
"mergedCorpName",
"stateCode",
"survivingCorpId"
],
"additionalProperties": true
},
"history": {
"type": "object",
"properties": {
"amendmentDate": {
"type": "string"
},
"amendmentType": {
"type": "string"
},
"corpFileKey": {
"type": "string"
},
"historyEvent": {
"type": "string"
},
"stateCode": {
"type": "string"
}
},
"required": [
"amendmentDate",
"amendmentType",
"corpFileKey",
"historyEvent",
"stateCode"
],
"additionalProperties": true
},
"alternateName": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"amendmentDate": {
"type": "string"
},
"certificationDate": {
"type": "string"
},
"consentName": {
"type": "string"
},
"corpFileKey": {
"type": "string"
},
"expireDate": {
"type": "string"
},
"filingDate": {
"type": "string"
},
"nameType": {
"type": "string"
},
"purpose": {
"type": "string"
},
"registryNumber": {
"type": "string"
},
"renewalDate": {
"type": "string"
},
"similarAltName": {
"type": "string"
},
"stateCode": {
"type": "string"
},
"stateOfOrigin": {
"type": "string"
},
"status": {
"type": "string"
},
"statusDate": {
"type": "string"
},
"xRef1Name": {
"type": "string"
},
"xRef2Name": {
"type": "string"
}
},
"required": [
"name",
"amendmentDate",
"certificationDate",
"consentName",
"corpFileKey",
"expireDate",
"filingDate",
"nameType",
"purpose",
"registryNumber",
"renewalDate",
"similarAltName",
"stateCode",
"stateOfOrigin",
"status",
"statusDate",
"xRef1Name",
"xRef2Name"
],
"additionalProperties": true
},
"corpMainAddresses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"zip": {
"type": "string"
},
"county": {
"type": "string"
},
"country": {
"type": "string"
},
"addressHash": {
"type": "string"
},
"houseNumber": {
"type": "string"
},
"streetName": {
"type": "string"
},
"streetPostDirection": {
"type": "string"
},
"streetPreDirection": {
"type": "string"
},
"unit": {
"type": "string"
},
"unitType": {
"type": "string"
},
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"fullAddress": {
"type": "string"
}
},
"required": [
"city",
"state",
"zip",
"county",
"country",
"addressHash",
"houseNumber",
"streetName",
"streetPostDirection",
"streetPreDirection",
"unit",
"unitType",
"addressLine1",
"addressLine2",
"fullAddress"
],
"additionalProperties": true
}
}
},
"required": [
"poseidonId",
"ein",
"name",
"rawName",
"corpFileKey",
"corpStatus",
"corpStatusDate",
"corpType",
"registryNumber",
"stateCode",
"statute",
"stateTaxId",
"term",
"fileData",
"fileDataDate",
"filingDate",
"incorporationState",
"filingType",
"jurisdiction",
"lastReportedDate",
"expireDate",
"contacts",
"officers",
"phones",
"emails",
"stock",
"merger",
"history",
"alternateName",
"corpMainAddresses"
],
"additionalProperties": true
}
}
},
"required": [
"poseidonId",
"uccFilings",
"newBusinessFilings",
"usCorpFilings"
],
"additionalProperties": true
}
},
"responseRecordCount": {
"type": "integer"
},
"isError": {
"type": "boolean"
},
"requestId": {
"type": "string"
},
"requestType": {
"type": "string"
},
"requestTime": {
"type": "string"
}
},
"required": [
"businessV2Records",
"responseRecordCount",
"isError",
"requestId",
"requestType",
"requestTime"
],
"additionalProperties": true
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute enformion_business_search --payload '{
"name": "string"
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `per_result` (per result).
* Estimated Deepline credits: `4.9` per pricing unit.
* Billing mode: `post_deduct`.