/applications/{applicationId}/requirements

GET /applications/{applicationId}/requirements

Get all requirements for an application

Retrieve all requirements for a specific application with optional filtering. Returns requirements sorted by priority (required first) then by creation date.

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

applicationId path string

The unique ID of the application

Optional Parameters

Click here to view an exhaustive list of all available parameters

status query string

Filter requirements by status

type query string

Filter requirements by type

includeSummary query boolean

Include summary counts by status and type

Try it out

Output:

Responses

Description

Requirements retrieved successfully

{
  "requirements": [
    {
      "id": 0,
      "applicationId": 0,
      "type": "string",
      "documentKey": "string",
      "customDocumentName": "string",
      "documentDescription": "string",
      "forOwner": false,
      "ownerUniqueId": "string",
      "fieldSection": "string",
      "fieldPath": "string",
      "fieldLabel": "string",
      "currentValue": "string",
      "reason": "string",
      "priority": "string",
      "status": "string",
      "requestedBy": 0,
      "requestedAt": "string",
      "resolvedBy": 0,
      "resolvedAt": "string",
      "underwriterNotes": "string",
      "applicantNotes": "string",
      "rejectionReason": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "requestedByUser": {
        "id": 0,
        "name": "string",
        "email": "string"
      }
    }
  ],
  "summary": {
    "total": 0,
    "pending": 0,
    "submitted": 0,
    "approved": 0,
    "rejected": 0,
    "waived": 0,
    "byType": {
      "document": 0,
      "field_update": 0
    }
  }
}

References

#/components/parameters/xAccountIdHeader #/components/parameters/applicationIdPath #/components/schemas/Requirement #/components/schemas/RequirementsSummary

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/parameters/applicationIdPath

OpenAPI
TypeScript

name: applicationId
in: path
required: true
schema:
  type: string
description: The unique ID of the application

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

#/components/schemas/Requirement

OpenAPI
TypeScript

type: object
description: A requirement requested by an underwriter
properties:
  id:
    type: integer
    description: Unique identifier for the requirement
  applicationId:
    type: integer
    description: ID of the associated application
  type:
    type: string
    enum:
      - document
      - field_update
    description: Type of requirement
  documentKey:
    type: string
    nullable: true
    description: >
      Predefined document key for standard document types.

      Valid keys: driver-license, corporation-documents, voided-check,
      bank-statement,

      processing-statement, processing-statement-3-months, tax-returns,
      financial-statements,

      p_l_statement, balance_sheet, pci, mail_phone_document,
      fulfillment-agreement,

      office_inventory_photos, ein-letter, business-license, other
  customDocumentName:
    type: string
    nullable: true
    description: Custom name for ad-hoc document requests
  documentDescription:
    type: string
    nullable: true
    description: Additional description for the document request
  forOwner:
    type: boolean
    description: Whether the document is required for a specific business owner
  ownerUniqueId:
    type: string
    nullable: true
    description: Unique ID of the owner if forOwner is true
  fieldSection:
    type: string
    nullable: true
    description: >
      Section of the application for field updates.

      Valid sections: basics, businessDetails, businessHistory, businessBanking,

      businessBuilding, businessInventory, orderProcessing, scheduleABasics,
      businessOwners
  fieldPath:
    type: string
    nullable: true
    description: Path to the field within the section (e.g., "dbaPhone", "homeAddress")
  fieldLabel:
    type: string
    nullable: true
    description: Human-readable label for the field
  currentValue:
    type: string
    nullable: true
    description: Current value of the field for reference
  reason:
    type: string
    description: Explanation of why this requirement is needed
  priority:
    type: string
    enum:
      - required
      - recommended
    description: Priority level of the requirement
  status:
    type: string
    enum:
      - pending
      - submitted
      - approved
      - rejected
      - waived
    description: Current status of the requirement
  requestedBy:
    type: integer
    description: User ID of the underwriter who requested this
  requestedAt:
    type: string
    format: date-time
    description: When the requirement was created
  resolvedBy:
    type: integer
    nullable: true
    description: User ID of who resolved the requirement
  resolvedAt:
    type: string
    format: date-time
    nullable: true
    description: When the requirement was resolved
  underwriterNotes:
    type: string
    nullable: true
    description: Internal notes from the underwriter
  applicantNotes:
    type: string
    nullable: true
    description: Notes from the applicant
  rejectionReason:
    type: string
    nullable: true
    description: Reason for rejection if status is rejected
  createdAt:
    type: string
    format: date-time
    description: Record creation timestamp
  updatedAt:
    type: string
    format: date-time
    description: Record last update timestamp
  requestedByUser:
    type: object
    nullable: true
    description: Details of the user who requested this requirement
    properties:
      id:
        type: integer
      name:
        type: string
        nullable: true
      email:
        type: string

