/underwriting/applications/{id}/notes

POST /underwriting/applications/{id}/notes

Add underwriting note

Add a note to an application's underwriting record

Required Parameters

id path string

Application ID

Request Body

Minimum Required
All Properties

{
  "note": "string",
  "noteType": "string"
}

{
  "note": "string",
  "noteType": "string",
  "isInternal": true
}

Try it out

Output:

Responses

Description

Note added successfully

{
  "id": "string",
  "applicationId": "string",
  "note": "string",
  "noteType": "string",
  "isInternal": false,
  "authorId": "string",
  "createdAt": "string"
}

References

#/components/schemas/UnderwritingNote

OpenAPI
TypeScript

type: object
properties:
  id:
    type: string
    description: Note ID
  applicationId:
    type: string
    description: Application ID
  note:
    type: string
    description: Note content
  noteType:
    type: string
    enum:
      - general
      - risk_assessment
      - decision_rationale
      - follow_up
      - compliance
    description: Note type
  isInternal:
    type: boolean
    description: Whether note is internal
  authorId:
    type: string
    description: ID of note author
  createdAt:
    type: string
    format: date-time
    description: Note creation timestamp

|
export interface UnderwritingNote {
  /** Note ID */
  id?: string;
  /** Application ID */
  applicationId?: string;
  /** Note content */
  note?: string;
  /** Note type */
  noteType?:
    | "general"
    | "risk_assessment"
    | "decision_rationale"
    | "follow_up"
    | "compliance";
  /** Whether note is internal */
  isInternal?: boolean;
  /** ID of note author */
  authorId?: string;
  /** Note creation timestamp */
  createdAt?: Date;
}

Route Source Code

Check out the source code for this route entrypoint here: /underwriting/applications/[id]/notes/route.ts

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