> ## 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.

# List document requests

> > **⚠️ 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 document requests, newest first.



## OpenAPI

````yaml /api-reference/v1/openapi.json get /v1/document-request
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:
    get:
      tags:
        - Document Request
      summary: List document requests
      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.


        List document requests, newest first.
      operationId: listDocumentRequests
      parameters:
        - name: business_id
          required: false
          in: query
          description: Filter by business
          schema:
            format: uuid
            example: 987e6543-e21a-45b6-c789-012345678901
            type: string
        - name: type
          required: false
          in: query
          description: Filter by document type
          schema:
            type: string
            enum:
              - certificate_of_good_standing
        - name: status
          required: false
          in: query
          description: Filter by status
          schema:
            type: string
            enum:
              - queued
              - processing
              - completed
              - failed
        - name: limit
          required: false
          in: query
          description: Page size, max 100 (default 10)
          schema:
            type: number
        - name: cursor
          required: false
          in: query
          description: Cursor from a previous page
          schema:
            type: string
      responses:
        '200':
          description: Document requests, newest first
          content:
            application/json:
              schema:
                type: object
                required:
                  - object
                  - has_more
                  - next_cursor
                  - data
                properties:
                  object:
                    type: string
                    enum:
                      - list
                    example: list
                    description: Object type identifier, always "list"
                  has_more:
                    type: boolean
                    example: true
                    description: Whether there are more results available
                  next_cursor:
                    type:
                      - string
                      - 'null'
                    example: crs_7g8h9i0j1k2l3m4n
                    description: >-
                      Cursor for the next page of results. Only present when
                      has_more is true.
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DocumentRequest'
                    description: Array of resources for the current page
      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_good_standing
        status:
          type: string
          description: Current status
          enum:
            - queued
            - processing
            - completed
            - failed
        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'
        result:
          description: >-
            Outcome of the request, populated on `completed` and `null` until
            then. Shape depends on `type`: certificate_of_good_standing → `{
            standing }`.
          oneOf:
            - $ref: '#/components/schemas/CertificateOfGoodStandingResult'
            - type: 'null'
        documents:
          description: >-
            Documents delivered by this request, stored on the business record.
            Empty until delivery.
          type: array
          items:
            $ref: '#/components/schemas/DocumentRequestDocument'
        failure_reason:
          type:
            - string
            - 'null'
          description: Why the request failed. Populated on `failed`, `null` otherwise.
          enum:
            - jurisdiction_declined
            - entity_not_found
            - cannot_fulfill
            - null
        completed_at:
          type:
            - string
            - 'null'
          description: >-
            ISO 8601 timestamp of when the request reached a terminal status,
            `null` while in flight.
          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
    CertificateOfGoodStandingResult:
      type: object
      properties:
        standing:
          type: string
          description: Business standing with the jurisdiction.
          enum:
            - compliant
            - not_compliant
          example: compliant
      required:
        - standing
    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
        type:
          type: string
          description: Document type
          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_good_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
          example: certificate_of_good_standing
        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
        - type
        - 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.