Added user_defined_status to Financial Accounts

Release Date

Jan 20, 2025

Products Affected

Ledger and Financial Accounts

Impact

Customers can add their own status to financial accounts

Audience

Customers using Financial Accounts endpoints

Action Required

None

Overview

Financial Accounts endpoints now have a user_defined_status field. Customers can tag financial accounts with custom statuses to enable their own workflows.

This change does not impact status workflows for status and substatus

Details

An example user_defined_status update can be seen below

Request:

curl --request POST \
     --url https://sandbox.lithic.com/v1/financial_accounts/dd1057be-664c-5e52-9e21-b1a8d83a7aac/update_status \
     --header 'Authorization: 650f3056-4c1e-4302-b1a6-f89f1756c189' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "status": "OPEN",
  "user_defined_status": "TEST"
}
'

Response:

{
  "token": "dd1057be-664c-5e52-9e21-b1a8d83a7aac",
  "created": "2025-06-12T21:51:31Z",
  "updated": "2026-01-21T21:11:18Z",
  "type": "ISSUING",
  "routing_number": "111925676",
  "account_number": "97648584492461",
  "nickname": null,
  "account_token": null,
  "status": "OPEN",
  "substatus": null,
  "user_defined_status": "TEST",
  "is_for_benefit_of": false,
  "credit_configuration": {
    "credit_limit": null,
    "external_bank_account_token": null,
    "credit_product_token": null,
    "tier": null,
    "auto_collection_configuration": {
      "auto_collection_enabled": false
    }
  }
}

The RegEx validation for user_defined_status matches strings that contain only:

Uppercase letters (A-Z)
Numbers (0-9)
Underscores (_)
Spaces ( )

Release Timeline

Available now: January 20, 2025

User Impact

No impact, this change is additive only. Learn more about Statements and Loan Tape APIs via our API Reference

If you have any questions or concerns, please contact us via the HELP link in your Lithic Dashboard.

The Lithic changelog has an RSS feed! To monitor for new update announcements, subscribe with your preferred RSS reader.