> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getpalm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cancel a document request

> > **⚠️ 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.

Cancel a document request before Palm starts the order.

**When it succeeds.** The request must still be `queued`. It moves to the terminal `canceled` status, a `document_request.canceled` webhook fires, and the response returns the request with `status_reason` `partner_requested`, `canceled_by` `partner` and `canceled_at` set.

**When it fails.** Once the request is `processing` (or finished), cancellation returns a 409 `document_request_not_cancellable` problem whose `current_status` member carries the status the decision was made against. A refused cancel on a request in progress still reaches the Palm team working it, so they know you asked to stop. A request a foreign qualification ordered is canceled by canceling that filing: canceling the request itself returns the same 409, with the filing in `filing_id`.

**Canceled by Palm.** Palm can also cancel a request it cannot fulfill, before or during the order. The request moves to `canceled` with `canceled_by` `palm` and the reason in `status_reason`, and the same webhook fires. A request a foreign qualification ordered is canceled with `status_reason` `parent_filing_canceled` when that filing is canceled before Palm starts the order.

**Fees.** A canceled request is not billed.

In test mode a `queued` request can be canceled the same way.



## OpenAPI

````yaml /api-reference/v1/openapi.json post /v1/document-request/{document_request_id}/cancellation
openapi: 3.1.0
info:
  title: Palm Partner API
  description: >-
    The Palm API is identity verification and compliance infrastructure for US
    businesses: onboard businesses, verify businesses and people (KYB/KYC)
    against authoritative sources, monitor them for changes in real time, and
    act on their behalf through filings, formation, and registered agent
    services.
  version: '1.0'
  contact:
    name: Palm Support
    url: https://getpalm.com
    email: support@getpalm.com
  termsOfService: https://getpalm.com/terms
  license:
    name: Proprietary
    url: https://getpalm.com/license
servers:
  - url: https://api.getpalm.com
    description: Production
security: []
tags:
  - name: Registry
    description: Search business registries
  - name: Business
    description: Manage the businesses in your portfolio
  - name: User
    description: Manage the people in your portfolio
  - name: Verification
    description: Identity and business verification
  - name: Monitor
    description: Continuous monitoring of businesses
  - name: Filing
    description: Form a business, apply for an EIN, and register in additional states
  - name: Case
    description: Answer a request for information that a filing is waiting on
  - name: Registered Agent
    description: Registered agent service for a business
  - name: Documents
    description: Retrieve and download any document held for a business or a person
  - name: Webhooks
    description: Events Palm delivers to your webhook endpoints
paths:
  /v1/document-request/{document_request_id}/cancellation:
    post:
      tags:
        - Document Request
      summary: Cancel a document request
      description: >-
        > **⚠️ 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.


        Cancel a document request before Palm starts the order.


        **When it succeeds.** The request must still be `queued`. It moves to
        the terminal `canceled` status, a `document_request.canceled` webhook
        fires, and the response returns the request with `status_reason`
        `partner_requested`, `canceled_by` `partner` and `canceled_at` set.


        **When it fails.** Once the request is `processing` (or finished),
        cancellation returns a 409 `document_request_not_cancellable` problem
        whose `current_status` member carries the status the decision was made
        against. A refused cancel on a request in progress still reaches the
        Palm team working it, so they know you asked to stop. A request a
        foreign qualification ordered is canceled by canceling that filing:
        canceling the request itself returns the same 409, with the filing in
        `filing_id`.


        **Canceled by Palm.** Palm can also cancel a request it cannot fulfill,
        before or during the order. The request moves to `canceled` with
        `canceled_by` `palm` and the reason in `status_reason`, and the same
        webhook fires. A request a foreign qualification ordered is canceled
        with `status_reason` `parent_filing_canceled` when that filing is
        canceled before Palm starts the order.


        **Fees.** A canceled request is not billed.


        In test mode a `queued` request can be canceled the same way.
      operationId: cancelDocumentRequest
      parameters:
        - name: document_request_id
          required: true
          in: path
          description: Document request ID
          schema:
            format: uuid
            example: 0f6b2d84-5a31-4c97-8e42-6d1a9f3b7c58
            type: string
      responses:
        '200':
          description: Document request canceled
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentRequest'
        '404':
          description: Document request not found
        '409':
          description: >-
            Document request is already in progress or finished, or was ordered
            for a foreign qualification (`document_request_not_cancellable`,
            with `current_status`, and `filing_id` for a foreign qualification)
      security:
        - ApiKey: []
