BaseApiResponsePreApprovalResponse

Standard API response wrapper for all endpoints

  • status
    Type: string
    required

    HTTP status name

  • timestamp
    Type: string Format: date-time
    required

    Timestamp when the response was generated

  • data
    Type: object · PreApprovalResponse

    Response data payload

    • accountQuoteData
      Type: object · LoanDetailsResponse

      Account quote details for the offered amount and rate, present when decision is Approved

    • contactId
      Type: integer Format: int32

      The contact ID — required to confirm or abandon the preapproval

    • decision
      Type: string

      Preapproval decision: Approved, Referred, Declined, or Failed

    • offeredAmount
      Type: number

      Amount offered, present when decision is Approved

    • offeredRate
      Type: number

      Interest rate offered, present when decision is Approved

    • reason
      Type: string

      Reason for the decision, present when decision is not Approved

    • success
      Type: boolean

      Indicates if the preapproval request was processed successfully

  • errors
    Type: array object[] · ApiError[]

    List of detailed validation errors

    Individual field validation error

    • message
      Type: string
      required

      Validation error message

    • property
      Type: string

      Field name that failed validation

  • message
    Type: string

    Descriptive message about the response