# Palm API

- [Palm Documentation](https://docs.getpalm.com/introduction.md): Learn how to get started with the Palm Platform
- [Meet Palm](https://docs.getpalm.com/get-started/meet-palm.md): The business identity network built on accuracy.
- [How Palm works](https://docs.getpalm.com/get-started/how-palm-works.md): How Palm thinks about business identity.
- [Get access](https://docs.getpalm.com/get-started/get-access.md): Create a Palm account, generate API keys, and start building with Palm.
- [Authentication](https://docs.getpalm.com/get-started/authentication.md): How to authenticate requests to the Palm API.
- [Test mode](https://docs.getpalm.com/get-started/test-mode.md): Build and validate your entire integration in an isolated sandbox — no cost, no real filings, and the same responses and webhooks you get in production.
- [Palm Console](https://docs.getpalm.com/get-started/palm-console.md): Palm Console is where you manage your integration.
- [MCP server](https://docs.getpalm.com/get-started/mcp-server.md): Connect an AI assistant to Palm over the Model Context Protocol.
- [Onboard overview](https://docs.getpalm.com/onboard/overview.md): Find any registered US business and pull its record in real time from the primary source, so your customer does not have to type it.
- [Registry search](https://docs.getpalm.com/onboard/registry-search.md): Find any registered US business by name, jurisdiction, or location, read in real time from the primary source.
- [Registry detail](https://docs.getpalm.com/onboard/registry-detail.md): Pull everything Palm holds on a business: prefill your application from it, and screen on standing before you verify.
- [Check name eligibility](https://docs.getpalm.com/onboard/name-eligibility.md): Check whether a prospective business name can be registered in a US jurisdiction — naming-rule compliance and registry availability — before you file a formation.
- [Verify overview](https://docs.getpalm.com/verify/overview.md): Verify businesses and people against authoritative sources. KYB, KYC, risk assessment, and ongoing re-verification.
- [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): Run KYC identity verification with name, DOB, SSN, and address checks, synthetic identity detection, velocity signals, and sanctions 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.
- [Verification reference](https://docs.getpalm.com/verify/verification-reference.md): Risk levels, risk signals, match results, and verification lifecycle details.
- [Monitor a business](https://docs.getpalm.com/monitor/overview.md): Track changes to businesses in real time.
- [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.
- [Form a business](https://docs.getpalm.com/comply/form-a-business.md): Register a new LLC or Corporation with any US state — Palm handles the filing end to end.
- [Apply for an EIN](https://docs.getpalm.com/comply/apply-for-an-ein.md): Get an Employer Identification Number from the IRS for any business — formed through Palm or not.
- [Registered agent](https://docs.getpalm.com/comply/registered-agent.md): Provide registered agent service to your customers' businesses through Palm — at formation or after — and forward state mail through the same API.
- [Cases](https://docs.getpalm.com/comply/cases.md): Respond to information requests Palm raises on a filing, and exchange the documents that go with them.
- [Webhooks overview](https://docs.getpalm.com/developer-guide/webhooks.md): Receive real-time notifications when events occur across Verify, Monitor, and Comply.
- [Webhook example payloads](https://docs.getpalm.com/developer-guide/webhook-example-payloads.md): A complete, realistic example payload for every Palm webhook event type.
- [Palm Documentation](https://docs.getpalm.com/introduction.md): Learn how to get started with the Palm Platform
- [Introduction](https://docs.getpalm.com/api-reference/introduction.md): Base URL and versioning for the Palm API.
- [Search business registries](https://docs.getpalm.com/api-reference/v1/registry/search-business-registries.md): Search business registries to find registered businesses before verifying them. Records are drawn from authoritative sources — state registries, the IRS, and licensing agencies. Returns each match with its Palm ID, registration details (legal name, entity type, registration number, formation date, j…
- [Get business from registry](https://docs.getpalm.com/api-reference/v1/registry/get-business-from-registry.md): Retrieve a detailed business record from the registry by jurisdiction and registration number. Returns a fuller record than search, including connected people (associates), standing, fictitious names, and industry codes.
- [Check business name eligibility](https://docs.getpalm.com/api-reference/v1/registry/check-business-name-eligibility.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Get accepted name designators](https://docs.getpalm.com/api-reference/v1/registry/get-accepted-name-designators.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [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…
- [List documents](https://docs.getpalm.com/api-reference/v1/business/list-documents.md): Returns all documents uploaded for this business, including each document's types, filename, size, content type, and status. Filter by document `type` (matches any entry of `types`), `status`, or the work a document is part of (`case_id`, `filing_id`). Use a document `id` with the [document endpoint…
- [Upload document](https://docs.getpalm.com/api-reference/v1/business/upload-document.md): Uploads a document for this business, such as its articles of incorporation, operating agreement, or EIN letter, as multipart form data. Returns the created document, including its `id`. Use that `id` with the [document endpoint](/api-reference/v1/documents/retrieve-document-metadata) to retrieve it…
- [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.
- [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. Non-encrypted vault fields (such as address) are included in the response; encrypted fields like EIN are referenced by fingerprint only.
- [Delete a business](https://docs.getpalm.com/api-reference/v1/business/delete-a-business.md): Deletes a business and its associated data including vault data and owner relationships. This performs a soft delete by default, setting the business status to deleted.
- [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.
- [Delete a document](https://docs.getpalm.com/api-reference/v1/business/delete-a-document.md): Removes a document from this business. The file is permanently deleted from storage and cannot be recovered. To retrieve a document's details before deleting it, use the [document endpoint](/api-reference/v1/documents/retrieve-document-metadata).
- [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`).
- [Verify existing user](https://docs.getpalm.com/api-reference/v1/user/verify-existing-user.md)
- [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.
- [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. Personal data is stored encrypted or as fingerprints and is not returned in the response.
- [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.
- [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.
- [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.
- [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.
- [Verify portfolio business](https://docs.getpalm.com/api-reference/v1/verification/verify-portfolio-business.md)
- [Retrieve business verification](https://docs.getpalm.com/api-reference/v1/verification/retrieve-business-verification.md)
- [Retrieve user verification](https://docs.getpalm.com/api-reference/v1/verification/retrieve-user-verification.md)
- [Monitor business](https://docs.getpalm.com/api-reference/v1/monitor/monitor-business.md): Subscribe to monitoring events for a business identified by `palm_id`, or by `registration_jurisdiction` with `registration_number`. Each identifier names one registration; a business registered in several jurisdictions is monitored per registration. When the organization does not already hold a por…
- [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.
- [Monitor portfolio business](https://docs.getpalm.com/api-reference/v1/monitor/monitor-portfolio-business.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. This action cannot be undone. To temporarily pause monitoring, use PATCH with status: paused instead.
- [Update business monitoring event types](https://docs.getpalm.com/api-reference/v1/monitor/update-business-monitoring-event-types.md): Update the event types, metadata, or status of a business subscription. Status may only be set to `active` or `paused` — to cancel a subscription, use the DELETE endpoint.
- [Get formation requirements](https://docs.getpalm.com/api-reference/v1/filing/get-formation-requirements.md): > **⚠️ Early access (corporations)** — Corporation support on this endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. LLC support is stable. Avoid depending on the corporation behavior in production, and [reach out](mailto:support@getpalm.com) before bui…
- [Get formation fee estimate](https://docs.getpalm.com/api-reference/v1/filing/get-formation-fee-estimate.md): > **⚠️ Early access (corporations)** — Corporation support on this endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. LLC support is stable. Avoid depending on the corporation behavior in production, and [reach out](mailto:support@getpalm.com) before bui…
- [Validate an LLC formation request](https://docs.getpalm.com/api-reference/v1/filing/validate-an-llc-formation-request.md): Check an LLC formation payload against state compliance rules without creating a filing or business record. Returns every compliance error in one pass, so you can pre-flight a submission.
- [Form an LLC](https://docs.getpalm.com/api-reference/v1/filing/form-an-llc.md): Form a new LLC by submitting a formation filing to the state.
- [Validate a corporation formation request](https://docs.getpalm.com/api-reference/v1/filing/validate-a-corporation-formation-request.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Form a corporation](https://docs.getpalm.com/api-reference/v1/filing/form-a-corporation.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Validate an EIN application request](https://docs.getpalm.com/api-reference/v1/filing/validate-an-ein-application-request.md): Check an EIN application payload for field-shape errors without creating a filing — the same dry-run pre-flight the formation validate endpoints offer. Returns every field error in one pass, including the conditional `principal_activity` follow-ups for the selected category.
- [Apply for an EIN](https://docs.getpalm.com/api-reference/v1/filing/apply-for-an-ein.md): Apply for an EIN with the IRS for a business already in your Palm account.
- [Get foreign qualification requirements](https://docs.getpalm.com/api-reference/v1/filing/get-foreign-qualification-requirements.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Get foreign qualification fee estimate](https://docs.getpalm.com/api-reference/v1/filing/get-foreign-qualification-fee-estimate.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Validate a foreign qualification request](https://docs.getpalm.com/api-reference/v1/filing/validate-a-foreign-qualification-request.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Register an existing business in another state](https://docs.getpalm.com/api-reference/v1/filing/register-an-existing-business-in-another-state.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [List filings](https://docs.getpalm.com/api-reference/v1/filing/list-filings.md): List filings in your Palm account, ordered most-recent first. Filter by type, status, or linked business; paginate with the opaque `cursor` returned on the previous page.
- [Retrieve a filing](https://docs.getpalm.com/api-reference/v1/filing/retrieve-a-filing.md): Retrieve a single filing by ID. The response includes its current status, the completion result (registration number for formations, EIN for EIN filings), the bundle of related obligations (`related_items` — EIN filings and the registered agent, each with its own status), cases that need your action…
- [Cancel a filing](https://docs.getpalm.com/api-reference/v1/filing/cancel-a-filing.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Submit a response to a case](https://docs.getpalm.com/api-reference/v1/case/submit-a-response-to-a-case.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [List cases](https://docs.getpalm.com/api-reference/v1/case/list-cases.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Retrieve a case](https://docs.getpalm.com/api-reference/v1/case/retrieve-a-case.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Retrieve registered agent service](https://docs.getpalm.com/api-reference/v1/registered-agent/retrieve-registered-agent-service.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Change or end registered agent service](https://docs.getpalm.com/api-reference/v1/registered-agent/change-or-end-registered-agent-service.md): > **⚠️ Early access** — This endpoint is in preview and may change in backwards-incompatible ways before it is marked stable. Avoid depending on it in production, and [reach out](mailto:support@getpalm.com) before building on it.
- [Retrieve document metadata](https://docs.getpalm.com/api-reference/v1/documents/retrieve-document-metadata.md): Returns a document by its `id`, including its type, filename, size, content type, and status. You can find a document `id` in the `documents` array of a filing or business response. To download the file itself, use the [download endpoint](/api-reference/v1/documents/download-a-document). To list or…
- [Download a document](https://docs.getpalm.com/api-reference/v1/documents/download-a-document.md): Downloads a document by its `id`. The response is the raw file, served with the document's `Content-Type` and a `Content-Disposition: attachment` header so it saves with its original filename. A document can be downloaded as often as you need, for as long as it exists.
- [Changelog](https://docs.getpalm.com/changelog.md): Latest updates and improvements to the Palm API

## OpenAPI Specs

- [openapi](/api-reference/v1/openapi.json)

## Optional

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.