Skip to content

Variable: SubmissionStatus ​

ts
const SubmissionStatus: ZodObject<{
  handoff: ZodDefault<ZodBoolean>;
  next: ZodDefault<ZodNullable<ZodObject<{
     link: ZodNullable<ZodString>;
     message: ZodNullable<ZodString>;
     submissionId: ZodGUID;
  }, $strip>>>;
  run: ZodNullable<ZodObject<{
     currentStepId: ZodNullable<ZodString>;
     decision: ZodNullable<ZodObject<{
        outcome: ZodEnum<{
           approve: "approve";
           manual_review: "manual_review";
           reject: "reject";
        }>;
     }, $strip>>;
     id: ZodGUID;
     status: ZodEnum<{
        cancelled: "cancelled";
        completed: "completed";
        failed: "failed";
        running: "running";
        waiting_callback: "waiting_callback";
        waiting_collection: "waiting_collection";
        waiting_manual: "waiting_manual";
     }>;
  }, $strip>>;
  submission: ZodObject<{
     id: ZodGUID;
     status: ZodEnum<{
        expired: "expired";
        in_progress: "in_progress";
        submitted: "submitted";
        withdrawn: "withdrawn";
     }>;
     submittedAt: ZodNullable<ZodCoercedDate<unknown>>;
  }, $strip>;
}, $strip>;

Response of GET /collection-submissions/:id/status: the applicant-readable view of a submission and of where its workflow run is. The collection flow polls it after submit.

Released under the Apache-2.0 License.