# Sunset API

## Docs

- [List POD/TOD beneficiaries](https://api.hellosunset.com/api-reference/account-beneficiaries/list-account-beneficiaries.md): List all POD (Payable on Death) and TOD (Transfer on Death) beneficiary designations.
- [Update beneficiary](https://api.hellosunset.com/api-reference/account-beneficiaries/update-account-beneficiary.md): Update a beneficiary designation.
- [Get authority verification](https://api.hellosunset.com/api-reference/authority/get-authority.md): Retrieve the authority verification details for a case.
- [Set authority verification](https://api.hellosunset.com/api-reference/authority/set-authority.md): Create or replace authority verification.
- [Update authority verification](https://api.hellosunset.com/api-reference/authority/update-authority.md): Partially update authority verification.
- [Get balance history](https://api.hellosunset.com/api-reference/balance-history/get-balance-history.md): Retrieve historical balance snapshots for a bank account.
- [Get bank account details](https://api.hellosunset.com/api-reference/bank-accounts/get-bank-account.md): Retrieve a single bank account with full details.
- [List bank accounts](https://api.hellosunset.com/api-reference/bank-accounts/list-bank-accounts.md): List all bank accounts for a case with optional filtering.
- [Update bank account](https://api.hellosunset.com/api-reference/bank-accounts/update-bank-account.md): Partially update a bank account.
- [Get business details](https://api.hellosunset.com/api-reference/business-ownership/get-business.md)
- [List businesses](https://api.hellosunset.com/api-reference/business-ownership/list-businesses.md)
- [Update business](https://api.hellosunset.com/api-reference/business-ownership/update-business.md)
- [Create a case](https://api.hellosunset.com/api-reference/cases/create-case.md): Create a new estate case.
- [Delete a case](https://api.hellosunset.com/api-reference/cases/delete-case.md): Delete an estate case. This action is irreversible.
- [Get a case](https://api.hellosunset.com/api-reference/cases/get-case.md): Retrieve a single estate case by ID.
- [List cases](https://api.hellosunset.com/api-reference/cases/list-cases.md): Retrieve a paginated list of estate cases with optional filtering.
- [Update a case](https://api.hellosunset.com/api-reference/cases/update-case.md): Partially update an existing case.
- [Get closure status](https://api.hellosunset.com/api-reference/closure/get-closure-status.md): Retrieve the overall closure status and all closure steps for a case. Steps are returned in order with dependency information.
- [Get closure step details](https://api.hellosunset.com/api-reference/closure/get-closure-step.md): Retrieve details of a specific closure step including sub-tasks.
- [Update closure step](https://api.hellosunset.com/api-reference/closure/update-closure-step.md): Update a closure step's status, assignment, due date, or notes.
- [Update a sub-task](https://api.hellosunset.com/api-reference/closure/update-closure-sub-task.md): Update a sub-task (e.g., mark as completed).
- [Get collaborator details](https://api.hellosunset.com/api-reference/collaborators/get-collaborator.md): Retrieve details for a specific collaborator.
- [List collaborators](https://api.hellosunset.com/api-reference/collaborators/list-collaborators.md): List all users who have been invited to or have access to this case.
- [Update collaborator](https://api.hellosunset.com/api-reference/collaborators/update-collaborator.md): Update a collaborator's role or permissions.
- [Get debt details](https://api.hellosunset.com/api-reference/credit-cards-debts/get-debt.md)
- [List auto & vehicle debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-auto-vehicle-debts.md): Returns debts filtered to auto/vehicle types: AUT, AO, AUL, 00, 3A.
- [List banking & deposit debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-banking-debts.md): Returns debts filtered to banking/deposit types: DEP, D/C, RCK, 8B, 43, 77.
- [List business debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-business-debts.md): Returns debts filtered to business types: BUS, BCC, BPG, CIL, CLC, LBP, 10, 8A, 9B, G1, 7A, 1B.
- [List debts in collections](https://api.hellosunset.com/api-reference/credit-cards-debts/list-collections-debts.md): Returns debts filtered to collections types: COL, 48.
- [List cosigned accounts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-cosigned-debts.md): Returns debts filtered to cosigned types: COS, F/C, SC0, NCS, 14, 16, 09, 21.
- [List credit card debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-credit-card-debts.md): Returns debts filtered to credit card types: CRC (Credit card), FSC (Credit card), CHG (Revolving charge account), SCC (Secured credit card), 18 (Credit card), 2A (Secured credit card), 07 (Revolving charge account), 0G (Flexible spending credit card).
- [List debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-debts.md): List all credit cards, loans, and debts for a case.
- [List education debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-education-debts.md): Returns debts filtered to education types: EDU, 12.
- [List government debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-government-debts.md): Returns debts filtered to government types: G/B, G/F, G/G, GEA, GFS, GMD, GOP, SDL, SGL, UDL, UGL, 75, 71, 69, 73, 72, 74, 70, 68, 66, 67, 65.
- [List home equity debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-home-equity-debts.md): Returns debts filtered to home equity types: H/E, HEI, H/I, SHI, 89, 6D, 04, 9A.
- [List household goods debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-household-goods-debts.md): Returns debts filtered to household goods types: H+O, HHG, PHG, REC, 23, 22, 1C, 11.
- [List insurance-related debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-insurance-debts.md): Returns debts filtered to insurance types: INS, LPI, 49, 1A.
- [List lines of credit](https://api.hellosunset.com/api-reference/credit-cards-debts/list-line-of-credit-debts.md)
- [List medical debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-medical-debts.md): Returns debts filtered to medical types: MED, 90.
- [List other debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-other-debts.md): Returns debts filtered to other/miscellaneous types: AGR, CON, DCS, FCO, PPI, SUM, TSL, UNK, ZZZ, 7B, 91, 34, 0C, 83, 30, 0A, 31, ZZ.
- [List personal loan debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-personal-loan-debts.md): Returns debts filtered to personal loan types: I/L, NTE, NCS, SEC, UNS, P/S, ISC, 78, 20, 21, 02, 01, 03, 06.
- [List real estate & mortgage debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-real-estate-debts.md): Returns debts filtered to real estate types: R/C, R/E, R/F, R/O, R/S, R/V, MRI, FHA, FMH, C/M, BMP, SMP, EXM, CSL, M/H, 26, 08, 19, 27, 5B, 25, 86, 05, 2C, 6B, 85, 87, 33, 0F, 17.
- [List support & legal debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-support-legal-debts.md): Returns debts filtered to support/legal types: C/S, F/S, S/S, ATY, 93, 50, 94, 95.
- [List utility & service debts](https://api.hellosunset.com/api-reference/credit-cards-debts/list-utility-service-debts.md)
- [Update debt](https://api.hellosunset.com/api-reference/credit-cards-debts/update-debt.md)
- [Get claim details](https://api.hellosunset.com/api-reference/creditor-claims/get-creditor-claim.md): Retrieve details of a creditor claim.
- [List creditor claims](https://api.hellosunset.com/api-reference/creditor-claims/list-creditor-claims.md): List all creditor claims against an estate.
- [Update claim status](https://api.hellosunset.com/api-reference/creditor-claims/update-creditor-claim.md): Update a creditor claim (e.g., accept, reject, mark as paid).
- [Remove deceased info](https://api.hellosunset.com/api-reference/deceased/delete-deceased.md): Remove the deceased person's information from a case.
- [Get deceased info](https://api.hellosunset.com/api-reference/deceased/get-deceased.md): Retrieve the deceased person's information for a case. SSN is masked in the response.
- [Set deceased info](https://api.hellosunset.com/api-reference/deceased/set-deceased.md): Create or replace the deceased person's information. Full SSN is accepted but will be masked in subsequent GET responses.
- [Update deceased info](https://api.hellosunset.com/api-reference/deceased/update-deceased.md): Partially update the deceased person's information.
- [Get distribution details](https://api.hellosunset.com/api-reference/distributions/get-distribution.md): Retrieve details of a distribution.
- [List distributions](https://api.hellosunset.com/api-reference/distributions/list-distributions.md): List all distributions to beneficiaries for a case.
- [Update distribution](https://api.hellosunset.com/api-reference/distributions/update-distribution.md): Update a distribution record.
- [Delete a document](https://api.hellosunset.com/api-reference/documents/delete-document.md): Delete a document from a case.
- [Download a document](https://api.hellosunset.com/api-reference/documents/download-document.md): Download the document file. Returns binary data with appropriate Content-Type and Content-Disposition headers.
- [Get document metadata](https://api.hellosunset.com/api-reference/documents/get-document.md): Retrieve metadata for a single document.
- [List documents](https://api.hellosunset.com/api-reference/documents/list-documents.md): List all documents for a case.
- [Update document metadata](https://api.hellosunset.com/api-reference/documents/update-document.md): Update document metadata such as type or status.
- [Upload a document](https://api.hellosunset.com/api-reference/documents/upload-document.md): Upload a document file to a case.
- [Get EIN info](https://api.hellosunset.com/api-reference/ein/get-ein.md): Retrieve the Employer Identification Number information for a case.
- [Set EIN info](https://api.hellosunset.com/api-reference/ein/set-ein.md): Create or replace EIN information.
- [Update EIN info](https://api.hellosunset.com/api-reference/ein/update-ein.md): Partially update EIN information.
- [Get email details](https://api.hellosunset.com/api-reference/emails/get-email.md): Retrieve email details including delivery receipt, open tracking, and attachment info.
- [Get email delivery receipt](https://api.hellosunset.com/api-reference/emails/get-email-receipt.md): Retrieve the delivery receipt for an email, including provider status and timestamps.
- [List emails](https://api.hellosunset.com/api-reference/emails/list-emails.md): List all emails sent for a case, including delivery status and receipts.
- [Remove executor info](https://api.hellosunset.com/api-reference/executor/delete-executor.md): Remove the executor's information from a case.
- [Get executor info](https://api.hellosunset.com/api-reference/executor/get-executor.md): Retrieve the executor's information for a case.
- [Set executor info](https://api.hellosunset.com/api-reference/executor/set-executor.md): Create or replace the executor's information.
- [Update executor info](https://api.hellosunset.com/api-reference/executor/update-executor.md): Partially update the executor's information.
- [Get fax details](https://api.hellosunset.com/api-reference/faxes/get-fax.md): Retrieve fax details including delivery receipt with confirmation number and page count.
- [Get fax delivery receipt](https://api.hellosunset.com/api-reference/faxes/get-fax-receipt.md): Retrieve the delivery receipt for a fax including confirmation number, pages sent, and duration.
- [List faxes](https://api.hellosunset.com/api-reference/faxes/list-faxes.md): List all faxes sent for a case, including delivery receipts.
- [Get a financial account](https://api.hellosunset.com/api-reference/financial-accounts/get-financial-account.md): Retrieve a single financial account by ID.
- [List financial accounts](https://api.hellosunset.com/api-reference/financial-accounts/list-financial-accounts.md): List all financial accounts and assets for a case.
- [Update a financial account](https://api.hellosunset.com/api-reference/financial-accounts/update-financial-account.md): Partially update a financial account.
- [Get a goal](https://api.hellosunset.com/api-reference/goals/get-goal.md): Retrieve a single goal.
- [List goals](https://api.hellosunset.com/api-reference/goals/list-goals.md): List all estate management goals for a case.
- [Update a goal](https://api.hellosunset.com/api-reference/goals/update-goal.md): Update a goal's status.
- [Get verification details](https://api.hellosunset.com/api-reference/identity-verification/get-identity-verification.md): Retrieve detailed identity verification results including individual check statuses and any failure reasons.
- [List identity verifications](https://api.hellosunset.com/api-reference/identity-verification/list-identity-verifications.md): List all identity verification checks for the deceased and executor on this case.
- [Update verification](https://api.hellosunset.com/api-reference/identity-verification/update-identity-verification.md): Update verification notes or attach additional documents. Cannot change the verification status directly — status transitions happen automatically based on check results.
- [Get institution contact](https://api.hellosunset.com/api-reference/institution-contacts/get-institution-contact.md): Retrieve a specific institution contact.
- [List institution contacts](https://api.hellosunset.com/api-reference/institution-contacts/list-institution-contacts.md): List all financial institution contact records for a case. Includes department-level contacts with account type routing.
- [Update institution contact](https://api.hellosunset.com/api-reference/institution-contacts/update-institution-contact.md): Update an institution contact's department info, contact methods, or account type routing.
- [Get investment account details](https://api.hellosunset.com/api-reference/investment-accounts/get-investment-account.md)
- [List investment accounts](https://api.hellosunset.com/api-reference/investment-accounts/list-investment-accounts.md)
- [Update investment account](https://api.hellosunset.com/api-reference/investment-accounts/update-investment-account.md)
- [Get policy details](https://api.hellosunset.com/api-reference/life-insurance/get-life-insurance-policy.md)
- [List life insurance policies](https://api.hellosunset.com/api-reference/life-insurance/list-life-insurance-policies.md): List all life insurance policies discovered for a case, including term, whole, universal, group, and government policies.
- [Update policy](https://api.hellosunset.com/api-reference/life-insurance/update-life-insurance-policy.md)
- [Download notarized document](https://api.hellosunset.com/api-reference/notarization/download-notarized-document.md): Download the completed notarized document PDF.
- [Get notarization details](https://api.hellosunset.com/api-reference/notarization/get-notarization.md): Retrieve notarization details including signer status, notary info, and download link for the notarized document.
- [List notarizations](https://api.hellosunset.com/api-reference/notarization/list-notarizations.md): List all notarization requests for a case.
- [Add a person](https://api.hellosunset.com/api-reference/persons/create-person.md): Add an interested person or beneficiary to a case.
- [Delete a person](https://api.hellosunset.com/api-reference/persons/delete-person.md): Remove a person from a case.
- [Get a person](https://api.hellosunset.com/api-reference/persons/get-person.md): Retrieve a single interested person.
- [List interested persons](https://api.hellosunset.com/api-reference/persons/list-persons.md): List all interested persons and beneficiaries for a case.
- [Update a person](https://api.hellosunset.com/api-reference/persons/update-person.md): Partially update a person's information.
- [Get phone call details](https://api.hellosunset.com/api-reference/phone-calls/get-phone-call.md): Retrieve details of a phone call including recording URL, transcript, AI summary, and action items.
- [Download call recording](https://api.hellosunset.com/api-reference/phone-calls/get-phone-call-recording.md): Download the audio recording of a phone call.
- [List phone calls](https://api.hellosunset.com/api-reference/phone-calls/list-phone-calls.md): List all phone calls made for a case, including recordings and AI-generated summaries.
- [Update phone call](https://api.hellosunset.com/api-reference/phone-calls/update-phone-call.md): Update phone call notes or action item completion status.
- [Get current user profile](https://api.hellosunset.com/api-reference/pro-users/get-current-user.md): Retrieve the current user's profile, plan details, and case count.
- [List all cases for current user](https://api.hellosunset.com/api-reference/pro-users/list-user-cases.md): List all estate cases the current user has access to, including cases shared with them by other users. Pro users can manage multiple estates simultaneously.
- [Update current user profile](https://api.hellosunset.com/api-reference/pro-users/update-current-user.md): Update the current user's profile information.
- [Get probate case details](https://api.hellosunset.com/api-reference/probate-case/get-probate-case.md): Retrieve probate case tracking details for an estate case.
- [Set probate case info](https://api.hellosunset.com/api-reference/probate-case/set-probate-case.md): Create or replace probate case tracking information.
- [Update probate case info](https://api.hellosunset.com/api-reference/probate-case/update-probate-case.md): Partially update probate case tracking information.
- [List probate deadlines](https://api.hellosunset.com/api-reference/probate-deadlines/list-probate-deadlines.md): List all probate deadlines and due dates for a case.
- [Update a deadline](https://api.hellosunset.com/api-reference/probate-deadlines/update-probate-deadline.md): Update a deadline (mark complete, reschedule, etc.).
- [Get filing details](https://api.hellosunset.com/api-reference/probate-filings/get-probate-filing.md): Retrieve details of a court filing.
- [List court filings](https://api.hellosunset.com/api-reference/probate-filings/list-probate-filings.md): List all court filings for a case.
- [Update filing](https://api.hellosunset.com/api-reference/probate-filings/update-probate-filing.md): Update a court filing record.
- [Get form details](https://api.hellosunset.com/api-reference/probate-forms/get-probate-form.md): Retrieve details and download link for a probate form.
- [List state probate forms](https://api.hellosunset.com/api-reference/probate-forms/list-probate-forms.md): List all state-level probate forms.
- [Get county probate details](https://api.hellosunset.com/api-reference/probate-reference/get-probate-county.md): Retrieve full probate court details for a county including fees, forms, hours, and filing information.
- [Get state probate details](https://api.hellosunset.com/api-reference/probate-reference/get-probate-state.md): Retrieve comprehensive probate information for a state including laws, thresholds, requirements, tax info, and spousal rights.
- [List counties in a state](https://api.hellosunset.com/api-reference/probate-reference/list-probate-counties.md): List all counties in a state with probate court summaries.
- [List states](https://api.hellosunset.com/api-reference/probate-reference/list-probate-states.md): List all 50 states, DC, and US territories with probate summaries.
- [Get property details](https://api.hellosunset.com/api-reference/real-estate-properties/get-property.md)
- [List properties](https://api.hellosunset.com/api-reference/real-estate-properties/list-properties.md)
- [Update property](https://api.hellosunset.com/api-reference/real-estate-properties/update-property.md)
- [Get valuation details](https://api.hellosunset.com/api-reference/real-estate-valuations/get-real-estate-valuation.md): Retrieve detailed property valuation including comparable sales, tax assessment data, lien information, and equity estimate.
- [List real estate valuations](https://api.hellosunset.com/api-reference/real-estate-valuations/list-real-estate-valuations.md): List all property valuations for a case, including automated AVM results, tax assessments, and appraisal records.
- [Update valuation](https://api.hellosunset.com/api-reference/real-estate-valuations/update-real-estate-valuation.md): Update property details, mortgage balance, or notes on a valuation. The equity estimate is recalculated automatically when mortgage balance changes.
- [List recurring payments](https://api.hellosunset.com/api-reference/recurring-payments/list-recurring-payments.md): List all recurring payments and deposits for a bank account.
- [Update recurring payment](https://api.hellosunset.com/api-reference/recurring-payments/update-recurring-payment.md): Update a recurring payment (e.g., mark as cancelled).
- [Get retirement account details](https://api.hellosunset.com/api-reference/retirement-accounts/get-retirement-account.md)
- [List retirement accounts](https://api.hellosunset.com/api-reference/retirement-accounts/list-retirement-accounts.md)
- [Update retirement account](https://api.hellosunset.com/api-reference/retirement-accounts/update-retirement-account.md)
- [Get a search](https://api.hellosunset.com/api-reference/searches/get-search.md): Retrieve a single search and its status.
- [List searches](https://api.hellosunset.com/api-reference/searches/list-searches.md): List all asset and background searches for a case.
- [Update search status](https://api.hellosunset.com/api-reference/searches/update-search.md): Update the status of a search. Searches cannot be deleted (audit trail).
- [List account signers](https://api.hellosunset.com/api-reference/signers/list-signers.md): List all signers and account holders on a bank account.
- [Update a signer](https://api.hellosunset.com/api-reference/signers/update-signer.md): Update signer information.
- [Download statement PDF](https://api.hellosunset.com/api-reference/statements/download-statement.md): Download the statement file.
- [Get statement metadata](https://api.hellosunset.com/api-reference/statements/get-statement.md): Retrieve metadata for a bank statement.
- [List statements](https://api.hellosunset.com/api-reference/statements/list-statements.md): List available bank statements for an account.
- [Get transaction details](https://api.hellosunset.com/api-reference/transactions/get-transaction.md): Retrieve a single transaction.
- [List transactions](https://api.hellosunset.com/api-reference/transactions/list-transactions.md): List transactions for a bank account with date range and category filters.
- [Update transaction](https://api.hellosunset.com/api-reference/transactions/update-transaction.md): Update transaction notes, categorization, or flagging. Transactions cannot be deleted (audit trail).
- [Get unclaimed property details](https://api.hellosunset.com/api-reference/unclaimed-property/get-unclaimed-property.md)
- [List unclaimed property](https://api.hellosunset.com/api-reference/unclaimed-property/list-unclaimed-property.md)
- [Update unclaimed property](https://api.hellosunset.com/api-reference/unclaimed-property/update-unclaimed-property.md)
- [Get vehicle details](https://api.hellosunset.com/api-reference/vehicles/get-vehicle.md)
- [List vehicles](https://api.hellosunset.com/api-reference/vehicles/list-vehicles.md)
- [Update vehicle](https://api.hellosunset.com/api-reference/vehicles/update-vehicle.md)
- [Bank Accounts Guide](https://api.hellosunset.com/bank-accounts.md): Guide to managing bank accounts, transactions, and related resources.
- [Closure Guide](https://api.hellosunset.com/closure-guide.md): Estate closure steps, status tracking, and institution contact management.
- [Collaboration Guide](https://api.hellosunset.com/collaboration-guide.md): Inviting other users to view and collaborate on estate cases.
- [Credit Cards & Debts Guide](https://api.hellosunset.com/debts-guide.md): Guide to managing credit cards, loans, and debts during estate settlement.
- [Errors](https://api.hellosunset.com/errors.md): Error codes and error handling in the Sunset API.
- [Introduction](https://api.hellosunset.com/introduction.md): Get started with the Sunset API for estate and probate management.
- [Investment Accounts Guide](https://api.hellosunset.com/investments-guide.md): Guide to managing brokerage accounts, stocks, bonds, and other investments during estate settlement.
- [Life Insurance Guide](https://api.hellosunset.com/life-insurance-guide.md): Guide to managing life insurance policies, beneficiaries, and claims during estate settlement.
- [Pagination](https://api.hellosunset.com/pagination.md): How pagination and sorting work in the Sunset API.
- [Pro Users Guide](https://api.hellosunset.com/pro-users-guide.md): Managing multiple estates as a Pro user.
- [Probate Guide](https://api.hellosunset.com/probate-guide.md): Guide to probate reference data and case tracking in the Sunset API.
- [Real Estate Properties Guide](https://api.hellosunset.com/real-estate-guide.md): Guide to managing real estate, title transfers, liens, and property disposition during estate settlement.
- [Request Access](https://api.hellosunset.com/request-access.md): Learn how to get access to the Sunset API.
- [Retirement Accounts Guide](https://api.hellosunset.com/retirement-guide.md): Guide to managing retirement accounts, beneficiary designations, and distributions during estate settlement.
- [Communication Tools Guide](https://api.hellosunset.com/tools-guide.md): Phone calls, email, notarization, and fax tools for estate management.
- [Unclaimed Property Guide](https://api.hellosunset.com/unclaimed-property-guide.md): Guide to searching for and claiming unclaimed property from state databases during estate settlement.
- [Vehicles Guide](https://api.hellosunset.com/vehicles-guide.md): Guide to managing vehicles, title transfers, and disposition during estate settlement.

## OpenAPI Specs

- [openapi](https://api.hellosunset.com/openapi.yaml)