/underwriting/queue

GET /underwriting/queue

Get underwriting queue

Retrieve a paginated list of applications in the underwriting queue with advanced filtering options

Required Parameters

x-account-id header string

Account ID for the request

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

Page number for pagination

limit query integer

Number of applications per page (max 100)

status query array

Filter by application status (can specify multiple)

priority query array

Filter by priority level (can specify multiple)

assignedTo query string

Filter by assigned underwriter user ID (use "unassigned" for unassigned applications)

riskLevel query array

Filter by risk level (can specify multiple)

dateFrom query string

Filter applications submitted from this date (YYYY-MM-DD)

dateTo query string

Filter applications submitted up to this date (YYYY-MM-DD)

search query string

Search across application/merchant fields (DBA name, legal name, unique ID)

Try it out

Output:

Responses

Description

Successfully retrieved underwriting queue

{
  "data": [
    {
      "id": 0,
      "uniqueId": "string",
      "dbaName": "string",
      "legalName": "string",
      "industryType": "string",
      "mccNumber": "string",
      "yearsInBiz": 0,
      "monthsInBiz": 0,
      "appStatus": "string",
      "priority": "string",
      "assignedTo": "string",
      "assignedToName": "string",
      "submittedDate": "string",
      "lastActivityDate": "string",
      "riskScore": "string",
      "riskLevel": "string",
      "documentCount": 0,
      "pendingDocuments": 0
    }
  ],
  "totalCount": 0,
  "currentPage": 0,
  "totalPages": 0
}

Description

Bad request - invalid parameters

{
  "error": "Invalid priority parameter provided"
}

Description

Authentication required

{
  "error": "Authentication required"
}

Description

Insufficient permissions

{
  "error": "readApplications permission is required"
}

Description

Internal server error

{
  "error": "Failed to get underwriting queue"
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/QueueItem #/components/responses/BadRequest #/components/responses/Unauthorized #/components/responses/Forbidden #/components/responses/InternalServerError

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/QueueItem

OpenAPI
TypeScript

type: object
properties:
  id:
    type: integer
    description: Application ID
  uniqueId:
    type: string
    description: Application unique identifier
  dbaName:
    type: string
    description: Business DBA name
  legalName:
    type: string
    description: Business legal name
  industryType:
    type: string
    description: Industry type
  mccNumber:
    type: string
    description: Merchant Category Code
  yearsInBiz:
    type: integer
    description: Years in business
  monthsInBiz:
    type: integer
    description: Additional months in business
  appStatus:
    type: string
    enum:
      - SUBMITTED
      - IN_UNDERWRITING
      - VERIFICATION_PENDING
      - ADDITIONAL_REVIEW_REQUIRED
      - APPROVED
      - DECLINED
      - CONDITIONALLY_APPROVED
      - PENDING_INFORMATION
    description: Current application status
  priority:
    type: string
    enum:
      - low
      - medium
      - high
      - urgent
    description: Application priority level
  assignedTo:
    type: string
    description: Assigned underwriter user ID
  assignedToName:
    type: string
    description: Assigned underwriter name
  submittedDate:
    type: string
    format: date-time
    description: Date application was submitted
  lastActivityDate:
    type: string
    format: date-time
    description: Date of last activity on application
  riskScore:
    type: string
    description: Risk assessment score (numeric string)
  riskLevel:
    type: string
    enum:
      - low
      - medium
      - high
    description: Risk level classification
  documentCount:
    type: integer
    description: Total number of documents attached
  pendingDocuments:
    type: integer
    description: Number of documents pending review

|
export interface QueueItem {
  /** Application ID */
  id?: number;
  /** Application unique identifier */
  uniqueId?: string;
  /** Business DBA name */
  dbaName?: string;
  /** Business legal name */
  legalName?: string;
  /** Industry type */
  industryType?: string;
  /** Merchant Category Code */
  mccNumber?: string;
  /** Years in business */
  yearsInBiz?: number;
  /** Additional months in business */
  monthsInBiz?: number;
  /** Current application status */
  appStatus?:
    | "SUBMITTED"
    | "IN_UNDERWRITING"
    | "VERIFICATION_PENDING"
    | "ADDITIONAL_REVIEW_REQUIRED"
    | "APPROVED"
    | "DECLINED"
    | "CONDITIONALLY_APPROVED"
    | "PENDING_INFORMATION";
  /** Application priority level */
  priority?: "low" | "medium" | "high" | "urgent";
  /** Assigned underwriter user ID */
  assignedTo?: string;
  /** Assigned underwriter name */
  assignedToName?: string;
  /** Date application was submitted */
  submittedDate?: Date;
  /** Date of last activity on application */
  lastActivityDate?: Date;
  /** Risk assessment score (numeric string) */
  riskScore?: string;
  /** Risk level classification */
  riskLevel?: "low" | "medium" | "high";
  /** Total number of documents attached */
  documentCount?: number;
  /** Number of documents pending review */
  pendingDocuments?: number;
}

#/components/responses/BadRequest

OpenAPI
TypeScript

description: Bad request - invalid parameters
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: Invalid priority parameter provided

|
export type BadRequest = any; // Schema type not fully supported

#/components/responses/Unauthorized

OpenAPI
TypeScript

description: Authentication required
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: Authentication required

|
export type Unauthorized = any; // Schema type not fully supported

#/components/responses/Forbidden

OpenAPI
TypeScript

description: Insufficient permissions
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: readApplications permission is required

|
export type Forbidden = any; // Schema type not fully supported

#/components/responses/InternalServerError

OpenAPI
TypeScript

description: Internal server error
content:
  application/json:
    schema:
      type: object
      properties:
        error:
          type: string
          example: Failed to get underwriting queue

|
export type InternalServerError = any; // Schema type not fully supported

Route Source Code

Check out the source code for this route entrypoint here: /underwriting/queue/route.ts

Or the swagger.yaml spec this documentation was generated from: /underwriting/queue/swagger.yaml