Get Job Status Details
Gets the status and details of a document processing job given a job id. When you submit documents through our API, each submission creates a job that can be tracked. The job status will always be one of ‘PENDING’, ‘COMPLETED’, or ‘FAILED’. COMPLETED includes jobs that finished without creating new documents — for example duplicates, non-utility files, or password-protected files. In general jobs will not fail due to retry policies. However, when a job does show ‘FAILED’ as the status, please get in touch with our team at support@nectarclimate.com. When the job is completed, this endpoint returns the ids of processed documents plus any duplicates, non-utility files, password-protected files, and processing errors. You can also subscribe to the job.completed.v2 webhook instead of polling.
Authorizations
Path Parameters
ID of the job to retrieve status for.
Response
Status of a document upload job, including created documents and files that were duplicates, non-utility, password-protected, or failed processing.
The ID of the job.
255The current status of the job, one of: PENDING, COMPLETED, FAILED. COMPLETED includes jobs that produced no new documents (duplicates, non-utility files, password-protected files, or processing errors). If the job status is FAILED, please contact our support team.
PENDING- PendingCOMPLETED- CompletedFAILED- Failed
PENDING, COMPLETED, FAILED List of document IDs that were processed successfully by the job. This is only populated if the job is completed. Empty when the job finished without creating new documents.
Number of duplicate files detected by the job. This is only populated if the job is completed.
List of document IDs that were identified as duplicates by the job. This is only populated if the job is completed.
List of document IDs that were identified as non-utility documents by the job. This is only populated if the job is completed.
List of document IDs that were identified as password-protected by the job. This is only populated if the job is completed.
List of document IDs that failed processing. This is only populated if the job is completed.
The reason the job failed. This is only populated if the job status is FAILED.