# Palm API

## Docs

- [Introduction](https://docs.getpalm.com/api-reference/introduction.md): Get started with the Palm API
- [Add a business](https://docs.getpalm.com/api-reference/v1/business/add-a-business.md): Add one of your businesses, customers or applicants to Palm. This is a common first step when integrating with Palm. Provide optional display name, metadata, and vault data. Vault fields use the `business.*` key format (e.g., `business.legal_name`, `business.ein`). If you plan to file an EIN applica…
- [Retrieve a business](https://docs.getpalm.com/api-reference/v1/business/retrieve-a-business.md): Retrieves a business by ID. Returns the business record with status, display name, and metadata. To access business details like EIN or address, use the vault endpoints.
- [Search businesses](https://docs.getpalm.com/api-reference/v1/business/search-businesses.md): Search for businesses in your organization with optional filters. Filter by legal_name (partial match), entity_type (exact match), or EIN (exact match). Returns paginated results using cursor-based pagination.
- [Update a business](https://docs.getpalm.com/api-reference/v1/business/update-a-business.md): Updates a business's display name or metadata. Metadata updates are merged with existing values; set a key to null to remove it.
- [Verify existing business](https://docs.getpalm.com/api-reference/v1/business/verify-existing-business.md)
- [Get business monitoring subscription status](https://docs.getpalm.com/api-reference/v1/monitor/get-business-monitoring-subscription-status.md): Retrieve the current monitoring subscription status and configuration for a business.
- [Subscribe to business monitoring events](https://docs.getpalm.com/api-reference/v1/monitor/subscribe-to-business-monitoring-events.md): Subscribe to monitoring events for a business to receive real-time notifications about watchlist hits, registration updates, ownership changes, and other compliance events.
- [Unsubscribe from business monitoring](https://docs.getpalm.com/api-reference/v1/monitor/unsubscribe-from-business-monitoring.md): Permanently cancel monitoring subscription for a business.
- [Update business monitoring event types](https://docs.getpalm.com/api-reference/v1/monitor/update-business-monitoring-event-types.md): Update the event types being monitored for a business subscription.
- [Get business from registry](https://docs.getpalm.com/api-reference/v1/registry/get-business-from-registry.md): Retrieve detailed business information from the registry by jurisdiction and registration number. Returns full business details including associates and standing information.
- [Search business registries](https://docs.getpalm.com/api-reference/v1/registry/search-business-registries.md): Search business registries (Secretary of State filings) for business information. Returns formation details, registration status, and officer information.
- [Create a new user](https://docs.getpalm.com/api-reference/v1/user/create-a-new-user.md): Creates a new user record with optional display name, metadata, and vault data. Vault fields use the `identity.*` key format (e.g., `identity.first_name`, `identity.email`).
- [Delete a user](https://docs.getpalm.com/api-reference/v1/user/delete-a-user.md): Deletes a user and their associated data. This performs a soft delete by default, setting the user status to deleted.
- [List businesses for a user](https://docs.getpalm.com/api-reference/v1/user/list-businesses-for-a-user.md): Returns all businesses where this user is listed as a beneficial owner.
- [Retrieve a user](https://docs.getpalm.com/api-reference/v1/user/retrieve-a-user.md): Retrieves a user by ID. Returns the user record with status, display name, and metadata. To access PII, use the vault endpoints.
- [Search users](https://docs.getpalm.com/api-reference/v1/user/search-users.md): Search for users in your organization with optional filters. Filter by display_name (partial match), or by email, phone, or SSN (exact match). Returns paginated results using cursor-based pagination.
- [Update a user](https://docs.getpalm.com/api-reference/v1/user/update-a-user.md): Updates a user's display name or metadata. Metadata updates are merged with existing values; set a key to null to remove it.
- [Verify existing user](https://docs.getpalm.com/api-reference/v1/user/verify-existing-user.md)
- [Verify business](https://docs.getpalm.com/api-reference/v1/verification/verify-business.md): Executes a configurable business verification workflow which utilizes authoritative sources (Secretary of State, IRS TIN matching, business registries), optionally verifies associated people, and returns risk assessment with field-level match results. The required fields are determined by the select…
- [Verify TIN](https://docs.getpalm.com/api-reference/v1/verification/verify-tin.md): Verifies a Tax Identification Number (EIN or SSN) and associated name against IRS records. Unlike `POST /business/verification`, this runs only the IRS TIN Matching check and does not perform registry lookup or risk assessment. When the IRS service is unavailable, returns `matched: null` with `statu…
- [Verify user identity](https://docs.getpalm.com/api-reference/v1/verification/verify-user-identity.md): Executes a configurable user verification workflow which utilizes authoritative sources, and returns risk assessment with field-level match results.
- [Changelog](https://docs.getpalm.com/changelog.md): Latest updates and improvements to the Palm API
- [Comply overview](https://docs.getpalm.com/comply/overview.md): Act on behalf of businesses — formation, filings, Registered Agent services, and reinstatement through the same API you use to verify and monitor.
- [Webhooks overview](https://docs.getpalm.com/developer-guide/webhooks.md): Receive real-time notifications when events occur across Verify, Monitor, and Comply.
- [Authentication](https://docs.getpalm.com/get-started/authentication.md): How to authenticate requests to the Palm API.
- [Get access](https://docs.getpalm.com/get-started/get-access.md): Request API keys and start building with Palm.
- [How Palm works](https://docs.getpalm.com/get-started/how-palm-works.md): How Palm thinks about business identity.
- [Meet Palm](https://docs.getpalm.com/get-started/meet-palm.md): The business identity network built on accuracy.
- [Palm Console](https://docs.getpalm.com/get-started/palm-console.md): Palm Console is where you manage your integration.
- [Palm API Documentation](https://docs.getpalm.com/introduction.md): Learn how to get started with the Palm Platform
- [Monitor a business](https://docs.getpalm.com/monitor/overview.md): Track changes to verified businesses in real time.
- [Onboard overview](https://docs.getpalm.com/onboard/overview.md): Find and onboard businesses into your platform.
- [Search the Registry](https://docs.getpalm.com/onboard/registry-search.md): Search all US registered businesses in the network by name, jurisdiction, or location.
- [Verify overview](https://docs.getpalm.com/verify/overview.md): Verify businesses and people against authoritative sources. KYB, KYC, risk assessment, and ongoing re-verification.
- [Verification reference](https://docs.getpalm.com/verify/verification-reference.md): Risk levels, risk signals, match results, and verification lifecycle details.
- [Verify a business](https://docs.getpalm.com/verify/verify-a-business.md): Confirm that a business entity is real, registered, and in good standing.
- [Verify a person](https://docs.getpalm.com/verify/verify-a-person.md): Verify a person's identity with KYC checks, synthetic identity detection, and watchlist screening.
- [Verify a tin](https://docs.getpalm.com/verify/verify-a-tin.md): Validate a Tax Identification Number against IRS records -- standalone, without a full business or person verification.

## Optional

- [Console](https://platform.getpalm.com)
- [Talk to Palm](https://cal.com/team/getpalm/palm-apis)