Use this API to check the status and execution history of a specific background job, such as a statement generation job triggered via the Generate Account Statement endpoint.

Prerequisites

• Pass the jobId as a path parameter. The jobId is returned in the response when a job is created (e.g., when generating an account statement).

Example Request

GET /v1/runreports/jobHistory/{jobId}

Job Status Values

What's Returned

The response includes:

• status — Whether the job COMPLETED or FAILED.
• jobId — The unique identifier of the job.
• errorMessage — The error details if the job FAILED (e.g., a missing required parameter).
• documentId — The ID of the generated document when the job completes successfully. Use this ID to download the statement PDF.
• generateStatement — Indicates whether the job was a statement generation job.
• parentEntityType — The type of entity the job was run against (e.g., savings).