>
export interface Requirement {
  /** Unique identifier for the requirement */
  id?: number;
  /** ID of the associated application */
  applicationId?: number;
  /** Type of requirement */
  type?: "document" | "field_update";
  /** Predefined document key for standard document types.
Valid keys: driver-license, corporation-documents, voided-check, bank-statement,

processing-statement, processing-statement-3-months, tax-returns,
financial-statements,

p_l_statement, balance_sheet, pci, mail_phone_document, fulfillment-agreement,

office_inventory_photos, ein-letter, business-license, other
 */
  documentKey?: string;
  /** Custom name for ad-hoc document requests */
  customDocumentName?: string;
  /** Additional description for the document request */
  documentDescription?: string;
  /** Whether the document is required for a specific business owner */
  forOwner?: boolean;
  /** Unique ID of the owner if forOwner is true */
  ownerUniqueId?: string;
  /** Section of the application for field updates.
Valid sections: basics, businessDetails, businessHistory, businessBanking,

businessBuilding, businessInventory, orderProcessing, scheduleABasics,
businessOwners
 */
  fieldSection?: string;
  /** Path to the field within the section (e.g., "dbaPhone", "homeAddress") */
  fieldPath?: string;
  /** Human-readable label for the field */
  fieldLabel?: string;
  /** Current value of the field for reference */
  currentValue?: string;
  /** Explanation of why this requirement is needed */
  reason?: string;
  /** Priority level of the requirement */
  priority?: "required" | "recommended";
  /** Current status of the requirement */
  status?: "pending" | "submitted" | "approved" | "rejected" | "waived";
  /** User ID of the underwriter who requested this */
  requestedBy?: number;
  /** When the requirement was created */
  requestedAt?: Date;
  /** User ID of who resolved the requirement */
  resolvedBy?: number;
  /** When the requirement was resolved */
  resolvedAt?: Date;
  /** Internal notes from the underwriter */
  underwriterNotes?: string;
  /** Notes from the applicant */
  applicantNotes?: string;
  /** Reason for rejection if status is rejected */
  rejectionReason?: string;
  /** Record creation timestamp */
  createdAt?: Date;
  /** Record last update timestamp */
  updatedAt?: Date;
  /** Details of the user who requested this requirement */
  requestedByUser?: { id?: number; name?: string; email?: string };
}

#/components/schemas/RequirementsSummary

OpenAPI
TypeScript

type: object
description: Summary counts of requirements by status and type
properties:
  total:
    type: integer
    description: Total number of requirements
  pending:
    type: integer
    description: Number of pending requirements
  submitted:
    type: integer
    description: Number of submitted requirements
  approved:
    type: integer
    description: Number of approved requirements
  rejected:
    type: integer
    description: Number of rejected requirements
  waived:
    type: integer
    description: Number of waived requirements
  byType:
    type: object
    properties:
      document:
        type: integer
        description: Number of document requirements
      field_update:
        type: integer
        description: Number of field update requirements

|
export interface RequirementsSummary {
  /** Total number of requirements */
  total?: number;
  /** Number of pending requirements */
  pending?: number;
  /** Number of submitted requirements */
  submitted?: number;
  /** Number of approved requirements */
  approved?: number;
  /** Number of rejected requirements */
  rejected?: number;
  /** Number of waived requirements */
  waived?: number;
  byType?: { document?: number; field_update?: number };
}

Route Source Code

Check out the source code for this route entrypoint here: /applications/[applicationId]/requirements/route.ts

Or the swagger.yaml spec this documentation was generated from: /applications/[applicationId]/requirements/swagger.yaml