Penneo Queue Status Check API

openapi: 3.2.0
info:
  title: Penneo Case File Queue Status Check API
  version: 1.0.0
  description: API for creating and managing Penneo case files. This API allows you to create case files with documents and signers, upload PDF files, and check the status of asynchronous job processing.
servers:
- url: https://sandbox.penneo.com
  description: Sandbox environment for testing and development
- url: https://app.penneo.com
  description: Production environment
tags:
- name: Queue Status Check
paths:
  /send/api/v1/queue/public/status:
    post:
      tags:
      - Queue Status Check
      summary: Check job status by UUID
      operationId: checkJobStatus
      description: Retrieves the current status of an asynchronous job by providing the job UUID and payload hash. This endpoint is used to poll for job completion status after submitting a case file creation request. The endpoint is rate-limited to 20 requests per minute per submission. No authentication is required as the UUID and payload hash provide the necessary security.
      parameters: []
      requestBody:
        required: true
        description: Job identification information including UUID and payload hash for verification.
        content:
          application/json:
            schema:
              type: object
              required:
              - uuid
              - payloadHash
              properties:
                uuid:
                  type: string
                  format: uuid
                  example: 123e4567-e89b-12d3-a456-426614174000
                  description: The UUID of the job to check. This is returned when the job is created.
                payloadHash:
                  type: string
                  example: 3a7bd3e2360a3d485f2a5f4d8e6f1e8b9c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f
                  description: The SHA-256 hash of the payload. This is returned when the job is created and is used to verify the request authenticity.
              description: Request body for checking job status. Both UUID and payloadHash are required for security verification.
            example:
              uuid: 123e4567-e89b-12d3-a456-426614174000
              payloadHash: 3a7bd3e2360a3d485f2a5f4d8e6f1e8b9c6d5e4f3a2b1c0d9e8f7a6b5c4d3e2f
      responses:
        '200':
          description: Successfully retrieved the job status. Returns the complete job information including status, payload, and timestamps.
          content:
            application/json:
              schema:
                type: object
                required:
                - uuid
                - type
                - payload
                - payloadHash
                - jobStatus
                - retries
                - maxRetries
                - createdAt
                - updatedAt
                description: Represents an asynchronous job in the queue system. Jobs are created when case files are submitted and can be checked for status updates.
                properties:
                  type:
                    type: string
                    description: The type of the queue job (e.g., 'casefile_creation')
                  uuid:
                    type: string
                    format: uuid
                    description: Unique identifier for the job
                  result:
                    type:
                    - object
                    - 'null'
                    default: null
                    description: The result of the queue job execution, returned as JSON when the job is completed. Contains the outcome and any relevant data.
                  payload:
                    type: object
                    description: The original payload submitted with the job, stored as JSON. Contains the case file data and metadata.
                  retries:
                    type: number
                    default: 0
                    description: The number of times the job has been retried after a failure
                  createdAt:
                    type: string
                    format: date-time
                    description: The date and time when the queue job was created
                  jobStatus:
                    type: string
                    enum:
                    - pending
                    - processing
                    - completed
                    - failed
                    - aborted_duplicated
                    default: pending
                    description: 'Current status of the job. Possible values: ''pending'' (waiting to be processed), ''processing'' (currently being executed), ''completed'' (successfully finished), ''failed'' (execution failed), ''aborted_duplicated'' (aborted due to duplication)'
                  updatedAt:
                    type: string
                    format: date-time
                    description: The date and time when the queue job was last updated
                  maxRetries:
                    type: number
                    default: 0
                    description: The maximum number of retries allowed for this job before it is marked as failed
                  payloadHash:
                    type: string
                    description: SHA-256 hash of the payload, used for verification and security purposes
                  errorMessage:
                    type:
                    - string
                    - 'null'
                    default: null
                    description: Error message describing why the job failed, if applicable. Only present when jobStatus is 'failed'.
        '400':
          description: Bad Request - Invalid request body. UUID or payloadHash format is incorrect.
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                - statusCode
                description: Error response returned when the request is malformed or contains invalid data.
                properties:
                  message:
                    type: string
                    example: Invalid request body
                    description: Human-readable error message explaining what went wrong
                  statusCode:
                    type: number
                    example: 400
                    description: HTTP status code indicating a bad request
        '404':
          description: Not Found - The job with the provided UUID and payload hash was not found. This may occur if the job has expired, been deleted, or the provided credentials are incorrect.
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                - statusCode
                description: Error response returned when the requested job is not found.
                properties:
                  message:
                    type: string
                    example: Job not found
                    description: Human-readable error message explaining that the job was not found
                  statusCode:
                    type: number
                    example: 404
                    description: HTTP status code indicating the resource was not found
        '429':
          description: Too Many Requests - Rate limit exceeded. The endpoint allows a maximum of 20 requests per minute per submission (uuid-payloadHash combination).
          content:
            application/json:
              schema:
                type: object
                required:
                - message
                - statusCode
                description: Error response returned when the rate limit is exceeded.
                properties:
                  message:
                    type: string
                    example: Too Many Requests
                    description: Human-readable error message explaining that rate limit has been exceeded
                  statusCode:
                    type: number
                    example: 429
                    description: HTTP status code indicating too many requests
x-provenance:
  method: searched
  source: https://developer.penneo.com/reference
  harvested: '2026-10-27'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developer.penneo.com/reference/checkjobstatus.md
  - https://developer.penneo.com/reference/createcasefile.md
  merge:
    pages: 2
    deduped: 0
    conflicts_kept_first: 0