Get Borrower Events

GET /v1/borrowers/{borrower_id}/get_events

Retrieves all borrower events

Path parameters

borrower_id string Required

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- borrower_id string
- events object
  
  List of events associated to the specified borrower
  
  Additional properties are allowed.
  
  Hide events attributes Show events attributes object
  
  loan_balance_adjusted array[object] | null
  
  Hide loan_balance_adjusted attributes Show loan_balance_adjusted attributes object
  
  balance_adjustment object
  
  Additional properties are allowed.
  
  Hide balance_adjustment attributes Show balance_adjustment attributes object
  
  bucket_adjustments object
  
  Hide bucket_adjustments attribute Show bucket_adjustments attribute object
  
  * object Additional properties
  
  Hide * attribute Show * attribute object
  
  * integer Additional properties
  
  effective_date string(date-time)
  
  loan_id integer
  
  id integer
  
  occurred_on string(date-time)
  
  loan_cancellation_reverted array[object] | null
  
  Hide loan_cancellation_reverted attributes Show loan_cancellation_reverted attributes object
  
  cancellation_reversal object
  
  Additional properties are allowed.
  
  Hide cancellation_reversal attributes Show cancellation_reversal attributes object
  
  cancellation_id integer
  
  effective_date string(date-time)
  
  id integer
  
  occurred_on string(date-time)
  
  loan_cancelled array[object] | null
  
  Hide loan_cancelled attributes Show loan_cancelled attributes object
  
  id integer
  
  loan_cancellation object
  
  Additional properties are allowed.
  
  Hide loan_cancellation attributes Show loan_cancellation attributes object
  
  effective_date string(date-time)
  
  external_id null | string
  
  id integer
  
  ledger_mapping string
  
  loan_id integer
  
  occurred_on string(date-time)
  
  loan_charged_off array[object] | null
  
  Hide loan_charged_off attributes Show loan_charged_off attributes object
  
  id integer
  
  loan_chargeoff object
  
  Additional properties are allowed.
  
  Hide loan_chargeoff attributes Show loan_chargeoff attributes object
  
  effective_date string(date-time)
  
  id integer
  
  loan_id integer
  
  occurred_on string(date-time)
  
  loan_consolidated array[object] | null
  
  Hide loan_consolidated attributes Show loan_consolidated attributes object
  
  id integer
  
  loan_consolidation object
  
  Additional properties are allowed.
  
  Hide loan_consolidation attributes Show loan_consolidation attributes object
  
  consolidation_config string
  
  daily_fee_charge integer
  
  delinquency_interest_rate number
  
  due_dates array[string(date-time)] | null
  
  effective_date string(date-time)
  
  external_id string
  
  id integer
  
  interest_rate number
  
  loan_config string
  
  original_loans array[integer] | null
  
  owner string
  
  occurred_on string(date-time)
  
  loan_consolidation_cancelled array[object] | null
  
  Hide loan_consolidation_cancelled attributes Show loan_consolidation_cancelled attributes object
  
  id integer
  
  loan_consolidation_cancellation object
  
  Additional properties are allowed.
  
  Hide loan_consolidation_cancellation attributes Show loan_consolidation_cancellation attributes object
  
  effective_date string(date-time)
  
  loan_consolidation_id integer
  
  occurred_on string(date-time)
  
  loan_originated array[object] | null
  
  Hide loan_originated attributes Show loan_originated attributes object
  
  id integer
  
  loan object
  
  Additional properties are allowed.
  
  Hide loan attributes Show loan attributes object
  
  amount_financed integer
  
  config_name string
  
  daily_fee_charge integer
  
  delinquency_interest_rate number
  
  due_dates array[string(date-time)] | null
  
  external_id string
  
  id integer
  
  installment_fee_2_charge integer
  
  installment_fee_charge integer
  
  installment_fee_type string
  
  interest_rate number
  
  origination_date string(date-time)
  
  owner string
  
  occurred_on string(date-time)
  
  loan_restructured array[object] | null
  
  Hide loan_restructured attributes Show loan_restructured attributes object
  
  id integer
  
  loan_restructuring object
  
  Additional properties are allowed.
  
  Hide loan_restructuring attributes Show loan_restructuring attributes object
  
  amortization_method null | string
  
  amount_financed null | integer
  
  config_id string
  
  delinquency_interest_rate null | number
  
  due_dates array[string(date-time)] | null
  
  effective_date string(date-time)
  
  external_id string
  
  id integer
  
  installment_fee null | integer
  
  installment_fee_2 null | integer
  
  interest_rate null | number
  
  ledger_mapping string
  
  loan_id integer
  
  manual_pmts null | object
  
  Hide manual_pmts attribute Show manual_pmts attribute null | object
  
  * integer Additional properties
  
  occurred_on string(date-time)
  
  manual_chargeoff_cancelled array[object] | null
  
  Hide manual_chargeoff_cancelled attributes Show manual_chargeoff_cancelled attributes object
  
  chargeoff_cancellation object
  
  Additional properties are allowed.
  
  Hide chargeoff_cancellation attributes Show chargeoff_cancellation attributes object
  
  chargeoff_id integer
  
  effective_date string(date-time)
  
  id integer
  
  occurred_on string(date-time)
  
  ownership_transferred array[object] | null
  
  Hide ownership_transferred attributes Show ownership_transferred attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  ownership_transfer object
  
  Additional properties are allowed.
  
  Hide ownership_transfer attributes Show ownership_transfer attributes object
  
  effective_date string(date-time)
  
  loan_id integer
  
  to string
  
  payment_allocated array[object] | null
  
  Hide payment_allocated attributes Show payment_allocated attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  payment_allocation object
  
  Additional properties are allowed.
  
  Hide payment_allocation attributes Show payment_allocation attributes object
  
  effective_date string(date-time)
  
  loan_allocation object
  
  Hide loan_allocation attribute Show loan_allocation attribute object
  
  * integer Additional properties
  
  payment_id integer
  
  payment_annulled array[object] | null
  
  Hide payment_annulled attributes Show payment_annulled attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  payment_cancellation object
  
  Additional properties are allowed.
  
  Hide payment_cancellation attributes Show payment_cancellation attributes object
  
  effective_date string(date-time)
  
  payment_id integer
  
  payment_received array[object] | null
  
  Hide payment_received attributes Show payment_received attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  payment object
  
  Additional properties are allowed.
  
  Hide payment attributes Show payment attributes object
  
  amount_paid integer
  
  config_name string
  
  external_id string
  
  id integer
  
  payment_date string(date-time)
  
  positive_balance_adjusted array[object] | null
  
  Hide positive_balance_adjusted attributes Show positive_balance_adjusted attributes object
  
  balance_adjustment object
  
  Additional properties are allowed.
  
  Hide balance_adjustment attributes Show balance_adjustment attributes object
  
  effective_date string(date-time)
  
  value integer
  
  id integer
  
  occurred_on string(date-time)
  
  positive_balance_reimbursed array[object] | null
  
  Hide positive_balance_reimbursed attributes Show positive_balance_reimbursed attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  reimbursement object
  
  Additional properties are allowed.
  
  Hide reimbursement attributes Show reimbursement attributes object
  
  effective_date string(date-time)
  
  external_id string
  
  id integer
  
  value integer
  
  positive_balance_reimbursement_cancelled array[object] | null
  
  Hide positive_balance_reimbursement_cancelled attributes Show positive_balance_reimbursement_cancelled attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  reimbursement_cancellation object
  
  Additional properties are allowed.
  
  Hide reimbursement_cancellation attributes Show reimbursement_cancellation attributes object
  
  effective_date string(date-time)
  
  reimbursement_id integer
  
  restructuring_cancelled array[object] | null
  
  Hide restructuring_cancelled attributes Show restructuring_cancelled attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  restructuring_cancellation object
  
  Additional properties are allowed.
  
  Hide restructuring_cancellation attributes Show restructuring_cancellation attributes object
  
  effective_date string(date-time)
  
  restructuring_id integer
  
  waiver_cancelled array[object] | null
  
  Hide waiver_cancelled attributes Show waiver_cancelled attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  waiver_cancellation object
  
  Additional properties are allowed.
  
  Hide waiver_cancellation attributes Show waiver_cancellation attributes object
  
  effective_date string(date-time)
  
  waiver_id integer
  
  waiver_created array[object] | null
  
  Hide waiver_created attributes Show waiver_created attributes object
  
  id integer
  
  occurred_on string(date-time)
  
  waiver object
  
  Additional properties are allowed.
  
  Hide waiver attributes Show waiver attributes object
  
  amount null | integer
  
  bucket string
  
  config_id string
  
  effective_date string(date-time)
  
  external_id string
  
  id integer
  
  loan_id integer
  
  percentage null | number
  
  reason string
  
  type string
