> ## Documentation Index
> Fetch the complete documentation index at: https://api.hellosunset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update bank account

> Partially update a bank account.



## OpenAPI

````yaml PATCH /cases/{case_id}/bank-accounts/{account_id}
openapi: 3.1.0
info:
  title: Sunset API
  description: >
    Estate and probate management platform API. Manage cases, track assets,
    handle bank accounts, and navigate probate proceedings across all US states
    and counties.


    ## Key Features


    - **Full Estate Lifecycle** — Case creation through final asset distribution

    - **Identity Verification** — Verify deceased (SSDI, vital records) and
    executor (government ID, KBA) identity

    - **Real Estate Valuations** — Automated property valuations with comparable
    sales and lien tracking

    - **Communication Tools** — Recorded phone calls, emails, faxes, and online
    notarization

    - **Probate Reference Data** — Requirements for all 50 states, DC, and US
    territories

    - **Multi-Estate Management** — Pro and Enterprise tiers for managing
    multiple cases


    ## API Quality


    - **Idempotency** — `Idempotency-Key` header on all POST endpoints to
    prevent duplicate operations

    - **Rate Limiting** — Tiered rate limits (Pro: 300/min, Enterprise:
    1,000/min)

    - **Conditional Requests** — ETag support with `If-None-Match` and
    `If-Match` headers

    - **Request Tracing** — `X-Request-Id` header on every response

    - **Cursor Pagination** — Optional cursor-based pagination for high-volume
    resources

    - **JSON Merge Patch** — All PATCH endpoints use JSON Merge Patch semantics
    (RFC 7396)
  version: 1.0.0
  contact:
    name: Sunset API Support
servers:
  - url: https://api.example.com/v1
    description: Production
  - url: https://staging-api.example.com/v1
    description: Staging
security: []
tags:
  - name: Cases
    description: Estate/probate case management
  - name: Deceased
    description: Deceased person information
  - name: Executor
    description: Estate executor information
  - name: Authority
    description: Authority verification
  - name: EIN
    description: Employer Identification Number
  - name: Financial Accounts
    description: Estate financial accounts and assets
  - name: Documents
    description: Case document management
  - name: Searches
    description: Asset and background searches
  - name: Persons
    description: Interested persons and beneficiaries
  - name: Goals
    description: Estate management goals
  - name: Bank Accounts
    description: Bank account management
  - name: Signers
    description: Bank account holders and signers
  - name: Transactions
    description: Bank account transactions
  - name: Recurring Payments
    description: Recurring payments and deposits
  - name: Account Beneficiaries
    description: POD/TOD beneficiary designations
  - name: Statements
    description: Bank account statements
  - name: Balance History
    description: Historical balance snapshots
  - name: Probate Reference
    description: State and county probate reference data
  - name: Probate Forms
    description: State-level probate forms
  - name: Probate Case
    description: Case-level probate tracking
  - name: Probate Deadlines
    description: Probate deadlines and due dates
  - name: Probate Filings
    description: Court filings
  - name: Creditor Claims
    description: Creditor claims against the estate
  - name: Distributions
    description: Beneficiary distributions
  - name: Pro Users
    description: Pro user multi-estate management
  - name: Collaborators
    description: Multi-user collaboration and estate sharing
  - name: Closure
    description: Estate closure steps and status tracking
  - name: Institution Contacts
    description: Financial institution contact information and departments
  - name: Phone Calls
    description: Twilio-powered phone calls with recording and summarization
  - name: Emails
    description: Email tool for sending forms and attachments
  - name: Notarization
    description: DocuSign-powered online notarization
  - name: Faxes
    description: One-click fax sending with receipts
  - name: Identity Verification
    description: Verify deceased and executor identity
  - name: Real Estate Valuations
    description: Automated property valuations and tax assessments
  - name: Life Insurance
    description: Life insurance policies and claims
  - name: Credit Cards & Debts
    description: Credit cards, loans, and debt management
  - name: Retirement Accounts
    description: 401(k), IRA, pension, and retirement account management
  - name: Investment Accounts
    description: Brokerage, stocks, bonds, and investment accounts
  - name: Real Estate Properties
    description: Real estate ownership, titles, and property management
  - name: Unclaimed Property
    description: Unclaimed property search and claims
  - name: Vehicles
    description: Vehicles, boats, and titled property
  - name: Business Ownership
    description: Business entities, ownership interests, and succession
