Skip to main content
POST
/
v1
/
business
/
search
Search businesses
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: 'Acme Corp',
    ein: '12-3456789',
    vault: {
      'business.legal_name': 'Acme',
      'business.entity_type': 'llc',
      'business.registration_jurisdiction': 'US-CA'
    },
    metadata: {industry: 'technology'},
    cursor: '<string>',
    limit: 25,
    sort: 'created_at',
    order: 'desc'
  })
};

fetch('https://api.getpalm.com/v1/business/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "object": "list",
  "has_more": true,
  "next_cursor": "crs_7g8h9i0j1k2l3m4n",
  "data": [
    "<array>"
  ]
}

Authorizations

​
Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Body

application/json
​
display_name
string

Filter by display name (partial match, case-insensitive)

Example:

"Acme Corp"

​
ein
string

Filter by EIN (exact match). Value is hashed for secure lookup.

Example:

"12-3456789"

​
vault
object

Filter by vault fields using prefixed field names. Supports: business.legal_name (partial), business.entity_type, business.formation_jurisdiction, business.registration_jurisdiction, business.formation_date, business.city (partial), business.region, business.postal_code, business.country.

Example:
{
  "business.legal_name": "Acme",
  "business.entity_type": "llc",
  "business.registration_jurisdiction": "US-CA"
}
​
metadata
object

Filter by metadata fields. Use dot notation for nested keys. Example: { "industry": "technology", "settings.notify": "true" }

Example:
{ "industry": "technology" }
​
cursor
string

Pagination cursor from previous response

​
limit
number
default:25

Maximum number of results to return (1-100)

​
sort
enum<string>
default:created_at

Field to sort by

Available options:
created_at,
name,
jurisdiction,
entity_type,
risk_level,
last_verified
​
order
enum<string>
default:desc

Sort order direction

Available options:
asc,
desc

Response

200 - application/json

Search results

​
object
enum<string>
required

Object type identifier, always "list"

Available options:
list
Example:

"list"

​
has_more
boolean
required

Whether there are more results available

Example:

true

​
next_cursor
object
required

Cursor to use for fetching the next page of results. Only present when has_more is true.

Example:

"crs_7g8h9i0j1k2l3m4n"

​
data
array[]
required

Array of resources for the current page