Skip to main content

GET /jobs/{jobId}

GET

Get Job Status & Results

/jobs/{jobId}

Polls an asynchronous job previously enqueued by `POST /receipts/extract`, `POST /submissions/audit`, or batch processing. When `status` becomes `completed`, the `result` object contains the full extracted receipt data or compliance audit findings.

Headers

HTTP Headers
ParameterTypeDescription
Authorizationrequiredstring
Bearer token format: Bearer <API_KEY>
Example: Bearer pep_live_99281a8b
X-Tenant-IDoptionalstring
B2B Tenant identifier.
Example: stepup

Path Parameters

URI Path
ParameterTypeDescription
jobIdrequiredstring
The unique alphanumeric job identifier returned when enqueuing the task.
Example: job_01HXYZ1234

Query Parameters

URL Query String
ParameterTypeDescription
includeResultoptionalboolean
default: true
Whether to include the full result payload or only status/timing metrics (useful for lightweight polling).
Example: true
fieldsoptionalstring
Comma-separated list of top-level result fields to include (e.g., items,vendor,amount).
Example: vendor,amount,items

Responses

3 status codes
200 OKJob details and results retrieved successfully.
{
  "jobId": "job_01HXYZ1234",
  "tenantId": "stepup",
  "status": "completed",
  "attempts": 1,
  "timing": {
    "queuedAt": "2026-09-15T15:20:00Z",
    "startedAt": "2026-09-15T15:20:01Z",
    "completedAt": "2026-09-15T15:20:05Z",
    "durationMs": 4120
  },
  "result": {
    "vendor": "Kumon Math & Reading Center",
    "amount": 180,
    "transactionDate": "2026-09-02",
    "invoiceType": "service",
    "items": [
      {
        "description": "Monthly Math Tutoring - September 2026",
        "price": 180,
        "quantity": 1,
        "salesTax": 0,
        "category": "Instruction & Tutoring",
        "type": "Tutoring Services",
        "detail": "Academic mathematics enrichment"
      }
    ],
    "paymentDetails": {
      "method": "MASTERCARD",
      "lastFour": "8910",
      "paidInFull": true,
      "payerName": "Rachel Davis"
    },
    "studentDetails": {
      "matched": true,
      "studentId": "stu_1002",
      "matchedName": "Emma Davis",
      "confidence": 96
    },
    "confidence": 97,
    "auditResult": {
      "isValidReceipt": true,
      "hasProofOfPayment": true,
      "hasItemization": true,
      "hasVendorDetails": true,
      "missingElements": []
    }
  },
  "error": null
}

Interactive Test Console

Bearer
{jobId}
includeResult
fields