/underwriting/auto-approval-rules/{id}

GET /underwriting/auto-approval-rules/{id}

Get auto-approval rule

Retrieve a specific auto-approval rule by ID

Required Parameters

id path string

Rule ID

Try it out

Output:

Responses

Description

Auto-approval rule retrieved successfully

{
  "id": "string",
  "name": "string",
  "description": "string",
  "ruleType": "string",
  "criteria": {},
  "priority": 0,
  "maxAmount": "string",
  "conditions": [
    "string"
  ],
  "isActive": false,
  "createdBy": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "statistics": {
    "totalApplications": 0,
    "approvals": 0,
    "declines": 0,
    "flagged": 0,
    "averageAmount": "string",
    "lastUsed": "string",
    "successRate": 0
  }
}

References

#/components/schemas/AutoApprovalRule #/components/schemas/AutoApprovalRuleDetailed

type: object
properties:
  id:
    type: string
    description: Rule ID
  name:
    type: string
    description: Rule name
  description:
    type: string
    nullable: true
    description: Rule description
  ruleType:
    type: string
    enum:
      - auto_approve
      - auto_decline
      - flag_for_review
    description: Rule action type
  criteria:
    type: object
    description: Rule criteria configuration
  priority:
    type: integer
    description: Rule priority
  maxAmount:
    type: string
    nullable: true
    description: Maximum auto-approval amount
  conditions:
    type: array
    items:
      type: string
    description: Additional conditions
  isActive:
    type: boolean
    description: Whether rule is active
  createdBy:
    type: string
    description: ID of rule creator
  createdAt:
    type: string
    format: date-time
    description: Rule creation timestamp
  updatedAt:
    type: string
    format: date-time
    description: Last update timestamp

|
export interface AutoApprovalRule {
  /** Rule ID */
  id?: string;
  /** Rule name */
  name?: string;
  /** Rule description */
  description?: string;
  /** Rule action type */
  ruleType?: "auto_approve" | "auto_decline" | "flag_for_review";
  /** Rule criteria configuration */
  criteria?: {};
  /** Rule priority */
  priority?: number;
  /** Maximum auto-approval amount */
  maxAmount?: string;
  /** Additional conditions */
  conditions?: string[];
  /** Whether rule is active */
  isActive?: boolean;
  /** ID of rule creator */
  createdBy?: string;
  /** Rule creation timestamp */
  createdAt?: Date;
  /** Last update timestamp */
  updatedAt?: Date;
}

#/components/schemas/AutoApprovalRuleDetailed

OpenAPI
TypeScript

allOf:
  - type: object
    properties:
      id:
        type: string
        description: Rule ID
      name:
        type: string
        description: Rule name
      description:
        type: string
        nullable: true
        description: Rule description
      ruleType:
        type: string
        enum:
          - auto_approve
          - auto_decline
          - flag_for_review
        description: Rule action type
      criteria:
        type: object
        description: Rule criteria configuration
      priority:
        type: integer
        description: Rule priority
      maxAmount:
        type: string
        nullable: true
        description: Maximum auto-approval amount
      conditions:
        type: array
        items:
          type: string
        description: Additional conditions
      isActive:
        type: boolean
        description: Whether rule is active
      createdBy:
        type: string
        description: ID of rule creator
      createdAt:
        type: string
        format: date-time
        description: Rule creation timestamp
      updatedAt:
        type: string
        format: date-time
        description: Last update timestamp
    fromRef: "#/components/schemas/AutoApprovalRule"
  - type: object
    properties:
      statistics:
        type: object
        properties:
          totalApplications:
            type: integer
            description: Total applications processed by this rule
          approvals:
            type: integer
            description: Number of approvals
          declines:
            type: integer
            description: Number of declines
          flagged:
            type: integer
            description: Number flagged for review
          averageAmount:
            type: string
            description: Average approved amount
          lastUsed:
            type: string
            format: date-time
            nullable: true
            description: Last time rule was used
          successRate:
            type: number
            description: Success rate percentage

|
export interface AutoApprovalRuleDetailed_AllOf_0 {
  /** Rule ID */
  id?: string;
  /** Rule name */
  name?: string;
  /** Rule description */
  description?: string;
  /** Rule action type */
  ruleType?: "auto_approve" | "auto_decline" | "flag_for_review";
  /** Rule criteria configuration */
  criteria?: {};
  /** Rule priority */
  priority?: number;
  /** Maximum auto-approval amount */
  maxAmount?: string;
  /** Additional conditions */
  conditions?: string[];
  /** Whether rule is active */
  isActive?: boolean;
  /** ID of rule creator */
  createdBy?: string;
  /** Rule creation timestamp */
  createdAt?: Date;
  /** Last update timestamp */
  updatedAt?: Date;
}

export interface AutoApprovalRuleDetailed_AllOf_1 {
  statistics?: {
    totalApplications?: number;
    approvals?: number;
    declines?: number;
    flagged?: number;
    averageAmount?: string;
    lastUsed?: Date;
    successRate?: number;
  };
}

export type AutoApprovalRuleDetailed = AutoApprovalRuleDetailed_AllOf_0 &
  AutoApprovalRuleDetailed_AllOf_1;

Route Source Code

Check out the source code for this route entrypoint here: /underwriting/auto-approval-rules/[id]/route.ts

Or the swagger.yaml spec this documentation was generated from: /underwriting/auto-approval-rules/swagger.yaml