components:
  schemas:
    DocumentRequest:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the resource
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        object:
          type: string
          description: Object type
          example: document_request
          enum:
            - document_request
        mode:
          type: string
          description: >-
            Whether this resource was created with test or live credentials.
            Test and live data are fully isolated — a test resource never
            appears in live results and vice versa.
          enum:
            - test
            - live
          example: live
        created_at:
          type: string
          description: ISO 8601 timestamp of when the resource was created
          format: date-time
          example: '2025-10-24T10:30:00Z'
        updated_at:
          type: string
          description: ISO 8601 timestamp of when the resource was last updated
          format: date-time
          example: '2025-10-24T15:45:00Z'
        metadata:
          type: object
          description: >-
            Store up to 50 custom key-value pairs for application-specific data.
            Useful for storing references to external systems, feature flags, or
            other custom attributes.
          additionalProperties:
            type: string
          example:
            external_id: user_123_in_my_system
            customer_tier: premium
            signup_source: mobile_app
        type:
          type: string
          description: Requested document type
          enum:
            - certificate_of_standing
        status:
          type: string
          description: Current status
          enum:
            - queued
            - processing
            - completed
            - canceled
        business_id:
          type: string
          description: Business the request and its documents attach to.
          format: uuid
          example: 987e6543-e21a-45b6-c789-012345678901
        palm_id:
          type: string
          description: Palm ID of the registration the request resolved to.
          example: 2735-1926-5317
        registration_jurisdiction:
          type: string
          description: Jurisdiction of the registration (ISO 3166-2).
          example: US-DE
        registration_number:
          type:
            - string
            - 'null'
          description: The registration's number in that jurisdiction.
          example: '7086953'
        expedited_tier:
          type:
            - string
            - 'null'
          description: >-
            Expedited processing tier requested, or null for standard
            processing.
          example: expedited
        documents:
          description: >-
            Documents delivered by this request, stored on the business record.
            Empty until delivery. A request the jurisdiction refused to fulfill
            delivers what it returned, such as its refusal or fee receipt. Check
            each document's `types` for `certificate_of_standing` to tell a
            delivered certificate from a refusal. Retrieve the certificate at
            `GET /document/:id`: its `metadata.certificate_name` is the
            jurisdiction's own name for it, such as `Certificate of Status`, and
            its `metadata.issued_date` is the date printed on it, each when
            known.
          type: array
          items:
            $ref: '#/components/schemas/DocumentRequestDocument'
        completed_at:
          type:
            - string
            - 'null'
          description: ISO 8601 timestamp of when the request completed, `null` until then.
          format: date-time
          example: '2026-10-08T16:22:06Z'
        status_reason:
          type:
            - string
            - 'null'
          description: >-
            Why the request was canceled: `partner_requested` when you canceled
            it, `parent_filing_canceled` when the foreign qualification that
            ordered it was canceled, or the reason Palm wrote when Palm canceled
            it. `null` unless `canceled`.
          example: partner_requested
        canceled_by:
          type:
            - string
            - 'null'
          description: >-
            Who canceled the request: `partner` (you) or `palm`. `null` unless
            `canceled`.
          enum:
            - partner
            - palm
            - null
          example: partner
        canceled_at:
          type:
            - string
            - 'null'
          description: >-
            ISO 8601 timestamp of when the request was canceled, `null` unless
            `canceled`.
          format: date-time
          example: '2026-10-08T16:22:06Z'
      required:
        - id
        - object
        - mode
        - created_at
        - updated_at
        - metadata
        - type
        - status
        - business_id
        - palm_id
        - registration_jurisdiction
        - documents
    DocumentRequestDocument:
      type: object
      properties:
        id:
          type: string
          description: Document ID
          format: uuid
          example: 906f369f-a73b-46a2-8184-ccc5c2848abd
        object:
          type: string
          description: Object type
          enum:
            - document
          example: document
        types:
          type: array
          description: All document types that apply to this document.
          example:
            - certificate_of_standing
          items:
            type: string
            enum:
              - passport
              - drivers_license
              - national_id
              - government_id
              - articles_of_incorporation
              - certificate_of_formation
              - operating_agreement
              - bylaws
              - ein_letter
              - ein_letter_alternate
              - business_license
              - certificate_of_standing
              - certificate_of_authority
              - bank_statement
              - tax_return
              - filing_confirmation
              - welcome_letter
              - proof_of_address
              - service_of_process
              - notice
              - mail
              - ra_change_confirmation
              - ra_resignation
              - receipt
              - other
        uploaded_at:
          type: string
          description: ISO 8601 timestamp of when the document was stored.
          format: date-time
          example: '2026-10-08T16:22:05Z'
      required:
        - id
        - object
        - types
        - uploaded_at
  securitySchemes:
    ApiKey:
      scheme: bearer
      bearerFormat: opaque
      type: http
      description: 'Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx'

````

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