400 application/json

Bad Request
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
404 application/json

Not Found
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
409 application/json

Conflict
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.
500 application/json

Internal Server Error
Hide response attributes Show response attributes object
- code integer
  
  Application-specific error code.
- context object
  
  Application context.
  
  Additional properties are allowed.
- error string
  
  Error message.
- status string
  
  Status text.

GET /v1/borrowers/{borrower_id}/get_events

curl \
 --request GET 'https://sandbox.lms.kordev.io/v1/borrowers/7dabe6cd-db31-45c7-a3fb-00f2dc7324dc/get_events'

Response examples (200)

{
  "borrower_id": "7dabe6cd-db31-45c7-a3fb-00f2dc7324dc",
  "events": {
    "loan_balance_adjusted": [
      {
        "balance_adjustment": {
          "bucket_adjustments": {
            "additionalProperty1": {
              "additionalProperty1": 42,
              "additionalProperty2": 42
            },
            "additionalProperty2": {
              "additionalProperty1": 42,
              "additionalProperty2": 42
            }
          },
          "effective_date": "2025-05-04T09:42:00Z",
          "loan_id": 42
        },
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_cancellation_reverted": [
      {
        "cancellation_reversal": {
          "cancellation_id": 42,
          "effective_date": "2025-05-04T09:42:00Z"
        },
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_cancelled": [
      {
        "id": 42,
        "loan_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "external_id": null,
          "id": 42,
          "ledger_mapping": "string",
          "loan_id": 42
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_charged_off": [
      {
        "id": 42,
        "loan_chargeoff": {
          "effective_date": "2025-05-04T09:42:00Z",
          "id": 42,
          "loan_id": 42
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_consolidated": [
      {
        "id": 42,
        "loan_consolidation": {
          "consolidation_config": "string",
          "daily_fee_charge": 42,
          "delinquency_interest_rate": 42.0,
          "due_dates": [
            "2025-05-04T09:42:00Z"
          ],
          "effective_date": "2025-05-04T09:42:00Z",
          "external_id": "string",
          "id": 42,
          "interest_rate": 42.0,
          "loan_config": "string",
          "original_loans": [
            42
          ],
          "owner": "string"
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_consolidation_cancelled": [
      {
        "id": 42,
        "loan_consolidation_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "loan_consolidation_id": 42
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_originated": [
      {
        "id": 42,
        "loan": {
          "amount_financed": 42,
          "config_name": "string",
          "daily_fee_charge": 42,
          "delinquency_interest_rate": 42.0,
          "due_dates": [
            "2025-05-04T09:42:00Z"
          ],
          "external_id": "string",
          "id": 42,
          "installment_fee_2_charge": 42,
          "installment_fee_charge": 42,
          "installment_fee_type": "string",
          "interest_rate": 42.0,
          "origination_date": "2025-05-04T09:42:00Z",
          "owner": "string"
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "loan_restructured": [
      {
        "id": 42,
        "loan_restructuring": {
          "amortization_method": null,
          "amount_financed": null,
          "config_id": "string",
          "delinquency_interest_rate": null,
          "due_dates": [
            "2025-05-04T09:42:00Z"
          ],
          "effective_date": "2025-05-04T09:42:00Z",
          "external_id": "string",
          "id": 42,
          "installment_fee": null,
          "installment_fee_2": null,
          "interest_rate": null,
          "ledger_mapping": "string",
          "loan_id": 42,
          "manual_pmts": {
            "additionalProperty1": 42,
            "additionalProperty2": 42
          }
        },
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "manual_chargeoff_cancelled": [
      {
        "chargeoff_cancellation": {
          "chargeoff_id": 42,
          "effective_date": "2025-05-04T09:42:00Z"
        },
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "ownership_transferred": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "ownership_transfer": {
          "effective_date": "2025-05-04T09:42:00Z",
          "loan_id": 42,
          "to": "string"
        }
      }
    ],
    "payment_allocated": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "payment_allocation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "loan_allocation": {
            "additionalProperty1": 42,
            "additionalProperty2": 42
          },
          "payment_id": 42
        }
      }
    ],
    "payment_annulled": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "payment_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "payment_id": 42
        }
      }
    ],
    "payment_received": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "payment": {
          "amount_paid": 42,
          "config_name": "string",
          "external_id": "string",
          "id": 42,
          "payment_date": "2025-05-04T09:42:00Z"
        }
      }
    ],
    "positive_balance_adjusted": [
      {
        "balance_adjustment": {
          "effective_date": "2025-05-04T09:42:00Z",
          "value": 42
        },
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z"
      }
    ],
    "positive_balance_reimbursed": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "reimbursement": {
          "effective_date": "2025-05-04T09:42:00Z",
          "external_id": "string",
          "id": 42,
          "value": 42
        }
      }
    ],
    "positive_balance_reimbursement_cancelled": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "reimbursement_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "reimbursement_id": 42
        }
      }
    ],
    "restructuring_cancelled": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "restructuring_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "restructuring_id": 42
        }
      }
    ],
    "waiver_cancelled": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "waiver_cancellation": {
          "effective_date": "2025-05-04T09:42:00Z",
          "waiver_id": 42
        }
      }
    ],
    "waiver_created": [
      {
        "id": 42,
        "occurred_on": "2025-05-04T09:42:00Z",
        "waiver": {
          "amount": null,
          "bucket": "string",
          "config_id": "string",
          "effective_date": "2025-05-04T09:42:00Z",
          "external_id": "string",
          "id": 42,
          "loan_id": 42,
          "percentage": null,
          "reason": "string",
          "type": "string"
        }
      }
    ]
  }
}

Response examples (400)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (404)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (409)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}

Response examples (500)

{
  "code": 42,
  "context": {},
  "error": "string",
  "status": "string"
}