Get Application Status

Overview

The Get Application Status API retrieves the current status and details of a specific application by its unique identifier. This endpoint provides real-time information about application processing state and current workflow position.

Authentication

This endpoint requires authentication. See API Authentication for detailed requirements and how to obtain credentials.

Endpoint

GET /api/applications/{applicationId}/status

Path Parameters:

• {applicationId}: Replace with the actual application ID

Request Body

This API does not require a request body.

Response Structure

Interface Definitions

interface ApplicationStatusResponse {
   statusCode: number;
   data: {
      id: string;
      name: string;
      applicationStatus: ApplicationStatus;
   };
}

interface ApplicationStatusData {
   id: string;
   name: string;
   applicationStatus: ApplicationStatus;
}

enum ApplicationStatus {
   DRAFT = 'draft',
   PENDING = 'pending',
   REQUESTED = 'requested',
   PROVIDED = 'provided',
   APPROVED = 'approved',
   DECLINED = 'declined',
   CLOSED = 'closed',
}

Success Response

{
   "statusCode": 200,
   "data": {
      "id": "68d24d26101f1f7ed2b5fcba",
      "name": "Example Template",
      "applicationStatus": "pending"
   }
}

Field Validation Requirements

• applicationId path parameter must be a valid MongoDB ObjectId
• Application must exist in the system
• User must have access permissions to view the application status

Application Status Types

Status	Description
draft	The application is being prepared and not yet submitted
pending	The application has been submitted and is awaiting review
requested	Additional information or action has been requested from the applicant
provided	The requested information has been provided
approved	The application has been approved
declined	The application has been declined
closed	The application process is closed