Requirement

A requirement requested by an underwriter

  • applicantNotes
    Type: string nullable

    Notes from the applicant

  • applicationId
    Type: integer

    ID of the associated application

  • createdAt
    Type: stringFormat: date-time

    Record creation timestamp

  • currentValue
    Type: string nullable

    Current value of the field for reference

  • customDocumentName
    Type: string nullable

    Custom name for ad-hoc document requests

  • documentDescription
    Type: string nullable

    Additional description for the document request

  • documentKey
    Type: string nullable

    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

  • fieldLabel
    Type: string nullable

    Human-readable label for the field

  • fieldPath
    Type: string nullable

    Path to the field within the section (e.g., "dbaPhone", "homeAddress")

  • fieldSection
    Type: string nullable

    Section of the application for field updates. Valid sections: basics, businessDetails, businessHistory, businessBanking, businessBuilding, businessInventory, orderProcessing, scheduleABasics, businessOwners

  • forOwner
    Type: boolean

    Whether the document is required for a specific business owner

  • id
    Type: integer

    Unique identifier for the requirement

  • ownerUniqueId
    Type: string nullable

    Unique ID of the owner if forOwner is true

  • priority
    Type: stringenum

    Priority level of the requirement

    values
    • required
    • recommended
  • questionText
    Type: string nullable

    The question to ask the applicant (only set for question requirements)

  • reason
    Type: string

    Explanation of why this requirement is needed

  • rejectionReason
    Type: string nullable

    Reason for rejection if status is rejected

  • requestedAt
    Type: stringFormat: date-time

    When the requirement was created

  • requestedBy
    Type: integer

    User ID of the underwriter who requested this

  • requestedByUser
    Type: object nullable

    Details of the user who requested this requirement

    • email
      Type: string
    • id
      Type: integer

      Integer numbers.

    • name
      Type: string nullable
  • resolvedAt
    Type: stringFormat: date-time nullable

    When the requirement was resolved

  • resolvedBy
    Type: integer nullable

    User ID of who resolved the requirement

  • status
    Type: stringenum

    Current status of the requirement

    values
    • pending
    • submitted
    • approved
    • rejected
    • waived
  • type
    Type: stringenum

    Type of requirement

    values
    • document
    • field_update
    • question
  • underwriterNotes
    Type: string nullable

    Internal notes from the underwriter

  • updatedAt
    Type: stringFormat: date-time

    Record last update timestamp