Monitor business

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_types: ['business.registration.updated', 'business.filing.due'],
    metadata: {customer_tier: 'premium', monitoring_level: 'enhanced'},
    palm_id: '4604-3477-1850',
    registration_jurisdiction: 'US-DE',
    registration_number: '7286832'
  })
};

fetch('https://api.getpalm.com/v1/business/subscription', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/business/subscription"

payload = {
    "event_types": ["business.registration.updated", "business.filing.due"],
    "metadata": {
        "customer_tier": "premium",
        "monitoring_level": "enhanced"
    },
    "palm_id": "4604-3477-1850",
    "registration_jurisdiction": "US-DE",
    "registration_number": "7286832"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/business/subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "palm_id": "4604-3477-1850",
  "registration_jurisdiction": "US-DE",
  "registration_number": "7286832"
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "subscription",
  "resource_type": "business",
  "resource_id": "987e6543-e21a-45b6-c789-012345678901",
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "status": "active",
  "mode": "live",
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "expires_at": "2026-10-24T10:30:00Z",
  "business": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "object": "business",
    "mode": "live",
    "created_at": "2025-10-24T10:30:00Z",
    "updated_at": "2025-10-24T15:45:00Z",
    "metadata": {
      "external_id": "user_123_in_my_system",
      "customer_tier": "premium",
      "signup_source": "mobile_app"
    },
    "palm_id": "1234-5678-9012",
    "status": "active",
    "display_name": "Acme Corp",
    "ein_fingerprint": "c9f6ef5h141i49398hkm345621iii90jh3el0007",
    "verification": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "risk_level": "low",
      "workflow": {
        "name": "Business Verification",
        "version": 1
      },
      "executed_at": "2024-01-15T10:30:00.000Z"
    },
    "vault": {
      "business.legal_name": "Acme Corporation Inc.",
      "business.entity_type": "llc",
      "business.formation_jurisdiction": "US-DE",
      "business.formation_date": "2020-03-15",
      "business.address_line_1": "123 Main St",
      "business.city": "San Francisco",
      "business.region": "CA",
      "business.postal_code": "94105",
      "business.country": "US"
    }
  }
}

POST

business

subscription

Monitor business

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_types: ['business.registration.updated', 'business.filing.due'],
    metadata: {customer_tier: 'premium', monitoring_level: 'enhanced'},
    palm_id: '4604-3477-1850',
    registration_jurisdiction: 'US-DE',
    registration_number: '7286832'
  })
};

fetch('https://api.getpalm.com/v1/business/subscription', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.getpalm.com/v1/business/subscription"

payload = {
    "event_types": ["business.registration.updated", "business.filing.due"],
    "metadata": {
        "customer_tier": "premium",
        "monitoring_level": "enhanced"
    },
    "palm_id": "4604-3477-1850",
    "registration_jurisdiction": "US-DE",
    "registration_number": "7286832"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

curl --request POST \
  --url https://api.getpalm.com/v1/business/subscription \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "palm_id": "4604-3477-1850",
  "registration_jurisdiction": "US-DE",
  "registration_number": "7286832"
}
'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "object": "subscription",
  "resource_type": "business",
  "resource_id": "987e6543-e21a-45b6-c789-012345678901",
  "event_types": [
    "business.registration.updated",
    "business.filing.due"
  ],
  "status": "active",
  "mode": "live",
  "metadata": {
    "customer_tier": "premium",
    "monitoring_level": "enhanced"
  },
  "created_at": "2025-10-24T10:30:00Z",
  "updated_at": "2025-10-24T15:45:00Z",
  "expires_at": "2026-10-24T10:30:00Z",
  "business": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "object": "business",
    "mode": "live",
    "created_at": "2025-10-24T10:30:00Z",
    "updated_at": "2025-10-24T15:45:00Z",
    "metadata": {
      "external_id": "user_123_in_my_system",
      "customer_tier": "premium",
      "signup_source": "mobile_app"
    },
    "palm_id": "1234-5678-9012",
    "status": "active",
    "display_name": "Acme Corp",
    "ein_fingerprint": "c9f6ef5h141i49398hkm345621iii90jh3el0007",
    "verification": {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "risk_level": "low",
      "workflow": {
        "name": "Business Verification",
        "version": 1
      },
      "executed_at": "2024-01-15T10:30:00.000Z"
    },
    "vault": {
      "business.legal_name": "Acme Corporation Inc.",
      "business.entity_type": "llc",
      "business.formation_jurisdiction": "US-DE",
      "business.formation_date": "2020-03-15",
      "business.address_line_1": "123 Main St",
      "business.city": "San Francisco",
      "business.region": "CA",
      "business.postal_code": "94105",
      "business.country": "US"
    }
  }
}

Authorizations

Authorization

string

header

required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Body

application/json

event_types

enum<string>[]

required

List of webhook event types to subscribe to for monitoring notifications

Minimum array length: 1

Available options:

business.registration.updated,

business.filing.due,

business.filing.overdue

Example:

[
  "business.registration.updated",
  "business.filing.due"
]

metadata

object

Custom metadata for the subscription

Example:

{
  "customer_tier": "premium",
  "monitoring_level": "enhanced"
}

palm_id

string

Palm ID of the registry business to monitor. Provide either this or registration_jurisdiction with registration_number.

Example:

"4604-3477-1850"

registration_jurisdiction

string

Registration jurisdiction in ISO 3166-2 format (e.g., US-CA, US-NY, US-TX)

Example:

"US-DE"

registration_number

string

The entity's registration number in that jurisdiction

Example:

"7286832"

Response

Subscription created; the monitored portfolio business is embedded

string<uuid>

required

Unique identifier for the subscription

Example:

"123e4567-e89b-12d3-a456-426614174000"

object

enum<string>

required

Object type identifier

Available options:

subscription

Example:

"subscription"

resource_type

enum<string>

required

Type of resource being monitored

Available options:

user,

business

Example:

"business"

resource_id

string<uuid>

required

ID of the user or business being monitored

Example:

"987e6543-e21a-45b6-c789-012345678901"

event_types

enum<string>[]

required

List of webhook event types subscribed to for monitoring notifications

Available options:

business.registration.updated,

business.filing.due,

business.filing.overdue

Example:

[
  "business.registration.updated",
  "business.filing.due"
]

status

enum<string>

required

Current status of the subscription

Available options:

active,

paused,

expired,

canceled

Example:

"active"

mode

enum<string>

required

Whether the subscription belongs to test or live mode, determined by the API key used to create it

Available options:

test,

live

Example:

"live"

metadata

object

required

Custom metadata for the subscription

Example:

{
  "customer_tier": "premium",
  "monitoring_level": "enhanced"
}

created_at

string<date-time>

required

ISO 8601 timestamp when the subscription was created

Example:

"2025-10-24T10:30:00Z"

updated_at

string<date-time>

required

ISO 8601 timestamp when the subscription was last updated

Example:

"2025-10-24T15:45:00Z"

expires_at

string<date-time> | null

required

ISO 8601 timestamp when the subscription expires (for paid subscriptions)

Example:

"2026-10-24T10:30:00Z"

business

object

required

The portfolio business monitored by this subscription, created from the registry record or reused

Show child attributes

Palm Introduction

API Introduction

Endpoints

Monitor business

Authorizations

Body

Response