paths:
  /cases/{case_id}/bank-accounts/{account_id}:
    parameters:
      - $ref: '#/components/parameters/CaseId'
      - name: account_id
        in: path
        required: true
        schema:
          type: string
        description: Bank account identifier.
    patch:
      tags:
        - Bank Accounts
      summary: Update bank account
      description: Partially update a bank account.
      operationId: updateBankAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankAccountWrite'
      responses:
        '200':
          description: Bank account updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BankAccount'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  parameters:
    CaseId:
      name: case_id
      in: path
      required: true
      schema:
        type: string
      description: Unique case identifier (ULID format).
      example: 01K5WF06MJ6T99HRYE78AN7XM8
  schemas:
    BankAccountWrite:
      type: object
      required:
        - institution_name
        - account_type
      properties:
        institution_name:
          type: string
        institution_routing_number:
          type: string
        account_type:
          type: string
          enum:
            - checking
            - savings
            - cd
            - money_market
            - hsa
            - trust_account
            - estate_account
            - joint_account
        account_number:
          type: string
          description: Full account number.
        account_title:
          type: string
        ownership_type:
          type: string
          enum:
            - individual
            - joint_tenants_wros
            - tenants_in_common
            - pod_payable_on_death
            - tod_transfer_on_death
            - trust
            - estate
        status:
          type: string
          enum:
            - open
            - closed
            - frozen
            - dormant
            - pending_closure
            - restricted
        current_balance:
          type: number
          format: double
        available_balance:
          type: number
          format: double
        currency:
          type: string
        interest_rate:
          type: number
          format: double
        maturity_date:
          type: string
          format: date
        opened_date:
          type: string
          format: date
        closed_date:
          type: string
          format: date
        branch_name:
          type: string
        branch_address:
          $ref: '#/components/schemas/Address'
        branch_phone:
          type: string
        online_access:
          type: boolean
        has_overdraft_protection:
          type: boolean
        is_estate_account:
          type: boolean
        closure_method:
          type: string
          enum:
            - transfer_to_estate
            - check_mailed
            - transfer_to_beneficiary
            - pending
        notes:
          type: string
    BankAccount:
      type: object
      properties:
        id:
          type: string
          example: 01K6BA01AJ9T66HRYE78AN7PQR
        institution_name:
          type: string
          example: Chase Bank
        institution_routing_number:
          type:
            - string
            - 'null'
          example: '021000021'
        account_type:
          type: string
          enum:
            - checking
            - savings
            - cd
            - money_market
            - hsa
            - trust_account
            - estate_account
            - joint_account
          example: checking
        account_number:
          type: string
          description: Masked in responses (last 4 digits only).
          example: '***5678'
        account_title:
          type:
            - string
            - 'null'
          example: John Johnson Living Trust Checking
        ownership_type:
          type: string
          enum:
            - individual
            - joint_tenants_wros
            - tenants_in_common
            - pod_payable_on_death
            - tod_transfer_on_death
            - trust
            - estate
          example: individual
        status:
          type: string
          enum:
            - open
            - closed
            - frozen
            - dormant
            - pending_closure
            - restricted
          example: open
        current_balance:
          type:
            - number
            - 'null'
          format: double
          example: 15230.5
        available_balance:
          type:
            - number
            - 'null'
          format: double
          example: 14980.25
        currency:
          type: string
          default: USD
          example: USD
        interest_rate:
          type:
            - number
            - 'null'
          format: double
          description: >-
            Annual interest rate as a percentage. Relevant for savings, CDs,
            money market.
          example: 4.25
        maturity_date:
          type:
            - string
            - 'null'
          format: date
          description: Maturity date for CDs.
          example: '2026-06-15'
        opened_date:
          type:
            - string
            - 'null'
          format: date
          example: '2010-03-20'
        closed_date:
          type:
            - string
            - 'null'
          format: date
        branch_name:
          type:
            - string
            - 'null'
          example: Springfield Main Branch
        branch_address:
          $ref: '#/components/schemas/Address'
        branch_phone:
          type:
            - string
            - 'null'
          example: '+11112223333'
        online_access:
          type: boolean
          example: true
        has_overdraft_protection:
          type: boolean
          example: false
        is_estate_account:
          type: boolean
          description: Whether this account was opened specifically for the estate.
          example: false
        closure_method:
          type:
            - string
            - 'null'
          enum:
            - transfer_to_estate
            - check_mailed
            - transfer_to_beneficiary
            - pending
            - null
          example: null
        notes:
          type:
            - string
            - 'null'
          example: Need to visit branch with Letters Testamentary
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    Address:
      type: object
      properties:
        address1:
          type: string
          example: 123 Main Street
        address2:
          type:
            - string
            - 'null'
          example: null
        city:
          type: string
          example: Salt Lake City
        state:
          type: string
          minLength: 2
          maxLength: 2
          example: UT
        zip:
          type: string
          pattern: ^\d{5}(-\d{4})?$
          example: '84101'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: validation_error
            message:
              type: string
              example: The request body contains invalid fields.
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                  message:
                    type: string
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: not_found
              message: The requested resource was not found.
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: validation_error
              message: The request body contains invalid fields.
              details:
                - field: email
                  message: Must be a valid email address.

````