Upcoming Release

Get the history of account status changes for a specific account.

GET /accounts/{account_id}/audit_trails/account_status_changes

Path parameters

Responses

  • 200

    Array of historical Account Status and Account Status Subtypes, and when they occurred.

    Hide response attributes Show response attributes object
    • results array[object] | null

      An array of information for all account status changes within the requested range.

      Not more than 1000 elements.

      Hide results attributes Show results attributes array[object] | null
      • changed_at string(date-time)

        The Date-Time which the account status was changed.

      • account_overview object
        Hide account_overview attributes Show account_overview attributes object
        • account_status string Required

          The Status of the Account. Active upon account creation.

          Values are ACTIVE, SUSPENDED, or CLOSED. Default value is ACTIVE.

        • account_substatus string | null

          The subtype of the Status of the Account. Null upon account creation.

          Values are , INACTIVITY, INELIGIBLE, DELINQUENT, CHARGE_OFF, GRANTOR_REQUEST, BANKRUPTCY, PAID_OFF, CUSTOMER_REQUEST_PENDING_PAYOFF, GRANTOR_REQUEST_PENDING_PAYOFF, DECEASED, RISK_REVIEW, FRAUD, CUSTOMER_REQUEST, or RISK. Default value is empty.

    • Additional properties are allowed
  • 401

    Unauthorized.

  • 403

    Forbidden.

  • 404

    Account not found

  • 429

    Too many requests.

  • default

    Unexpected Error.

GET /accounts/{account_id}/audit_trails/account_status_changes 
curl \
 -X GET https://sandbox-api.canopyservicing.com/accounts/31mNprzLd2bKl6koVna68ARM/audit_trails/account_status_changes \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "results": [
    {
      "changed_at": "2018-06-20T09:12:30+00:00",
      "account_overview": {
        "account_status": "SUSPENDED",
        "account_substatus": "BANKRUPTCY"
      }
    }
  ]
}
Response examples (200) 
{
  "results": [
    {
      "changed_at": "2018-06-20T09:12:30+00:00",
      "account_overview": {
        "account_status": "SUSPENDED",
        "account_substatus": "BANKRUPTCY"
      }
    }
  ]
}