# List POD/TOD beneficiaries Source: https://api.hellosunset.com/api-reference/account-beneficiaries/list-account-beneficiaries GET /cases/{case_id}/bank-accounts/{account_id}/beneficiaries List all POD (Payable on Death) and TOD (Transfer on Death) beneficiary designations. # Update beneficiary Source: https://api.hellosunset.com/api-reference/account-beneficiaries/update-account-beneficiary PATCH /cases/{case_id}/bank-accounts/{account_id}/beneficiaries/{beneficiary_id} Update a beneficiary designation. # Get authority verification Source: https://api.hellosunset.com/api-reference/authority/get-authority GET /cases/{case_id}/authority Retrieve the authority verification details for a case. # Set authority verification Source: https://api.hellosunset.com/api-reference/authority/set-authority PUT /cases/{case_id}/authority Create or replace authority verification. # Update authority verification Source: https://api.hellosunset.com/api-reference/authority/update-authority PATCH /cases/{case_id}/authority Partially update authority verification. # Get balance history Source: https://api.hellosunset.com/api-reference/balance-history/get-balance-history GET /cases/{case_id}/bank-accounts/{account_id}/balance-history Retrieve historical balance snapshots for a bank account. # Get bank account details Source: https://api.hellosunset.com/api-reference/bank-accounts/get-bank-account GET /cases/{case_id}/bank-accounts/{account_id} Retrieve a single bank account with full details. # List bank accounts Source: https://api.hellosunset.com/api-reference/bank-accounts/list-bank-accounts GET /cases/{case_id}/bank-accounts List all bank accounts for a case with optional filtering. # Update bank account Source: https://api.hellosunset.com/api-reference/bank-accounts/update-bank-account PATCH /cases/{case_id}/bank-accounts/{account_id} Partially update a bank account. # Get business details Source: https://api.hellosunset.com/api-reference/business-ownership/get-business GET /cases/{case_id}/businesses/{business_id} # List businesses Source: https://api.hellosunset.com/api-reference/business-ownership/list-businesses GET /cases/{case_id}/businesses # Update business Source: https://api.hellosunset.com/api-reference/business-ownership/update-business PATCH /cases/{case_id}/businesses/{business_id} # Create a case Source: https://api.hellosunset.com/api-reference/cases/create-case POST /cases Create a new estate case. # Delete a case Source: https://api.hellosunset.com/api-reference/cases/delete-case DELETE /cases/{case_id} Delete an estate case. This action is irreversible. # Get a case Source: https://api.hellosunset.com/api-reference/cases/get-case GET /cases/{case_id} Retrieve a single estate case by ID. # List cases Source: https://api.hellosunset.com/api-reference/cases/list-cases GET /cases Retrieve a paginated list of estate cases with optional filtering. # Update a case Source: https://api.hellosunset.com/api-reference/cases/update-case PATCH /cases/{case_id} Partially update an existing case. # Get closure status Source: https://api.hellosunset.com/api-reference/closure/get-closure-status GET /cases/{case_id}/closure Retrieve the overall closure status and all closure steps for a case. Steps are returned in order with dependency information. # Get closure step details Source: https://api.hellosunset.com/api-reference/closure/get-closure-step GET /cases/{case_id}/closure/steps/{step_id} Retrieve details of a specific closure step including sub-tasks. # Update closure step Source: https://api.hellosunset.com/api-reference/closure/update-closure-step PATCH /cases/{case_id}/closure/steps/{step_id} Update a closure step's status, assignment, due date, or notes. # Update a sub-task Source: https://api.hellosunset.com/api-reference/closure/update-closure-sub-task PATCH /cases/{case_id}/closure/steps/{step_id}/sub-tasks/{sub_task_id} Update a sub-task (e.g., mark as completed). # Get collaborator details Source: https://api.hellosunset.com/api-reference/collaborators/get-collaborator GET /cases/{case_id}/collaborators/{collaborator_id} Retrieve details for a specific collaborator. # List collaborators Source: https://api.hellosunset.com/api-reference/collaborators/list-collaborators GET /cases/{case_id}/collaborators List all users who have been invited to or have access to this case. # Update collaborator Source: https://api.hellosunset.com/api-reference/collaborators/update-collaborator PATCH /cases/{case_id}/collaborators/{collaborator_id} Update a collaborator's role or permissions. # Get debt details Source: https://api.hellosunset.com/api-reference/credit-cards-debts/get-debt GET /cases/{case_id}/debts/{debt_id} # List auto & vehicle debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-auto-vehicle-debts GET /cases/{case_id}/debts/type/auto-vehicle Returns debts filtered to auto/vehicle types: AUT, AO, AUL, 00, 3A. # List banking & deposit debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-banking-debts GET /cases/{case_id}/debts/type/banking Returns debts filtered to banking/deposit types: DEP, D/C, RCK, 8B, 43, 77. # List business debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-business-debts GET /cases/{case_id}/debts/type/business Returns debts filtered to business types: BUS, BCC, BPG, CIL, CLC, LBP, 10, 8A, 9B, G1, 7A, 1B. # List debts in collections Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-collections-debts GET /cases/{case_id}/debts/type/collections Returns debts filtered to collections types: COL, 48. # List cosigned accounts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-cosigned-debts GET /cases/{case_id}/debts/type/cosigned Returns debts filtered to cosigned types: COS, F/C, SC0, NCS, 14, 16, 09, 21. # List credit card debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-credit-card-debts GET /cases/{case_id}/debts/type/credit-cards 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 Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-debts GET /cases/{case_id}/debts List all credit cards, loans, and debts for a case. # List education debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-education-debts GET /cases/{case_id}/debts/type/education Returns debts filtered to education types: EDU, 12. # List government debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-government-debts GET /cases/{case_id}/debts/type/government 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 Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-home-equity-debts GET /cases/{case_id}/debts/type/home-equity Returns debts filtered to home equity types: H/E, HEI, H/I, SHI, 89, 6D, 04, 9A. # List household goods debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-household-goods-debts GET /cases/{case_id}/debts/type/household-goods Returns debts filtered to household goods types: H+O, HHG, PHG, REC, 23, 22, 1C, 11. # List insurance-related debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-insurance-debts GET /cases/{case_id}/debts/type/insurance Returns debts filtered to insurance types: INS, LPI, 49, 1A. # List lines of credit Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-line-of-credit-debts GET /cases/{case_id}/debts/type/lines-of-credit # List medical debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-medical-debts GET /cases/{case_id}/debts/type/medical Returns debts filtered to medical types: MED, 90. # List other debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-other-debts GET /cases/{case_id}/debts/type/other 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 Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-personal-loan-debts GET /cases/{case_id}/debts/type/personal-loans 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 Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-real-estate-debts GET /cases/{case_id}/debts/type/real-estate 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 Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-support-legal-debts GET /cases/{case_id}/debts/type/support-legal Returns debts filtered to support/legal types: C/S, F/S, S/S, ATY, 93, 50, 94, 95. # List utility & service debts Source: https://api.hellosunset.com/api-reference/credit-cards-debts/list-utility-service-debts GET /cases/{case_id}/debts/type/utilities-services # Update debt Source: https://api.hellosunset.com/api-reference/credit-cards-debts/update-debt PATCH /cases/{case_id}/debts/{debt_id} # Get claim details Source: https://api.hellosunset.com/api-reference/creditor-claims/get-creditor-claim GET /cases/{case_id}/probate/creditor-claims/{claim_id} Retrieve details of a creditor claim. # List creditor claims Source: https://api.hellosunset.com/api-reference/creditor-claims/list-creditor-claims GET /cases/{case_id}/probate/creditor-claims List all creditor claims against an estate. # Update claim status Source: https://api.hellosunset.com/api-reference/creditor-claims/update-creditor-claim PATCH /cases/{case_id}/probate/creditor-claims/{claim_id} Update a creditor claim (e.g., accept, reject, mark as paid). # Remove deceased info Source: https://api.hellosunset.com/api-reference/deceased/delete-deceased DELETE /cases/{case_id}/deceased Remove the deceased person's information from a case. # Get deceased info Source: https://api.hellosunset.com/api-reference/deceased/get-deceased GET /cases/{case_id}/deceased Retrieve the deceased person's information for a case. SSN is masked in the response. # Set deceased info Source: https://api.hellosunset.com/api-reference/deceased/set-deceased PUT /cases/{case_id}/deceased Create or replace the deceased person's information. Full SSN is accepted but will be masked in subsequent GET responses. # Update deceased info Source: https://api.hellosunset.com/api-reference/deceased/update-deceased PATCH /cases/{case_id}/deceased Partially update the deceased person's information. # Get distribution details Source: https://api.hellosunset.com/api-reference/distributions/get-distribution GET /cases/{case_id}/probate/distributions/{distribution_id} Retrieve details of a distribution. # List distributions Source: https://api.hellosunset.com/api-reference/distributions/list-distributions GET /cases/{case_id}/probate/distributions List all distributions to beneficiaries for a case. # Update distribution Source: https://api.hellosunset.com/api-reference/distributions/update-distribution PATCH /cases/{case_id}/probate/distributions/{distribution_id} Update a distribution record. # Delete a document Source: https://api.hellosunset.com/api-reference/documents/delete-document DELETE /cases/{case_id}/documents/{document_id} Delete a document from a case. # Download a document Source: https://api.hellosunset.com/api-reference/documents/download-document GET /cases/{case_id}/documents/{document_id}/download Download the document file. Returns binary data with appropriate Content-Type and Content-Disposition headers. # Get document metadata Source: https://api.hellosunset.com/api-reference/documents/get-document GET /cases/{case_id}/documents/{document_id} Retrieve metadata for a single document. # List documents Source: https://api.hellosunset.com/api-reference/documents/list-documents GET /cases/{case_id}/documents List all documents for a case. # Update document metadata Source: https://api.hellosunset.com/api-reference/documents/update-document PATCH /cases/{case_id}/documents/{document_id} Update document metadata such as type or status. # Upload a document Source: https://api.hellosunset.com/api-reference/documents/upload-document POST /cases/{case_id}/documents Upload a document file to a case. # Get EIN info Source: https://api.hellosunset.com/api-reference/ein/get-ein GET /cases/{case_id}/ein Retrieve the Employer Identification Number information for a case. # Set EIN info Source: https://api.hellosunset.com/api-reference/ein/set-ein PUT /cases/{case_id}/ein Create or replace EIN information. # Update EIN info Source: https://api.hellosunset.com/api-reference/ein/update-ein PATCH /cases/{case_id}/ein Partially update EIN information. # Get email details Source: https://api.hellosunset.com/api-reference/emails/get-email GET /cases/{case_id}/emails/{email_id} Retrieve email details including delivery receipt, open tracking, and attachment info. # Get email delivery receipt Source: https://api.hellosunset.com/api-reference/emails/get-email-receipt GET /cases/{case_id}/emails/{email_id}/receipt Retrieve the delivery receipt for an email, including provider status and timestamps. # List emails Source: https://api.hellosunset.com/api-reference/emails/list-emails GET /cases/{case_id}/emails List all emails sent for a case, including delivery status and receipts. # Remove executor info Source: https://api.hellosunset.com/api-reference/executor/delete-executor DELETE /cases/{case_id}/executor Remove the executor's information from a case. # Get executor info Source: https://api.hellosunset.com/api-reference/executor/get-executor GET /cases/{case_id}/executor Retrieve the executor's information for a case. # Set executor info Source: https://api.hellosunset.com/api-reference/executor/set-executor PUT /cases/{case_id}/executor Create or replace the executor's information. # Update executor info Source: https://api.hellosunset.com/api-reference/executor/update-executor PATCH /cases/{case_id}/executor Partially update the executor's information. # Get fax details Source: https://api.hellosunset.com/api-reference/faxes/get-fax GET /cases/{case_id}/faxes/{fax_id} Retrieve fax details including delivery receipt with confirmation number and page count. # Get fax delivery receipt Source: https://api.hellosunset.com/api-reference/faxes/get-fax-receipt GET /cases/{case_id}/faxes/{fax_id}/receipt Retrieve the delivery receipt for a fax including confirmation number, pages sent, and duration. # List faxes Source: https://api.hellosunset.com/api-reference/faxes/list-faxes GET /cases/{case_id}/faxes List all faxes sent for a case, including delivery receipts. # Get a financial account Source: https://api.hellosunset.com/api-reference/financial-accounts/get-financial-account GET /cases/{case_id}/financial-accounts/{account_id} Retrieve a single financial account by ID. # List financial accounts Source: https://api.hellosunset.com/api-reference/financial-accounts/list-financial-accounts GET /cases/{case_id}/financial-accounts List all financial accounts and assets for a case. # Update a financial account Source: https://api.hellosunset.com/api-reference/financial-accounts/update-financial-account PATCH /cases/{case_id}/financial-accounts/{account_id} Partially update a financial account. # Get a goal Source: https://api.hellosunset.com/api-reference/goals/get-goal GET /cases/{case_id}/goals/{goal_id} Retrieve a single goal. # List goals Source: https://api.hellosunset.com/api-reference/goals/list-goals GET /cases/{case_id}/goals List all estate management goals for a case. # Update a goal Source: https://api.hellosunset.com/api-reference/goals/update-goal PATCH /cases/{case_id}/goals/{goal_id} Update a goal's status. # Get verification details Source: https://api.hellosunset.com/api-reference/identity-verification/get-identity-verification GET /cases/{case_id}/identity-verifications/{verification_id} Retrieve detailed identity verification results including individual check statuses and any failure reasons. # List identity verifications Source: https://api.hellosunset.com/api-reference/identity-verification/list-identity-verifications GET /cases/{case_id}/identity-verifications List all identity verification checks for the deceased and executor on this case. # Update verification Source: https://api.hellosunset.com/api-reference/identity-verification/update-identity-verification PATCH /cases/{case_id}/identity-verifications/{verification_id} Update verification notes or attach additional documents. Cannot change the verification status directly — status transitions happen automatically based on check results. # Get institution contact Source: https://api.hellosunset.com/api-reference/institution-contacts/get-institution-contact GET /cases/{case_id}/institution-contacts/{contact_id} Retrieve a specific institution contact. # List institution contacts Source: https://api.hellosunset.com/api-reference/institution-contacts/list-institution-contacts GET /cases/{case_id}/institution-contacts List all financial institution contact records for a case. Includes department-level contacts with account type routing. # Update institution contact Source: https://api.hellosunset.com/api-reference/institution-contacts/update-institution-contact PATCH /cases/{case_id}/institution-contacts/{contact_id} Update an institution contact's department info, contact methods, or account type routing. # Get investment account details Source: https://api.hellosunset.com/api-reference/investment-accounts/get-investment-account GET /cases/{case_id}/investment-accounts/{account_id} # List investment accounts Source: https://api.hellosunset.com/api-reference/investment-accounts/list-investment-accounts GET /cases/{case_id}/investment-accounts # Update investment account Source: https://api.hellosunset.com/api-reference/investment-accounts/update-investment-account PATCH /cases/{case_id}/investment-accounts/{account_id} # Get policy details Source: https://api.hellosunset.com/api-reference/life-insurance/get-life-insurance-policy GET /cases/{case_id}/life-insurance/{policy_id} # List life insurance policies Source: https://api.hellosunset.com/api-reference/life-insurance/list-life-insurance-policies GET /cases/{case_id}/life-insurance List all life insurance policies discovered for a case, including term, whole, universal, group, and government policies. # Update policy Source: https://api.hellosunset.com/api-reference/life-insurance/update-life-insurance-policy PATCH /cases/{case_id}/life-insurance/{policy_id} # Download notarized document Source: https://api.hellosunset.com/api-reference/notarization/download-notarized-document GET /cases/{case_id}/notarizations/{notarization_id}/download Download the completed notarized document PDF. # Get notarization details Source: https://api.hellosunset.com/api-reference/notarization/get-notarization GET /cases/{case_id}/notarizations/{notarization_id} Retrieve notarization details including signer status, notary info, and download link for the notarized document. # List notarizations Source: https://api.hellosunset.com/api-reference/notarization/list-notarizations GET /cases/{case_id}/notarizations List all notarization requests for a case. # Add a person Source: https://api.hellosunset.com/api-reference/persons/create-person POST /cases/{case_id}/persons Add an interested person or beneficiary to a case. # Delete a person Source: https://api.hellosunset.com/api-reference/persons/delete-person DELETE /cases/{case_id}/persons/{person_id} Remove a person from a case. # Get a person Source: https://api.hellosunset.com/api-reference/persons/get-person GET /cases/{case_id}/persons/{person_id} Retrieve a single interested person. # List interested persons Source: https://api.hellosunset.com/api-reference/persons/list-persons GET /cases/{case_id}/persons List all interested persons and beneficiaries for a case. # Update a person Source: https://api.hellosunset.com/api-reference/persons/update-person PATCH /cases/{case_id}/persons/{person_id} Partially update a person's information. # Get phone call details Source: https://api.hellosunset.com/api-reference/phone-calls/get-phone-call GET /cases/{case_id}/phone-calls/{call_id} Retrieve details of a phone call including recording URL, transcript, AI summary, and action items. # Download call recording Source: https://api.hellosunset.com/api-reference/phone-calls/get-phone-call-recording GET /cases/{case_id}/phone-calls/{call_id}/recording Download the audio recording of a phone call. # List phone calls Source: https://api.hellosunset.com/api-reference/phone-calls/list-phone-calls GET /cases/{case_id}/phone-calls List all phone calls made for a case, including recordings and AI-generated summaries. # Update phone call Source: https://api.hellosunset.com/api-reference/phone-calls/update-phone-call PATCH /cases/{case_id}/phone-calls/{call_id} Update phone call notes or action item completion status. # Get current user profile Source: https://api.hellosunset.com/api-reference/pro-users/get-current-user GET /users/me Retrieve the current user's profile, plan details, and case count. # List all cases for current user Source: https://api.hellosunset.com/api-reference/pro-users/list-user-cases GET /users/me/cases 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 Source: https://api.hellosunset.com/api-reference/pro-users/update-current-user PATCH /users/me Update the current user's profile information. # Get probate case details Source: https://api.hellosunset.com/api-reference/probate-case/get-probate-case GET /cases/{case_id}/probate Retrieve probate case tracking details for an estate case. # Set probate case info Source: https://api.hellosunset.com/api-reference/probate-case/set-probate-case PUT /cases/{case_id}/probate Create or replace probate case tracking information. # Update probate case info Source: https://api.hellosunset.com/api-reference/probate-case/update-probate-case PATCH /cases/{case_id}/probate Partially update probate case tracking information. # List probate deadlines Source: https://api.hellosunset.com/api-reference/probate-deadlines/list-probate-deadlines GET /cases/{case_id}/probate/deadlines List all probate deadlines and due dates for a case. # Update a deadline Source: https://api.hellosunset.com/api-reference/probate-deadlines/update-probate-deadline PATCH /cases/{case_id}/probate/deadlines/{deadline_id} Update a deadline (mark complete, reschedule, etc.). # Get filing details Source: https://api.hellosunset.com/api-reference/probate-filings/get-probate-filing GET /cases/{case_id}/probate/filings/{filing_id} Retrieve details of a court filing. # List court filings Source: https://api.hellosunset.com/api-reference/probate-filings/list-probate-filings GET /cases/{case_id}/probate/filings List all court filings for a case. # Update filing Source: https://api.hellosunset.com/api-reference/probate-filings/update-probate-filing PATCH /cases/{case_id}/probate/filings/{filing_id} Update a court filing record. # Get form details Source: https://api.hellosunset.com/api-reference/probate-forms/get-probate-form GET /probate/states/{state_code}/forms/{form_id} Retrieve details and download link for a probate form. # List state probate forms Source: https://api.hellosunset.com/api-reference/probate-forms/list-probate-forms GET /probate/states/{state_code}/forms List all state-level probate forms. # Get county probate details Source: https://api.hellosunset.com/api-reference/probate-reference/get-probate-county GET /probate/states/{state_code}/counties/{county_slug} Retrieve full probate court details for a county including fees, forms, hours, and filing information. # Get state probate details Source: https://api.hellosunset.com/api-reference/probate-reference/get-probate-state GET /probate/states/{state_code} Retrieve comprehensive probate information for a state including laws, thresholds, requirements, tax info, and spousal rights. # List counties in a state Source: https://api.hellosunset.com/api-reference/probate-reference/list-probate-counties GET /probate/states/{state_code}/counties List all counties in a state with probate court summaries. # List states Source: https://api.hellosunset.com/api-reference/probate-reference/list-probate-states GET /probate/states List all 50 states, DC, and US territories with probate summaries. # Get property details Source: https://api.hellosunset.com/api-reference/real-estate-properties/get-property GET /cases/{case_id}/properties/{property_id} # List properties Source: https://api.hellosunset.com/api-reference/real-estate-properties/list-properties GET /cases/{case_id}/properties # Update property Source: https://api.hellosunset.com/api-reference/real-estate-properties/update-property PATCH /cases/{case_id}/properties/{property_id} # Get valuation details Source: https://api.hellosunset.com/api-reference/real-estate-valuations/get-real-estate-valuation GET /cases/{case_id}/real-estate-valuations/{valuation_id} Retrieve detailed property valuation including comparable sales, tax assessment data, lien information, and equity estimate. # List real estate valuations Source: https://api.hellosunset.com/api-reference/real-estate-valuations/list-real-estate-valuations GET /cases/{case_id}/real-estate-valuations List all property valuations for a case, including automated AVM results, tax assessments, and appraisal records. # Update valuation Source: https://api.hellosunset.com/api-reference/real-estate-valuations/update-real-estate-valuation PATCH /cases/{case_id}/real-estate-valuations/{valuation_id} Update property details, mortgage balance, or notes on a valuation. The equity estimate is recalculated automatically when mortgage balance changes. # List recurring payments Source: https://api.hellosunset.com/api-reference/recurring-payments/list-recurring-payments GET /cases/{case_id}/bank-accounts/{account_id}/recurring-payments List all recurring payments and deposits for a bank account. # Update recurring payment Source: https://api.hellosunset.com/api-reference/recurring-payments/update-recurring-payment PATCH /cases/{case_id}/bank-accounts/{account_id}/recurring-payments/{payment_id} Update a recurring payment (e.g., mark as cancelled). # Get retirement account details Source: https://api.hellosunset.com/api-reference/retirement-accounts/get-retirement-account GET /cases/{case_id}/retirement-accounts/{account_id} # List retirement accounts Source: https://api.hellosunset.com/api-reference/retirement-accounts/list-retirement-accounts GET /cases/{case_id}/retirement-accounts # Update retirement account Source: https://api.hellosunset.com/api-reference/retirement-accounts/update-retirement-account PATCH /cases/{case_id}/retirement-accounts/{account_id} # Get a search Source: https://api.hellosunset.com/api-reference/searches/get-search GET /cases/{case_id}/searches/{search_id} Retrieve a single search and its status. # List searches Source: https://api.hellosunset.com/api-reference/searches/list-searches GET /cases/{case_id}/searches List all asset and background searches for a case. # Update search status Source: https://api.hellosunset.com/api-reference/searches/update-search PATCH /cases/{case_id}/searches/{search_id} Update the status of a search. Searches cannot be deleted (audit trail). # List account signers Source: https://api.hellosunset.com/api-reference/signers/list-signers GET /cases/{case_id}/bank-accounts/{account_id}/signers List all signers and account holders on a bank account. # Update a signer Source: https://api.hellosunset.com/api-reference/signers/update-signer PATCH /cases/{case_id}/bank-accounts/{account_id}/signers/{signer_id} Update signer information. # Download statement PDF Source: https://api.hellosunset.com/api-reference/statements/download-statement GET /cases/{case_id}/bank-accounts/{account_id}/statements/{statement_id}/download Download the statement file. # Get statement metadata Source: https://api.hellosunset.com/api-reference/statements/get-statement GET /cases/{case_id}/bank-accounts/{account_id}/statements/{statement_id} Retrieve metadata for a bank statement. # List statements Source: https://api.hellosunset.com/api-reference/statements/list-statements GET /cases/{case_id}/bank-accounts/{account_id}/statements List available bank statements for an account. # Get transaction details Source: https://api.hellosunset.com/api-reference/transactions/get-transaction GET /cases/{case_id}/bank-accounts/{account_id}/transactions/{transaction_id} Retrieve a single transaction. # List transactions Source: https://api.hellosunset.com/api-reference/transactions/list-transactions GET /cases/{case_id}/bank-accounts/{account_id}/transactions List transactions for a bank account with date range and category filters. # Update transaction Source: https://api.hellosunset.com/api-reference/transactions/update-transaction PATCH /cases/{case_id}/bank-accounts/{account_id}/transactions/{transaction_id} Update transaction notes, categorization, or flagging. Transactions cannot be deleted (audit trail). # Cancel a transfer Source: https://api.hellosunset.com/api-reference/transfers/cancel-transfer POST /cases/{case_id}/transfers/{transfer_id}/cancel Cancel a transfer that has not yet been submitted to the ACH network. Transfers in `requested`, `verifying`, or `approved` may be cancelled; once the status is `submitted` the transfer can no longer be stopped. Transfers are not deleted. A cancelled transfer stays on the case for audit purposes. # Request a transfer Source: https://api.hellosunset.com/api-reference/transfers/create-transfer POST /cases/{case_id}/transfers Request an Instant Inheritance transfer from an eligible bank account into the case's estate account. The bank account must already be `eligible` — read the `instant_inheritance` summary on the bank account first. Requesting a transfer on an account that is not eligible returns `422`. Only one transfer may be in flight per bank account. Send an `Idempotency-Key` header so a retried request never moves money twice. # Get a transfer Source: https://api.hellosunset.com/api-reference/transfers/get-transfer GET /cases/{case_id}/transfers/{transfer_id} Retrieve a single transfer and its current status. # List transfers Source: https://api.hellosunset.com/api-reference/transfers/list-transfers GET /cases/{case_id}/transfers List every Instant Inheritance transfer on a case, newest first. # Get unclaimed property details Source: https://api.hellosunset.com/api-reference/unclaimed-property/get-unclaimed-property GET /cases/{case_id}/unclaimed-property/{property_id} # List unclaimed property Source: https://api.hellosunset.com/api-reference/unclaimed-property/list-unclaimed-property GET /cases/{case_id}/unclaimed-property # Update unclaimed property Source: https://api.hellosunset.com/api-reference/unclaimed-property/update-unclaimed-property PATCH /cases/{case_id}/unclaimed-property/{property_id} # Get vehicle details Source: https://api.hellosunset.com/api-reference/vehicles/get-vehicle GET /cases/{case_id}/vehicles/{vehicle_id} # List vehicles Source: https://api.hellosunset.com/api-reference/vehicles/list-vehicles GET /cases/{case_id}/vehicles # Update vehicle Source: https://api.hellosunset.com/api-reference/vehicles/update-vehicle PATCH /cases/{case_id}/vehicles/{vehicle_id} # Bank Accounts Guide Source: https://api.hellosunset.com/bank-accounts Guide to managing bank accounts, transactions, and related resources. # Bank Accounts Guide The Sunset API provides comprehensive bank account management for estate cases. This guide covers the typical workflows for managing deceased bank accounts during estate settlement. ## Resource Hierarchy Bank accounts are nested under cases and have several sub-resources: ``` /cases/{case_id}/bank-accounts/{account_id} /signers - Account holders and authorized signers /transactions - Transaction history /recurring-payments - Autopay, subscriptions, direct deposits /beneficiaries - POD/TOD beneficiary designations /statements - Bank statement uploads /balance-history - Historical balance snapshots ``` ## Typical Workflow ### 1. Add discovered bank accounts As accounts are discovered through searches or document review, add them to the case: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/bank-accounts" \ -H "Content-Type: application/json" \ -d '{ "institution_name": "Chase Bank", "account_type": "checking", "account_number": "123456789", "ownership_type": "individual", "status": "open", "current_balance": 15230.50 }' ``` ### 2. Record account signers Track who is on the account: ```bash theme={null} curl -X POST ".../bank-accounts/{account_id}/signers" \ -H "Content-Type: application/json" \ -d '{ "name": "John Jonas Johnson", "role": "primary_holder", "is_deceased": true }' ``` ### 3. Check for beneficiary designations Accounts with POD/TOD designations pass directly to named beneficiaries and typically avoid probate: ```bash theme={null} curl -X POST ".../bank-accounts/{account_id}/beneficiaries" \ -H "Content-Type: application/json" \ -d '{ "name": "John Jonas Johnson", "relationship": "son", "percentage_share": 100.0, "designation_type": "pod", "is_contingent": false }' ``` ### 4. Track recurring payments Identify and manage recurring payments that need to be cancelled or transferred: ```bash theme={null} curl -X POST ".../bank-accounts/{account_id}/recurring-payments" \ -H "Content-Type: application/json" \ -d '{ "payee_name": "Springfield Electric Co.", "type": "utility", "amount": 150.00, "frequency": "monthly", "status": "active" }' ``` ### 5. Record transactions Track important transactions, especially estate-related ones: ```bash theme={null} curl -X POST ".../bank-accounts/{account_id}/transactions" \ -H "Content-Type: application/json" \ -d '{ "date": "2025-10-15", "type": "estate_distribution", "amount": -25000.00, "description": "Distribution to beneficiary - John Johnson", "category": "beneficiary_distribution" }' ``` ### 6. Upload bank statements Upload monthly statements for record-keeping: ```bash theme={null} curl -X POST ".../bank-accounts/{account_id}/statements" \ -F "file=@statement_oct_2025.pdf" \ -F "period_start=2025-10-01" \ -F "period_end=2025-10-31" \ -F "opening_balance=15230.50" \ -F "closing_balance=12450.00" ``` ## Instant Inheritance Bank accounts carry an `instant_inheritance` summary describing whether Sunset can pull the balance into the estate account directly, skipping the bank's estate department: ```json theme={null} { "instant_inheritance": { "eligibility": "eligible", "max_transfer_amount": 15230.50, "active_transfer_id": null, "transferred_amount": 0, "evaluated_at": "2026-08-24T14:02:11Z" } } ``` See the [Instant Inheritance Guide](/instant-inheritance) for requesting a transfer and tracking it to settlement. ## Account Types | Type | Description | | ---------------- | ------------------------------- | | `checking` | Standard checking account | | `savings` | Savings account | | `cd` | Certificate of Deposit | | `money_market` | Money market account | | `hsa` | Health Savings Account | | `trust_account` | Account held in a trust | | `estate_account` | Account opened for the estate | | `joint_account` | Joint account with survivorship | ## Ownership Types | Type | Description | | ----------------------- | ---------------------------------------- | | `individual` | Sole ownership by the deceased | | `joint_tenants_wros` | Joint Tenants with Right of Survivorship | | `tenants_in_common` | Tenants in Common (no survivorship) | | `pod_payable_on_death` | Payable on Death designation | | `tod_transfer_on_death` | Transfer on Death designation | | `trust` | Held in a trust | | `estate` | Estate account | ## Flagging Transactions Flag transactions for review during the estate settlement process: ```bash theme={null} curl -X PATCH ".../transactions/{transaction_id}" \ -H "Content-Type: application/json" \ -d '{ "is_flagged": true, "flag_reason": "estate_related", "notes": "Large withdrawal 2 weeks before death - needs review" }' ``` # Business Ownership Guide Source: https://api.hellosunset.com/business-guide Guide to managing business interests, succession planning, and entity disposition during estate settlement. # Business Ownership Guide The Sunset API helps you manage business interests owned by the deceased, including LLCs, corporations, partnerships, and sole proprietorships. This guide covers the workflow from discovery through succession or dissolution. ## API Path ``` /cases/{case_id}/businesses /cases/{case_id}/businesses/{business_id} ``` ## Typical Workflow ### 1. Add business interests Record each business entity the deceased had an interest in: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/businesses" \ -H "Content-Type: application/json" \ -d '{ "entity_type": "llc", "business_name": "Doe Family Properties LLC", "state_of_formation": "UT", "ein": "87-1234567", "status": "active", "deceased_role": "sole_owner", "ownership_percentage": 100.0, "estimated_value": 450000.00, "has_operating_agreement": true, "has_buy_sell_agreement": false, "registered_agent": "Utah Registered Agents Inc.", "annual_revenue": 72000.00, "employees": 0 }' ``` ### 2. Record co-owners and succession plan For multi-owner businesses: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/businesses" \ -H "Content-Type: application/json" \ -d '{ "entity_type": "s_corp", "business_name": "Johnson & Johnson Consulting Inc.", "state_of_formation": "UT", "status": "active", "deceased_role": "partner", "ownership_percentage": 50.0, "co_owners": [ { "name": "John Johnson", "role": "partner", "ownership_percentage": 50.0 } ], "has_buy_sell_agreement": true, "succession_plan": "continue_with_partners", "notes": "Buy-sell agreement provides for surviving partner to purchase at appraised value" }' ``` ### 3. Record professional licenses If the business involves professional licensing: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/businesses/{business_id}" \ -H "Content-Type: application/json" \ -d '{ "professional_licenses": [ { "license_type": "Real Estate Broker", "license_number": "RB-2019-5678", "issuing_state": "UT", "expiration_date": "2026-06-30", "status": "active" } ] }' ``` ### 4. Resolve the business ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/businesses/{business_id}" \ -H "Content-Type: application/json" \ -d '{ "succession_plan": "dissolve", "status": "dissolved", "notes": "LLC dissolved with Utah Division of Corporations. Assets distributed to estate." }' ``` ## Entity Types | Type | Description | | ---------------------- | ------------------------------ | | `c_corp` | C Corporation | | `s_corp` | S Corporation | | `llc` | Limited Liability Company | | `general_partnership` | General partnership | | `limited_partnership` | Limited partnership | | `sole_proprietorship` | Sole proprietorship | | `dba_trade_name` | DBA / Trade name | | `franchise` | Franchise | | `professional_license` | Licensed professional practice | | `nonprofit` | Nonprofit organization | ## Succession Plans | Plan | Description | | ------------------------ | --------------------------- | | `sell` | Sell the business interest | | `transfer_to_heir` | Transfer to a beneficiary | | `dissolve` | Wind down and dissolve | | `continue_with_partners` | Surviving partners continue | | `pending_decision` | Not yet decided | ## Deceased Roles | Role | Description | | ---------------- | --------------------------- | | `sole_owner` | 100% owner | | `majority_owner` | >50% ownership | | `minority_owner` | \<50% ownership | | `partner` | General or limited partner | | `officer` | Corporate officer | | `director` | Board member | | `shareholder` | Stock holder | | `member` | LLC member | | `manager` | LLC manager | | `license_holder` | Professional license holder | ## Key Considerations * **Operating agreements and bylaws** dictate what happens to ownership upon a member's death. Review these first. * **Buy-sell agreements** may require the business or surviving partners to purchase the deceased's interest at a predetermined price or formula. * **Sole proprietorships** have no separate legal existence. Assets and liabilities become part of the estate directly. * **Professional licenses** are non-transferable. A practice built on personal licensure may lose significant value. * **EIN and state registrations** may need to be updated or cancelled depending on the succession plan. * **Business debts** may create personal liability depending on the entity type and any personal guarantees. * **Valuation** of business interests often requires a professional appraiser, especially for closely-held companies. # Changelog Source: https://api.hellosunset.com/changelog New features, documentation updates, and upcoming API changes. # Changelog Product and documentation updates for the Sunset API. Items marked **In development** are coming to the API soon — watch this page for go-live announcements. ## Instant Inheritance Sunset can now pull a deceased account holder's bank balance straight into the case's FDIC-insured estate account, without corresponding with the bank at all. Approved transfers settle in a few business days instead of the weeks or months a bank estate department takes. New endpoints, live September 1, 2026: * `GET /cases/{case_id}/transfers` — every transfer on a case. * `POST /cases/{case_id}/transfers` — request a transfer from an eligible account. * `GET /cases/{case_id}/transfers/{transfer_id}` — track one transfer. * `POST /cases/{case_id}/transfers/{transfer_id}/cancel` — cancel before submission. Existing resources gain an `instant_inheritance` summary on bank accounts, carrying an `eligibility` of `eligible` or `ineligible`, and a new `instant_inheritance` value on `closure_method`. Accounts that do not qualify are unaffected and continue through [Automated Closure](/closure-guide#automated-closure). See the [Instant Inheritance Guide](/instant-inheritance). ## Automated Closure Sunset now closes accounts on your behalf: institution notification, documentation, follow-up, signature flagging, and deposit of proceeds into the case's FDIC-insured estate account. Free for families, covering bank, retirement, and brokerage accounts plus life insurance claims. See the [announcement](https://www.hellosunset.com/announcements/automated-closure) and the new [Automated Closure section](/closure-guide#automated-closure) of the Closure Guide, including how automated progress is reflected in the account and closure-step resources you already read today. ## In development * **Closure-request endpoints** — request and track automated closures programmatically. * **Search initiation endpoint** — kick off asset searches over the API. * **Business bank account search** — a new search type finding accounts titled to the deceased's business entities. Documentation for each will land here when the endpoints ship. ## Documentation * The [Pro Users Guide](/pro-users-guide#asset-searches) now documents reviewing asset searches: search types and statuses, and where discovered results land in the case's resources. * Fixed the [Business Ownership Guide](/business-guide), which previously returned a 404. * Added this changelog. ## Invite-Only Access The Sunset API moved to an invite-only access model with bearer authentication. See [Request Access](/request-access). ## Read-Heavy Model for Law Firm Integrations The API was restructured around a read-heavy model for law firm integrations, with grouped debt-type endpoints and updated enums. # Closure Guide Source: https://api.hellosunset.com/closure-guide Automated Closure, estate closure steps, status tracking, and institution contact management. # Automated Closure Sunset can close accounts on your behalf. Instead of tracking closure work manually, you request closure on an account and Sunset handles the rest: we notify the institution of the death, submit the required documentation (including certified death certificates and notarized forms), manage all correspondence and follow-up, flag anything that needs a signature, and deposit the proceeds into the case's FDIC-insured Sunset estate account. Automated Closure is free and currently supports: | Account category | How it's handled | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | Bank accounts (checking, savings, CDs, money market) | Closed; funds transferred to the estate account. Eligible accounts skip the bank entirely with [Instant Inheritance](/instant-inheritance) | | Retirement accounts (IRAs) | Closed or transferred per beneficiary designation | | Brokerage / investment accounts | Closed; assets liquidated or transferred | | Life insurance policies | Filed as claims; proceeds paid to beneficiaries or the estate | Automated Closure is requested from the Sunset app today. API endpoints for requesting and tracking closures programmatically are in development — see the [changelog](/changelog) for updates. [Instant Inheritance](/instant-inheritance) transfers are the exception: they can be evaluated, requested, and tracked over the API today. ## How Automated Closure Updates Existing Resources Automated Closure works with the account and closure-step resources you already use — no schema changes are required to read progress: * The account's `status` moves to `pending_closure` when a request is accepted and `closed` when it completes; `closed_date` and `closure_method` are set automatically. `closure_method` is `instant_inheritance` when the balance was pulled directly. * The case's `close_accounts` [closure step](#closure-steps) reflects automated progress: it moves to `in_progress` when the first closure request starts and `completed` when every account is resolved. A sub-task is created automatically for each account under closure. * Related steps benefit too: institution notifications sent during closure also advance the `notify_institutions` step. *** # Estate Closure The closure process tracks the steps needed to fully settle an estate. The API provides a structured workflow with ordered steps, sub-tasks, and dependency tracking. ## Closure Status Get the overall closure status and all steps: ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/closure" ``` Response includes: ```json theme={null} { "data": { "overall_status": "in_progress", "completion_percentage": 45, "steps": [ { "id": "...", "step_type": "notify_institutions", "title": "Notify Financial Institutions", "status": "completed", "order": 1 }, { "id": "...", "step_type": "close_accounts", "title": "Close Accounts", "status": "in_progress", "order": 2 } ] } } ``` ## Closure Steps Steps are processed in order. Each step can depend on previous steps being completed. Steps covered by [Automated Closure](#automated-closure) update automatically; the rest are tracked manually. | Step | Description | | --------------------------- | ------------------------------------------------------------------------ | | `notify_institutions` | Contact all banks and financial institutions to notify them of the death | | `close_accounts` | Close or retitle deceased accounts | | `cancel_recurring_payments` | Cancel autopay, subscriptions, and recurring debits | | `pay_debts` | Settle outstanding creditor claims and debts | | `file_final_taxes` | File final income tax return and estate tax return if applicable | | `obtain_tax_clearance` | Obtain tax clearance letter from the IRS and/or state | | `file_final_accounting` | File final accounting with the probate court | | `distribute_assets` | Distribute remaining assets to beneficiaries | | `close_estate_accounts` | Close the estate bank account | | `file_closing_documents` | File closing documents with the court | | `discharge_executor` | Obtain formal discharge of the executor | ## Step Statuses | Status | Meaning | | ------------- | --------------------------------------------------- | | `not_started` | Step hasn't begun | | `in_progress` | Actively being worked on | | `blocked` | Cannot proceed (see `blocked_reason`) | | `waiting` | Waiting on a third party (institution, court, etc.) | | `completed` | Step is done | | `skipped` | Not applicable to this estate | ## Sub-Tasks Each closure step can have sub-tasks for granular tracking: ```bash theme={null} # Add a sub-task curl -X POST ".../closure/steps/{step_id}/sub-tasks" \ -H "Content-Type: application/json" \ -d '{ "title": "Contact Chase Bank - Estate Services", "institution_contact_id": "01K8IC04DJ3T10HRYE78AN7DDD" }' # Mark a sub-task complete curl -X PATCH ".../closure/steps/{step_id}/sub-tasks/{sub_task_id}" \ -H "Content-Type: application/json" \ -d '{"completed": true}' ``` *** # Institution Contacts Manage contact information for every financial institution involved in the estate. Contacts can be routed by account type and department. With [Automated Closure](#automated-closure), Sunset locates estate departments and maintains institution contact information for you. Institution contacts remain fully editable for accounts you manage manually. ## Adding a Contact Department ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/institution-contacts" \ -H "Content-Type: application/json" \ -d '{ "institution_name": "Chase Bank", "department_name": "Estate Services Department", "is_default_contact": false, "account_types": ["bank"], "contact_methods": { "phone": "+11112223333", "phone_hours": "Mon-Fri 8am-6pm EST", "fax": "+11112223333", "email": "estates@chase.com", "mailing_address": { "address1": "123 Main Street", "city": "Salt Lake City", "state": "UT", "zip": "84101" }, "website": "https://www.chase.com/personal/estates" }, "reference_number": "EST-2025-00456", "notes": "Ask for estate services team, reference case number." }' ``` ## Account Type Routing Contacts can be configured to handle specific account types: | Account Type | Description | | ------------ | -------------------------------------- | | `bank` | Bank accounts (checking, savings, CDs) | | `debt` | All debt types (see subtypes below) | | `investment` | Investment and brokerage accounts | | `retirement` | 401(k), IRA, pension accounts | | `insurance` | Life insurance and annuities | ### Default Contact Set `is_default_contact: true` to make a contact the fallback when no specific department matches the account type. ### All Account Types Leave the `account_types` array **empty** to make a contact apply to ALL account types. ## Debt Subtypes When `debt` is in the `account_types` array, you can optionally narrow the contact to specific debt types using `debt_subtypes`: | Debt Subtype | Description | | -------------------------- | ------------------------------- | | `credit_card` | Credit card accounts | | `mortgage_and_real_estate` | Mortgage and real estate loans | | `auto_loans_and_leases` | Auto loans and vehicle leases | | `personal_loan` | Personal and signature loans | | `education` | Student loans | | `business_credit` | Business credit lines and loans | | `collections` | Accounts in collections | | `medical` | Medical debt | | `secured_loan` | Other secured loans | Leave `debt_subtypes` **empty** to apply to all debt types. ### Example: Debt-Specific Contact ```bash theme={null} curl -X POST ".../institution-contacts" \ -H "Content-Type: application/json" \ -d '{ "institution_name": "Capital One", "department_name": "Deceased Account Services - Credit Cards", "account_types": ["debt"], "debt_subtypes": ["credit_card"], "contact_methods": { "phone": "+11112223333", "phone_hours": "Mon-Sat 8am-8pm EST", "fax": "+11112223333", "mailing_address": { "address1": "123 Main Street", "city": "Salt Lake City", "state": "UT", "zip": "84101" } } }' ``` ## Contact Methods Each contact supports multiple communication methods: | Method | Description | | ----------------- | ------------------------------ | | `phone` | Phone number (E.164 format) | | `phone_hours` | Business hours for phone | | `phone_extension` | Extension number if needed | | `fax` | Fax number | | `email` | Email address | | `mailing_address` | Full mailing address | | `website` | URL for online portal or forms | # Collaboration Guide Source: https://api.hellosunset.com/collaboration-guide Inviting other users to view and collaborate on estate cases. # Collaboration Case owners can invite other users to collaborate on an estate case. Collaborators can be family members, co-executors, attorneys, financial advisors, or anyone who needs access. ## Inviting a Collaborator ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/collaborators" \ -H "Content-Type: application/json" \ -d '{ "email": "john@example.com", "first_name": "John", "last_name": "Johnson", "role": "editor", "permissions": { "can_manage_documents": true, "can_manage_financials": true, "can_manage_probate": false, "can_manage_collaborators": false, "can_use_tools": true }, "message": "Hi John, I am sharing access to Grandpa Vernen estate case with you." }' ``` An invitation email is sent to the collaborator. They can accept or decline. ## Roles & Permissions ### Roles | Role | Access | | -------- | ---------------------------------------------------- | | `owner` | Full control. Only one owner per case (the creator). | | `editor` | Can read and write data based on their permissions. | | `viewer` | Read-only access to all case data. | ### Granular Permissions Editors can have fine-grained permissions beyond their role: | Permission | Description | | -------------------------- | -------------------------------------------------------- | | `can_manage_collaborators` | Invite, update, or remove other collaborators | | `can_manage_documents` | Upload, update, and delete documents | | `can_manage_financials` | Modify financial accounts, bank accounts, transactions | | `can_manage_probate` | Manage probate filings, deadlines, claims, distributions | | `can_use_tools` | Use phone, email, fax, and notarization tools | Viewers always have read-only access regardless of permission settings. ## Invitation Flow ``` Owner sends invite -> Status: pending (email sent to collaborator) Collaborator accepts -> Status: accepted (case appears in their dashboard) Collaborator declines -> Status: declined Owner revokes access -> Status: revoked (DELETE endpoint) ``` ## Managing Collaborators ### List all collaborators ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/collaborators"``` ### Update a collaborator's role or permissions ```bash curl -X PATCH ".../collaborators/{collaborator_id}" \ -H "Content-Type: application/json" \ -d '{ "role": "viewer", "permissions": { "can_use_tools": false } }' ```` ### Resend a pending invitation ````bash theme={null} curl -X POST ".../collaborators/{collaborator_id}/resend"``` ### Remove a collaborator ```bash curl -X DELETE ".../collaborators/{collaborator_id}"``` ## How Collaborators See Shared Cases When a collaborator accepts an invite, the case appears in their `/users/me/cases` listing with their assigned role: ```json { "data": [ { "id": "01K5WF06MJ6T99HRYE78AN7XM8", "deceased_name": "John Jonas Johnson", "role": "editor", "estate_value": "unknown", "flow_position": "Closure - Decisions - Initial" } ] } ```` # Credit Cards & Debts Guide Source: https://api.hellosunset.com/debts-guide Guide to managing credit cards, loans, and debts during estate settlement. # Credit Cards & Debts Guide The Sunset API helps you track all debts owed by the deceased, notify creditors, and manage the claims process. This guide covers the typical workflow for handling estate debts. ## API Path ``` /cases/{case_id}/debts /cases/{case_id}/debts/{debt_id} /cases/{case_id}/debts/type/{type-group} ``` ## Typical Workflow ### 1. Add discovered debts Record debts as they are discovered through credit reports, mail, or account searches: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/debts" \ -H "Content-Type: application/json" \ -d '{ "debt_type": "CRC", "creditor_name": "Capital One", "account_number": "4147-XXXX-XXXX-5678", "condition": "OPEN", "responsibility": "I", "balance": 4523.89, "credit_limit": 10000.00, "interest_rate": 24.99, "is_joint_account": false, "credit_bureau_source": "experian" }' ``` ### 2. Record joint account debts Joint debts where a surviving co-signer is liable: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/debts" \ -H "Content-Type: application/json" \ -d '{ "debt_type": "R/C", "creditor_name": "Wells Fargo Home Mortgage", "condition": "OPEN", "responsibility": "J", "balance": 185000.00, "interest_rate": 3.75, "is_joint_account": true, "joint_holder_name": "John Johnson" }' ``` ### 3. Notify creditors Track creditor notification as part of the probate process: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/debts/{debt_id}" \ -H "Content-Type: application/json" \ -d '{ "notification_status": "notified", "notification_date": "2025-10-20" }' ``` ### 4. Settle or dispute debts Update debts as they are resolved: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/debts/{debt_id}" \ -H "Content-Type: application/json" \ -d '{ "condition": "CLOSED", "notes": "Settled for 60% of balance - $2,714.33" }' ``` ## Debt Types by Category ### Credit Cards | Code | Alias | Description | | ----- | ----- | ----------------------------- | | `CRC` | `18` | Credit card | | `FSC` | `75` | Credit card | | `CHG` | `07` | Revolving charge account | | `SCC` | `2A` | Secured credit card | | `0G` | — | Flexible spending credit card | ### Auto & Vehicle | Code | Alias | Description | | ----- | ----- | ----------- | | `AUT` | `00` | Auto loan | | `AO` | — | Auto loan | | `AUL` | `3A` | Auto lease | ### Real Estate & Mortgage | Code | Alias | Description | | ----- | ----- | --------------------------------- | | `R/C` | `26` | Conventional real estate mortgage | | `R/E` | `08` | Real estate account | | `R/F` | `19` | FHA real estate mortgage | | `R/O` | `27` | Real estate mortgage | | `R/S` | `5B` | Second mortgage | | `R/V` | `25` | VA real estate mortgage | | `MRI` | `86` | Mortgage account | | `FHA` | `05` | FHA home improvement loan | | `FMH` | `2C` | FMHA real estate mortgage | | `C/M` | `6B` | Commercial mortgage | | `BMP` | `85` | Bimonthly mortgage payment | | `SMP` | `87` | Semimonthly mortgage payment | | `EXM` | `33` | Manual mortgage | | `CSL` | `0F` | Construction loan | | `M/H` | `17` | Manufactured home | | `RES` | `5A` | Real estate account | ### Home Equity | Code | Alias | Description | | ----- | ----- | ---------------------------------- | | `H/E` | `89` | Home equity line of credit (HELOC) | | `HEI` | `6D` | Home equity | | `H/I` | `04` | Home improvement loan | | `SHI` | `9A` | Secured home improvement account | ### Personal Loans | Code | Alias | Description | | ----- | ----- | -------------------------- | | `I/L` | `78` | Installment loan | | `NTE` | `20` | Note loan | | `NCS` | `21` | Note loan with cosigner | | `SEC` | `02` | Secured loan | | `UNS` | `01` | Unsecured loan | | `P/S` | `03` | Partially secured loan | | `ISC` | `06` | Installment sales contract | ### Education | Code | Alias | Description | | ----- | ----- | ---------------- | | `EDU` | `12` | Educational loan | ### Medical | Code | Alias | Description | | ----- | ----- | ------------ | | `MED` | `90` | Medical debt | ### Business | Code | Alias | Description | | ----- | ----- | --------------------------- | | `BUS` | `10` | Business loan | | `BCC` | `8A` | Business credit card | | `BPG` | `9B` | Business line of credit | | `CIL` | `G1` | Commercial installment loan | | `CLC` | `7A` | Commercial line of credit | | `LBP` | `1B` | Business account | ### Government | Code | Alias | Description | | ----- | ----- | ------------------------------------ | | `G/B` | `75` | Government benefit | | `G/F` | `71` | Government fine | | `G/G` | `69` | Government grant | | `GEA` | `73` | Government employee advance | | `GFS` | `72` | Government fee | | `GMD` | `74` | Government debt | | `GOP` | `70` | Government overpayment | | `SDL` | `68` | Government secured direct loan | | `SGL` | `66` | Government secured guaranteed loan | | `UDL` | `67` | Government unsecured direct loan | | `UGL` | `65` | Government unsecured guaranteed loan | ### Collections | Code | Alias | Description | | ----- | ----- | ---------------------- | | `COL` | `48` | Account in collections | ### Lines of Credit | Code | Alias | Description | | ----- | ----- | --------------------------- | | `C/C` | `15` | Credit account | | `C/G` | `98` | Credit account | | `CGA` | `6C` | Credit account | | `CCP` | `37` | Combined credit plan | | `CLS` | `47` | Secured credit line | | `CKG` | `96` | Checking account | | `CSA` | `5C` | Checking or savings account | ### Banking & Deposits | Code | Alias | Description | | ----- | ----- | ----------------------- | | `DEP` | `8B` | Deposit related account | | `D/C` | `43` | Debit card | | `RCK` | `77` | Returned check | ### Household Goods | Code | Alias | Description | | ----- | ----- | ------------------------------------------------ | | `H+O` | `23` | Account secured by household goods or collateral | | `HHG` | `22` | Account secured by household goods | | `PHG` | `1C` | Purchase of household goods | | `REC` | `11` | Recreational merchandise loan | ### Insurance | Code | Alias | Description | | ----- | ----- | ----------------------- | | `INS` | `49` | Insurance underwriting | | `LPI` | `1A` | Lender-placed insurance | ### Utility & Service | Code | Alias | Description | | ----- | ----- | -------------------------- | | `UTI` | `92` | Utility company account | | `CEL` | `4D` | Phone/cell account | | `SAA` | `7C` | Service activation account | | `LEA` | `13` | Lease | | `REN` | `29` | Rental agreement | | `LIC` | `3C` | Licensing account | ### Support & Legal | Code | Alias | Description | | ----- | ----- | ---------------------- | | `C/S` | `93` | Child support | | `F/S` | `50` | Family support account | | `S/S` | `94` | Spouse support account | | `ATY` | `95` | Attorney fee | ### Cosigned Accounts | Code | Alias | Description | | ----- | ----- | ------------------------- | | `COS` | `14` | Account they cosigned on | | `F/C` | `16` | FHA loan they cosigned on | | `SC0` | `09` | Loan secured by cosigner | | `NCS` | `21` | Note loan with cosigner | ### Other | Code | Alias | Description | | ----- | ----- | -------------------------- | | `AGR` | `7B` | Agriculture account | | `CON` | `91` | Debt consolidation account | | `DCS` | `34` | Debt counseling service | | `FCO` | `0C` | Factoring company or loan | | `PPI` | `83` | Prescreen inquiry | | `SUM` | `30` | Summary of account | | `TSL` | `0A` | Time share loan | | `UNK` | `31` | Unknown financial account | | `ZZZ` | `ZZ` | Instant update | ## Debt Condition | Code | Description | | --------------- | ----------------------------- | | `OPEN` | Account is open and active | | `CLOSED` | Account is closed | | `PAID` | Account is fully paid | | `CHARGEOFF` | Account has been charged off | | `COLLECTIONS` | Account is in collections | | `DELINQUENT30` | 30 days delinquent | | `DELINQUENT60` | 60 days delinquent | | `DELINQUENT90` | 90 days delinquent | | `DELINQUENT120` | 120+ days delinquent | | `DECEASED` | Reported as deceased | | `BANKRUPTCY` | Discharged through bankruptcy | | `BANKRUPTCYPET` | Petitioned for bankruptcy | | `TRANSFER` | Transferred or sold | | `REPOSSESSION` | Repossessed | | `REFINANCED` | Refinanced | | `LOST` | Lost or stolen | | `UNKNOWN` | Unknown status | ## Debt Responsibility | Code | Alias | Description | | ---- | ----- | --------------------- | | `I` | `1` | Borrower (individual) | | `B` | — | Borrower | | `C` | `8` | Co-borrower | | `S` | `5` | Shared | | `J` | `2` | Joint with spouse | | `P` | `4` | Joint with non-spouse | | `A` | `3` | Authorized user | | `M` | `7` | Signer | | `O` | `0` | Undesignated | | `U` | — | Undesignated | | `T` | `9` | Terminated user | | `X` | — | Deceased | ## Notification Statuses | Status | Description | | -------------- | -------------------------------------- | | `not_notified` | Creditor has not been contacted | | `notified` | Death notification sent to creditor | | `acknowledged` | Creditor acknowledged the notification | | `resolved` | Debt has been resolved | ## Key Considerations * **Joint debts** remain the responsibility of the surviving co-signer. Only the deceased's individual debts are paid from the estate. * **Secured debts** (mortgage, auto loan) are tied to collateral. Heirs may assume these or the asset may be sold. * **Federal student loans** are discharged upon death with a certified death certificate. * **Credit card debt** of an individual cardholder is typically paid from the estate. Authorized users are not liable. * **Collections accounts** should be verified before payment. Request validation of the debt. * **Creditor claim deadlines** vary by state. Track notification dates carefully. * **Responsibility codes** come from credit bureau data and indicate the deceased's relationship to the account. # Errors Source: https://api.hellosunset.com/errors Error codes and error handling in the Sunset API. # Errors The Sunset API uses conventional HTTP status codes and returns structured error responses. Every error response includes an `X-Request-Id` header for debugging. ## HTTP Status Codes | Code | Meaning | | ----- | -------------------------------------------------------------------- | | `200` | OK - Request succeeded | | `201` | Created - Resource created successfully | | `204` | No Content - Resource deleted successfully | | `304` | Not Modified - Resource unchanged (ETag matched via `If-None-Match`) | | `400` | Bad Request - Malformed request syntax | | `403` | Forbidden - You don't have access to this resource | | `404` | Not Found - Resource does not exist | | `409` | Conflict - Duplicate idempotency key with different request body | | `412` | Precondition Failed - Resource modified since ETag (via `If-Match`) | | `422` | Unprocessable Entity - Validation errors in the request body | | `429` | Too Many Requests - Rate limit exceeded | | `500` | Internal Server Error - Something went wrong on our end | ## Error Response Format All error responses follow this structure: ```json theme={null} { "error": { "code": "validation_error", "message": "The request body contains invalid fields.", "details": [ { "field": "email", "message": "Must be a valid email address." }, { "field": "date_of_birth", "message": "Must be a valid date in YYYY-MM-DD format." } ] } } ``` ## Error Codes | Code | HTTP Status | Description | | ---------------------- | ----------- | --------------------------------------------------------------------------- | | `forbidden` | 403 | You don't have permission to access this resource. | | `not_found` | 404 | The requested resource was not found. | | `idempotency_conflict` | 409 | A different request body was sent with the same `Idempotency-Key`. | | `precondition_failed` | 412 | The resource has been modified since the provided ETag. Re-fetch and retry. | | `validation_error` | 422 | The request body failed validation. Check the `details` array. | | `rate_limit_exceeded` | 429 | You've exceeded the rate limit. Retry after the `X-RateLimit-Reset` time. | | `internal_error` | 500 | An unexpected error occurred. Contact support if it persists. | ## PATCH Semantics (JSON Merge Patch) All PATCH endpoints use **JSON Merge Patch** semantics ([RFC 7396](https://datatracker.ietf.org/doc/html/rfc7396)): * Only include the fields you want to change. * Fields set to `null` are removed (set to null on the resource). * Fields not included in the request body are left unchanged. * Nested objects are merged recursively. ```bash theme={null} # Only updates the estate_value field; all other fields remain unchanged curl -X PATCH "https://api.example.com/v1/cases/CASE_ID" \ -H "Content-Type: application/json" \ -d '{ "estate_value": "over_150000" }' ``` ## Handling Errors ```python theme={null} import requests response = requests.get( "https://api.example.com/v1/cases/invalid-id", headers={} ) if response.status_code == 404: error = response.json()["error"] print(f"Error: {error['message']}") elif response.status_code == 422: error = response.json()["error"] for detail in error.get("details", []): print(f"Field '{detail['field']}': {detail['message']}") elif response.status_code == 429: reset_time = response.headers.get("X-RateLimit-Reset") print(f"Rate limited. Retry after timestamp: {reset_time}") elif response.status_code == 412: # Re-fetch the resource and retry with the new ETag print("Resource was modified. Re-fetch and retry.") # Always log the request ID for debugging request_id = response.headers.get("X-Request-Id") print(f"Request ID: {request_id}") ``` # Instant Inheritance Guide Source: https://api.hellosunset.com/instant-inheritance Pull a deceased account holder's bank balance into the estate account without waiting on the bank. # Instant Inheritance Instant Inheritance moves money out of a deceased person's bank account and into the case's FDIC-insured Sunset estate account without corresponding with the bank at all. No username, no password, no branch visit, and no months of estate-department paperwork. Where a normal bank closure takes weeks or months, an approved Instant Inheritance transfer settles in a few business days. Sunset approves an account for Instant Inheritance only after it has independently confirmed the account and the requester's authority over the estate. Accounts that do not qualify are still closed by Sunset, through [Automated Closure](/closure-guide#automated-closure). Instant Inheritance is free, like the rest of Automated Closure. It currently covers deceased-held bank accounts (checking, savings, money market). Retirement, brokerage, and life insurance proceeds continue to move through Automated Closure. ## The Flow 1. Read the account's eligibility. 2. If the account is `eligible`, request a transfer. 3. Poll the transfer until it reaches `completed`. 4. Read the settled funds on the estate account and the case's closure step. ## 1. Check Eligibility Every bank account on a case carries an `instant_inheritance` summary: ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}" ``` ```json theme={null} { "data": { "id": "01K6BA01AJ9T66HRYE78AN7PQR", "institution_name": "Chase Bank", "account_type": "checking", "status": "open", "current_balance": 15230.50, "instant_inheritance": { "eligibility": "eligible", "max_transfer_amount": 15230.50, "active_transfer_id": null, "transferred_amount": 0, "evaluated_at": "2026-08-24T14:02:11Z" } } } ``` ### Eligibility Values | Value | Meaning | | ------------ | -------------------------------------------------------------- | | `eligible` | Sunset has approved this account. A transfer may be requested. | | `ineligible` | Sunset cannot transfer this account right now. | Sunset re-evaluates every account continuously as searches, documents, and verification complete, so an account may move from `ineligible` to `eligible` without any action on your part. `max_transfer_amount` is null unless the account is `eligible`. Most accounts will not be eligible on day one. Poll the account rather than treating `ineligible` as final: an account that reads `ineligible` this morning may read `eligible` this afternoon. Nothing is lost either way, since an account Sunset cannot transfer instantly is closed through the normal Automated Closure path. ## 2. Request a Transfer ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/transfers" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: idem_01K9IK01AJ0T88HRYE78AN7YYY" \ -d '{ "bank_account_id": "01K6BA01AJ9T66HRYE78AN7PQR", "amount": 15230.50, "notes": "Requested after Letters Testamentary were accepted." }' ``` Omit `amount` to transfer the full confirmed available balance. Omit `estate_account_id` to use the case's primary estate account. ```json theme={null} { "data": { "id": "01K9TR01AJ0T55HRYE78AN7TRF", "case_id": "01K5WF06MJ6T99HRYE78AN7XM8", "bank_account_id": "01K6BA01AJ9T66HRYE78AN7PQR", "estate_account_id": "01K6BA07XJ9T66HRYE78AN7EST", "method": "ach_debit", "amount_requested": 15230.50, "amount_settled": null, "status": "requested", "requested_at": "2026-08-24T14:10:00Z", "expected_settlement_date": "2026-08-27" } } ``` Requesting a transfer on an account that is not `eligible` returns `422`: ```json theme={null} { "error": { "code": "transfer_not_eligible", "message": "This account is not approved for Instant Inheritance." } } ``` Always send an `Idempotency-Key` on `POST /transfers`. A retried request without one can move money twice. Keys expire after 24 hours. ## 3. Track the Transfer ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/transfers/{transfer_id}" ``` List every transfer on a case, optionally filtered: ```bash theme={null} # All transfers, newest first curl "https://api.example.com/v1/cases/{case_id}/transfers" # Only transfers still moving curl ".../cases/{case_id}/transfers?status=in_transit" # Transfers from one account curl ".../cases/{case_id}/transfers?bank_account_id=01K6BA01AJ9T66HRYE78AN7PQR" ``` ### Transfer Statuses | Status | Meaning | | ------------ | --------------------------------------------------------------------------------------------------- | | `requested` | The transfer was requested and is queued for review. | | `verifying` | Sunset is re-confirming the balance and account state before submitting. | | `approved` | Cleared for submission on the next ACH window. | | `submitted` | Sent to the ACH network. `trace_number` is populated. Cannot be cancelled. | | `in_transit` | Moving between institutions. | | `completed` | Funds settled in the estate account. `amount_settled` and `settled_at` are set. | | `returned` | The receiving institution returned the debit. See `return_code` and `status_reason`. | | `rejected` | Sunset stopped the transfer before submission, usually because a criterion stopped being satisfied. | | `cancelled` | Cancelled by the requester before submission. | ### Return Codes A `returned` transfer carries the NACHA return code: | Code | Meaning | What to do | | ----- | ----------------------------------------- | --------------------------------------------------------------------- | | `R01` | Insufficient funds | Re-check the balance and request a smaller amount. | | `R02` | Account closed | The account is gone. Fall back to Automated Closure. | | `R03` | No account or unable to locate | Re-verify the account and routing numbers. | | `R04` | Invalid account number | Re-verify the account number. | | `R08` | Payment stopped | The institution stopped the debit. Sunset works the account manually. | | `R10` | Customer advises not authorized | Sunset re-submits the authority documentation to the institution. | | `R16` | Account frozen | The institution froze the account. Fall back to Automated Closure. | | `R20` | Non-transaction account | The account does not support ACH debits. | | `R29` | Corporate customer advises not authorized | Applies to business-titled accounts. | A returned transfer never blocks the account: Sunset reverts the account to the normal closure path automatically. ## 4. Cancel a Transfer A transfer can be cancelled while its status is `requested`, `verifying`, or `approved`: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/transfers/{transfer_id}/cancel" \ -H "Content-Type: application/json" \ -d '{"reason": "Executor asked us to hold until the sibling dispute is resolved."}' ``` Once the status is `submitted`, the transfer is with the ACH network and cannot be stopped. Cancelled transfers stay on the case for audit purposes; transfers are never deleted. ## Limits and Safeguards * **One in flight per account.** A second request while `instant_inheritance.active_transfer_id` is set returns `422`. * **Never more than the confirmed balance.** `amount` cannot exceed `max_transfer_amount`. * **Authority is required, always.** Sunset does not transfer without verified authority over the estate. * **Funds land in the estate account only.** Transfers cannot be directed to a personal account. Distribution to beneficiaries happens later, through [distributions](/probate-guide). ## How Transfers Update Existing Resources Instant Inheritance works with the resources you already read: * The bank account's `status` moves to `pending_closure` when a transfer is submitted and `closed` when it completes, with `closure_method` set to `instant_inheritance`. * `instant_inheritance.transferred_amount` accumulates the settled total for that account. * The estate account receives a `transaction` of type `estate_deposit` on settlement. * The case's `close_accounts` [closure step](/closure-guide#closure-steps) advances the same way it does for any other Automated Closure. # Introduction Source: https://api.hellosunset.com/introduction Get started with the Sunset API for estate and probate management. # Welcome to the Sunset API The Sunset API is currently available by invitation only. If you're interested in integrating with Sunset, please email [api\_request@hellosunset.com](mailto:api_request@hellosunset.com) to request access. The Sunset API gives you programmatic access to the Sunset estate and probate management platform. Whether you're building an integration for a law firm, a financial advisory practice, or a family office, the API lets you manage every aspect of estate settlement — from the first notification to final asset distribution. ## Overview Sunset handles the complexity of estate administration so your team doesn't have to. The API covers the full lifecycle: Create cases, record deceased and executor details, verify identities, and track authority documents. Manage bank accounts, transactions, recurring payments, signers, POD/TOD beneficiaries, and statements. Request automated real estate valuations, track liens and mortgages, and monitor equity. Upload death certificates, probate filings, and property reports. Download and share securely. Access probate requirements for all 50 states and every county. Track filings, deadlines, creditor claims, and distributions. Make recorded phone calls, send emails with attachments, fax documents, and initiate online notarizations — all with full audit trails. ## Who is the API for? | Audience | Use Case | | ------------------------ | ----------------------------------------------------------------------------- | | **Estate Attorneys** | Automate case intake, track probate deadlines, manage court filings | | **Financial Advisors** | Monitor estate accounts, track distributions, manage beneficiary designations | | **Trust Companies** | Manage multiple estates at scale with Pro multi-estate features | | **Insurance Providers** | Verify death records, track claims, automate document collection | | **Family Offices** | Coordinate across executors, attorneys, and family members | | **Software Integrators** | Embed estate management into existing legal or financial platforms | ## Base URL All API requests are made to: ``` https://api.example.com/v1 ``` A staging environment is available for development and testing: ``` https://staging-api.example.com/v1 ``` ## Quick Start 1. **Make your first request:** ```bash theme={null} curl -X GET https://api.example.com/v1/cases ``` 2. **Create a case:** ```bash theme={null} curl -X POST https://api.example.com/v1/cases \ -H "Content-Type: application/json" \ -d '{ "estate_value": "unknown", "progress": "just_started", "possible_dispute": "no_dispute_expected" }' ``` ## Response Format All responses follow a consistent envelope structure: **Single resource:** ```json theme={null} { "data": { "id": "01K5WF06MJ6T99HRYE78AN7XM8", "estate_value": "unknown", "progress": "just_started" } } ``` **List of resources:** ```json theme={null} { "data": [ { "id": "01K5WF06MJ6T99HRYE78AN7XM8", "..." : "..." } ], "meta": { "page": 1, "per_page": 25, "total_count": 142, "total_pages": 6, "next_cursor": "eyJpZCI6...", "has_more": true } } ``` ## Key Features ### Identity Verification Verify the identity of both the deceased (via SSDI lookup, vital records) and the executor (via government ID, knowledge-based authentication). Each verification tracks individual checks and produces a verification level (0–3). ### Real Estate Valuations Request automated property valuations powered by AVM data. Get tax assessments, comparable sales, lien tracking, and equity estimates — all linked to estate financial accounts. ### Communication Tools Place phone calls via Twilio with automatic recording, transcription, and AI summarization. Send emails with document attachments and delivery tracking. Fax documents with one click. Initiate online notarization sessions through DocuSign. ### Multi-Estate Management Pro users can manage up to 50 estates from a single account. Enterprise plans offer unlimited cases with SSO and custom integrations. ### Collaboration Invite attorneys, co-executors, and family members to collaborate on a case with role-based access control and granular permissions. ## Next Steps Apply for API credentials and get started with your integration. Understand error codes and how to handle them. Navigate large datasets with page-based and cursor-based pagination. Jump straight into the full API reference. # Investment Accounts Guide Source: https://api.hellosunset.com/investments-guide Guide to managing brokerage accounts, stocks, bonds, and other investments during estate settlement. # Investment Accounts Guide The Sunset API helps you manage investment accounts including brokerage accounts, mutual funds, stocks, and cryptocurrency. This guide covers the workflow from discovery through transfer or liquidation. ## API Path ``` /cases/{case_id}/investment-accounts /cases/{case_id}/investment-accounts/{account_id} ``` ## Typical Workflow ### 1. Add discovered accounts with holdings Record investment accounts with their individual holdings: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/investment-accounts" \ -H "Content-Type: application/json" \ -d '{ "account_type": "brokerage", "custodian_name": "Charles Schwab", "account_number": "8765-4321", "status": "active", "balance": 92500.00, "date_of_death_value": 89750.00, "holdings": [ { "symbol": "AAPL", "name": "Apple Inc.", "quantity": 100, "market_value": 17500.00, "cost_basis": 12000.00, "asset_class": "stock" }, { "symbol": "VXUS", "name": "Vanguard Total Intl Stock ETF", "quantity": 500, "market_value": 27500.00, "cost_basis": 25000.00, "asset_class": "etf" }, { "symbol": "BTC", "name": "Bitcoin", "quantity": 0.75, "market_value": 47500.00, "cost_basis": 30000.00, "asset_class": "cryptocurrency" } ] }' ``` ### 2. Record date-of-death valuation The date-of-death value establishes the stepped-up cost basis for tax purposes: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/investment-accounts/{account_id}" \ -H "Content-Type: application/json" \ -d '{ "date_of_death_value": 89750.00, "notes": "Valuation obtained from Schwab as of 2025-09-15" }' ``` ### 3. Track transfer or liquidation ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/investment-accounts/{account_id}" \ -H "Content-Type: application/json" \ -d '{ "transfer_status": "transferred", "status": "transferred", "notes": "Transferred in-kind to beneficiary account #INH-5678" }' ``` ## Account Types | Type | Description | | ------------------- | ------------------------------ | | `brokerage` | Standard brokerage account | | `mutual_fund` | Mutual fund account | | `etf` | ETF-focused account | | `individual_stocks` | Direct stock holdings | | `individual_bonds` | Bond portfolio | | `managed_account` | Professionally managed account | | `529_plan` | Education savings plan | | `private_equity` | Private equity investment | | `cryptocurrency` | Crypto holdings | | `other` | Other investment type | ## Asset Classes (Holdings) | Class | Description | | ---------------- | --------------------------- | | `stock` | Individual stocks | | `bond` | Individual bonds | | `mutual_fund` | Mutual fund shares | | `etf` | Exchange-traded fund shares | | `option` | Options contracts | | `cryptocurrency` | Digital currency | | `cash` | Cash or cash equivalents | | `other` | Other asset class | ## Key Considerations * **Stepped-up cost basis**: Inherited investments receive a stepped-up cost basis to the date-of-death value, potentially eliminating capital gains tax. * **Date-of-death valuation** must be documented for tax purposes. Request a formal statement from the custodian. * **TOD (Transfer on Death)** designated accounts pass directly to the named beneficiary outside of probate. * **In-kind transfers** preserve the holdings without selling. This avoids taxable events during transfer. * **Cryptocurrency** may require special handling for wallet access and private keys. * **Community property states** may allow a full step-up in basis for both spouses' shares. # Life Insurance Guide Source: https://api.hellosunset.com/life-insurance-guide Guide to managing life insurance policies, beneficiaries, and claims during estate settlement. # Life Insurance Guide The Sunset API helps you track and manage life insurance policies discovered during estate settlement. This guide covers the typical workflow from discovery through claim payout. ## API Path ``` /cases/{case_id}/life-insurance /cases/{case_id}/life-insurance/{policy_id} ``` ## Typical Workflow ### 1. Add discovered policies As life insurance policies are found through searches, mail, or employer records, add them to the case: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/life-insurance" \ -H "Content-Type: application/json" \ -d '{ "policy_type": "whole_life", "carrier_name": "Northwestern Mutual", "policy_number": "WL-9876543", "status": "active", "death_benefit": 250000.00, "cash_value": 45000.00, "beneficiaries": [ { "name": "John Jonas Johnson", "relationship": "son", "percentage_share": 100, "designation": "primary", "is_irrevocable": false } ] }' ``` ### 2. Record employer group policies Don't forget employer-provided coverage: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/life-insurance" \ -H "Content-Type: application/json" \ -d '{ "policy_type": "group_employer", "carrier_name": "MetLife", "employer_name": "Acme Corporation", "status": "active", "death_benefit": 150000.00 }' ``` ### 3. File and track claims Update the policy as claims progress: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/life-insurance/{policy_id}" \ -H "Content-Type: application/json" \ -d '{ "claim_status": "filed", "claim_filed_date": "2025-10-15" }' ``` ### 4. Record claim payouts When a claim is paid: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/life-insurance/{policy_id}" \ -H "Content-Type: application/json" \ -d '{ "claim_status": "paid", "claim_paid_date": "2025-11-20", "claim_paid_amount": 250000.00, "status": "paid_out" }' ``` ## Policy Types | Type | Description | | ---------------------------- | --------------------------------------- | | `term_life` | Term life insurance (fixed period) | | `whole_life` | Whole life with cash value | | `universal_life` | Flexible premium universal life | | `variable_life` | Variable life with investment component | | `group_employer` | Employer-provided group coverage | | `group_government` | Government group coverage (FEGLI, SGLI) | | `supplemental` | Supplemental/voluntary life | | `accidental_death` | AD\&D policy | | `annuity_with_death_benefit` | Annuity with death benefit rider | ## Claim Statuses | Status | Description | | -------------- | -------------------------------- | | `not_filed` | Claim has not been filed yet | | `filed` | Claim submitted to carrier | | `under_review` | Carrier is reviewing the claim | | `approved` | Claim approved, awaiting payment | | `paid` | Claim has been paid out | | `denied` | Claim was denied | ## Key Considerations * **Beneficiary designations** on life insurance policies override the will. Policies pay directly to named beneficiaries. * **Irrevocable beneficiaries** cannot be changed and must be paid as designated. * **Group policies** through employers may have short claim windows after termination of employment. * **Cash value** in whole/universal life policies is a separate asset from the death benefit. * **Premium status** should be monitored to prevent policies from lapsing before claims are filed. # Pagination Source: https://api.hellosunset.com/pagination How pagination and sorting work in the Sunset API. # Pagination All list endpoints return paginated results. The Sunset API supports both **page-based** and **cursor-based** pagination. ## Page-Based Pagination The default pagination method. Use query parameters to control the page, page size, and sort order. ### Query Parameters | Parameter | Type | Default | Description | | ------------ | ------- | ------- | ---------------------------------------------------------- | | `page` | integer | `1` | Page number (1-indexed). | | `per_page` | integer | `25` | Items per page (max 100). | | `sort_by` | string | varies | Field to sort by. Available values depend on the endpoint. | | `sort_order` | string | `desc` | Sort direction: `asc` or `desc`. | ### Example Request ````bash theme={null} curl "https://api.example.com/v1/cases?page=2&per_page=10&sort_by=created_at&sort_order=asc"``` ### Response Metadata Every paginated response includes a `meta` object: ```json { "data": [...], "meta": { "page": 2, "per_page": 10, "total_count": 47, "total_pages": 5, "next_cursor": null, "has_more": true } } ```` | Field | Description | | ------------- | ------------------------------------------------------------------------------------- | | `page` | Current page number. | | `per_page` | Items per page for this request. | | `total_count` | Total number of items across all pages. | | `total_pages` | Total number of pages. | | `next_cursor` | Cursor for the next page (null when using page-based pagination or on the last page). | | `has_more` | Whether more results exist beyond this page. | ## Cursor-Based Pagination For high-volume resources (transactions, balance history, phone calls), cursor-based pagination is recommended. It provides consistent results even when new records are added between requests. ### How It Works 1. Make your first request without a cursor: ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/transactions?per_page=50"``` 2. The response includes a `next_cursor` in the `meta` object: ```json { "data": [...], "meta": { "per_page": 50, "next_cursor": "eyJpZCI6IjAxSzVXRjA2...", "has_more": true } } ```` 3. Use the `cursor` parameter for subsequent requests: ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/bank-accounts/{account_id}/transactions?per_page=50&cursor=eyJpZCI6IjAxSzVXRjA2..."``` 4. Continue until `has_more` is `false`. When using cursor-based pagination, the `page` parameter is ignored. The `total_count` and `total_pages` fields may not be available. ## Iterating Through All Pages ### Page-Based (Python) ```python import requests headers = {} page = 1 all_cases = [] while True: response = requests.get( f"https://api.example.com/v1/cases?page={page}&per_page=100", headers=headers ) data = response.json() all_cases.extend(data["data"]) if page >= data["meta"]["total_pages"]: break page += 1 ```` ### Cursor-Based (Python) ```python theme={null} import requests headers = {} cursor = None all_transactions = [] while True: params = {"per_page": 100} if cursor: params["cursor"] = cursor response = requests.get( f"https://api.example.com/v1/cases/CASE_ID/bank-accounts/ACCOUNT_ID/transactions", headers=headers, params=params ) data = response.json() all_transactions.extend(data["data"]) if not data["meta"]["has_more"]: break cursor = data["meta"]["next_cursor"] ``` ## Filtering Many list endpoints support additional query parameters for filtering. Check each endpoint's documentation for available filters. Filters can be combined: ````bash theme={null} # List open bank accounts at Chase, sorted by balance curl "https://api.example.com/v1/cases/{case_id}/bank-accounts?status=open&institution_name=Chase&sort_by=current_balance&sort_order=desc"``` ```` # Pro Users Guide Source: https://api.hellosunset.com/pro-users-guide Managing multiple estates, running asset searches, and reviewing search results as a Pro user. # Pro Users Pro users can manage multiple estate cases from a single account. This is designed for estate professionals, attorneys, financial advisors, and family members handling multiple estates simultaneously. ## Plans | Plan | Cases | Features | | -------------- | -------------- | --------------------------------------------------- | | **Pro** | Up to 50 cases | Multi-estate dashboard, all tools, priority support | | **Enterprise** | Unlimited | Custom integrations, dedicated support, SSO | ## Your Profile Retrieve your profile and plan details: ```bash theme={null} curl "https://api.example.com/v1/users/me" ``` Response: ```json theme={null} { "data": { "id": "01K8PU01AJ0T77HRYE78AN7AAA", "email": "logan@example.com", "first_name": "John", "last_name": "Johnson", "plan": "pro", "cases_limit": 50, "cases_count": 12, "organization": "Johnson Estate Services", "role": "owner" } } ``` ## Listing All Your Cases See all estates you have access to, including cases shared with you: ```bash theme={null} curl "https://api.example.com/v1/users/me/cases?sort_by=updated_at&sort_order=desc" ``` ### Filter by your role ```bash theme={null} # Only cases you own curl ".../users/me/cases?role=owner" # Cases shared with you (editor or viewer access) curl ".../users/me/cases?role=editor" curl ".../users/me/cases?role=viewer" ``` ### Search across estates ```bash theme={null} # Search by deceased name curl ".../users/me/cases?search=Johnson" ``` ## Roles | Role | Description | | -------- | ------------------------------------------------------------------------------------------------------------------------------------ | | `owner` | Full control. Can delete the case, manage collaborators, and access all features. | | `editor` | Can modify case data, upload documents, and use tools. Cannot delete the case or manage collaborators (unless explicitly permitted). | | `viewer` | Read-only access. Can view all case data but cannot make changes. | ## Working with Multiple Cases Each API call targets a specific case via `case_id` in the URL: ```bash theme={null} # Work on case A curl "https://api.example.com/v1/cases/CASE_A_ID/deceased" # Work on case B curl "https://api.example.com/v1/cases/CASE_B_ID/deceased" ``` If you attempt to access a case you don't have permission for, you'll receive a `403 Forbidden` response. *** # Asset Searches Sunset runs asset and background searches to discover what the deceased owned: bank accounts, real estate, life insurance, retirement accounts, investments, businesses, vehicles, credit obligations, and unclaimed property. As a Pro user you can review search progress and results across every case you manage. ## Reviewing a Case's Searches List all searches on a case, with optional filters: ```bash theme={null} # All searches on a case curl "https://api.example.com/v1/cases/{case_id}/searches" # Only completed searches curl ".../cases/{case_id}/searches?status=completed" # Only bank account searches curl ".../cases/{case_id}/searches?type=bank_accounts" ``` Retrieve a single search to check its status: ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/searches/{search_id}" ``` Response: ```json theme={null} { "data": { "id": "01K5XC08DJ6T33HRYE78AN7GHI", "type": "real_estate", "status": "completed", "completed_at": "2025-09-24T12:52:00Z", "results_summary": "2 properties found in Cache County, UT", "created_at": "2025-09-24T12:00:00Z", "updated_at": "2025-09-24T12:52:00Z" } } ``` ### Search Types | Type | What it looks for | | -------------------- | ------------------------------------------------- | | `bank_accounts` | Checking, savings, CDs, and money market accounts | | `credit` | Credit cards, loans, and other debts | | `investments` | Brokerage and investment accounts | | `life_insurance` | Life insurance policies | | `retirement` | IRAs, 401(k)s, and pensions | | `real_estate` | Properties and land holdings | | `businesses` | Business entities and ownership interests | | `vehicles` | Cars, trucks, boats, and other titled vehicles | | `unclaimed_property` | State unclaimed property records | ### Search Statuses | Status | Meaning | | ------------- | -------------------------------- | | `pending` | Search is queued | | `in_progress` | Sunset is actively searching | | `completed` | Finished — results are available | | `failed` | Search could not be completed | | `cancelled` | Search was cancelled | Initial searches typically complete within **5–14 days**. Searches cannot be deleted — they form part of the case's audit trail. ## Where Results Land When a search completes, each discovered asset is created as a full record under the matching case resource — the search's `results_summary` is only a human-readable recap. For example, a completed `bank_accounts` search that found two accounts adds two records to: ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/bank-accounts" ``` The same applies to the other types: `real_estate` results appear under `/real-estate-properties`, `life_insurance` under `/life-insurance`, `businesses` under `/businesses`, and so on. Review the discovered records there — balances, institution details, and statuses — using the corresponding guide for each asset type. ## Requesting a New Search Searches are initiated from the Sunset app today. An API endpoint for requesting searches programmatically is in development — see the [changelog](/changelog) for updates. ## Reviewing Searches Across All Your Cases Combine the cases list with per-case searches to sweep your whole book of business: ```bash theme={null} # 1. List your cases curl "https://api.example.com/v1/users/me/cases?sort_by=updated_at&sort_order=desc" # 2. For each case, check for newly completed searches curl ".../cases/{case_id}/searches?status=completed" ``` # Probate Guide Source: https://api.hellosunset.com/probate-guide Guide to probate reference data and case tracking in the Sunset API. # Probate Guide The Sunset API provides both **reference data** for probate requirements across all US states and counties, and **case tracking** tools to manage the probate process for individual estates. ## Two Parts of Probate in the API ### 1. Probate Reference Data (Read-Only) Top-level endpoints providing probate laws, requirements, fees, and forms by state and county: ``` /probate/states - All 50 states + DC + territories /probate/states/{state_code} - Full state probate details /probate/states/{state_code}/counties - Counties in a state /probate/states/{state_code}/counties/{slug} - Full county details /probate/states/{state_code}/forms - State probate forms ``` ### 2. Probate Case Tracking (Per Case) Case-level endpoints for tracking the probate process: ``` /cases/{case_id}/probate - Case probate details /cases/{case_id}/probate/deadlines - Deadlines and due dates /cases/{case_id}/probate/filings - Court filings /cases/{case_id}/probate/creditor-claims - Claims against the estate /cases/{case_id}/probate/distributions - Distributions to beneficiaries ``` ## Using Reference Data ### Look up state probate requirements ````bash theme={null} curl "https://api.example.com/v1/probate/states/UT"``` The response includes: - **Probate types available** (formal, informal, small estate affidavit, etc.) - **Thresholds** (small estate dollar limits) - **Creditor claim periods** and notice requirements - **Bond requirements** and waiver rules - **Executor compensation** methods and rates - **Spousal rights** (elective share, homestead, family allowance) - **Intestate succession** rules - **Will requirements** (witnesses, holographic acceptance, etc.) - **Tax information** (state estate tax, inheritance tax) ### Find the right county court ```bash curl "https://api.example.com/v1/probate/states/UT/counties/cache-county"``` The response includes: - **Court contact info** (address, phone, email, website) - **Filing fees** for every probate action - **Accepted payment methods** - **Electronic filing** availability and URL - **Required forms** with download links - **Average processing time** - **Hearing scheduling** details ### Get required forms ```bash curl "https://api.example.com/v1/probate/states/UT/forms?required_for=informal_probate"``` ## Tracking Probate for a Case ### 1. Set up probate case info ```bash curl -X PUT "https://api.example.com/v1/cases/{case_id}/probate" \ -H "Content-Type: application/json" \ -d '{ "state_code": "UT", "county_slug": "cache-county", "probate_type": "informal", "status": "not_filed", "attorney_name": "John Johnson", "attorney_firm": "Johnson & Associates", "attorney_phone": "+11112223333", "attorney_email": "john@johnsonlaw.com" }' ```` ### 2. Track deadlines ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/probate/deadlines" \ -H "Content-Type: application/json" \ -d '{ "title": "File estate inventory", "type": "inventory", "due_date": "2026-01-15", "is_court_ordered": true, "reminder_days_before": 14 }' ``` ### 3. Record court filings ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/probate/filings" \ -H "Content-Type: application/json" \ -d '{ "filing_type": "petition", "title": "Petition for Informal Probate", "filed_date": "2025-10-15", "filed_by": "John Johnson (Executor)", "court_response": "pending", "fees_paid": 360.00 }' ``` ### 4. Manage creditor claims ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/probate/creditor-claims" \ -H "Content-Type: application/json" \ -d '{ "creditor_name": "Springfield Medical Center", "claim_amount": 12500.00, "claim_date": "2025-11-01", "claim_type": "unsecured", "debt_description": "Outstanding medical bills", "status": "filed" }' ``` ### 5. Record distributions ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/probate/distributions" \ -H "Content-Type: application/json" \ -d '{ "person_id": "01K5XD09EJ7T44HRYE78AN7JKL", "recipient_name": "John Jonas Johnson", "relationship": "daughter", "asset_type": "cash", "amount_or_value": 25000.00, "method": "check", "status": "pending" }' ``` ## Probate Status Flow A typical probate case moves through these statuses: ``` not_filed -> filed -> hearing_scheduled -> letters_issued -> inventory_due -> creditor_period -> accounting_due -> distribution_pending -> closed ``` ## Common Probate Types | Type | Description | | -------------- | ------------------------------------------------------------ | | `formal` | Full court-supervised probate with hearings | | `informal` | Simplified process, minimal court involvement | | `small_estate` | Small estate affidavit (below state threshold) | | `summary` | Shortened process for small/simple estates | | `ancillary` | For property in a state other than the deceased's home state | | `supervised` | Court oversees every step | | `unsupervised` | Executor acts independently with court approval | # Real Estate Properties Guide Source: https://api.hellosunset.com/real-estate-guide Guide to managing real estate, title transfers, liens, and property disposition during estate settlement. # Real Estate Properties Guide The Sunset API helps you manage real property owned by the deceased, including primary residences, rental properties, and land. This guide covers property tracking, title analysis, and disposition. ## API Path ``` /cases/{case_id}/properties /cases/{case_id}/properties/{property_id} ``` ## Typical Workflow ### 1. Add properties to the case Record real estate as it is identified through deeds, tax records, or title searches: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/properties" \ -H "Content-Type: application/json" \ -d '{ "property_type": "primary_residence", "address": { "street": "123 Main Street", "city": "Salt Lake City", "state": "UT", "zip": "84101" }, "ownership_type": "sole_ownership", "title_vesting": "John J. Johnson, a single man", "estimated_value": 385000.00, "outstanding_mortgage": 142000.00, "mortgage_holder": "US Bank", "annual_property_tax": 3200.00, "parcel_number": "16-05-230-012", "deed_type": "warranty", "is_homestead": true, "requires_probate": true }' ``` ### 2. Record co-owners and liens Track other parties with interest in the property: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/properties/{property_id}" \ -H "Content-Type: application/json" \ -d '{ "co_owners": [ { "name": "John Johnson", "relationship": "son", "ownership_share": 50 } ], "liens": [ { "lien_type": "mortgage", "holder": "US Bank", "amount": 142000.00, "recorded_date": "2018-03-15" } ] }' ``` ### 3. Track disposition Update as the property is transferred or sold: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/properties/{property_id}" \ -H "Content-Type: application/json" \ -d '{ "status": "sold", "notes": "Sold for $395,000 on 2025-12-01. Mortgage paid off at closing." }' ``` ## Property Types | Type | Description | | --------------------- | ----------------------- | | `primary_residence` | Primary home | | `vacation_home` | Secondary/vacation home | | `investment_property` | Investment property | | `rental_property` | Income-producing rental | | `vacant_land` | Undeveloped land | | `commercial` | Commercial property | | `farm_ranch` | Agricultural property | | `mixed_use` | Mixed-use property | ## Ownership Types | Type | Description | | ------------------------ | ------------------------------------------------------------- | | `sole_ownership` | Deceased was sole owner (goes through probate) | | `joint_tenancy` | Joint Tenants with Right of Survivorship (passes to survivor) | | `tenants_in_common` | Tenants in Common (deceased's share goes through probate) | | `community_property` | Community property (state-dependent rules) | | `transfer_on_death_deed` | TOD deed (passes directly to beneficiary) | | `lady_bird_deed` | Enhanced life estate deed (avoids probate) | | `trust` | Held in a trust (passes per trust terms) | | `life_estate` | Life estate (remainder passes to designated party) | ## Deed Types | Type | Description | | ------------------- | ------------------------------------- | | `warranty` | Full warranty deed | | `quitclaim` | Quitclaim deed (no warranties) | | `grant` | Grant deed | | `special_warranty` | Special/limited warranty deed | | `transfer_on_death` | Transfer on death deed | | `lady_bird` | Lady Bird / enhanced life estate deed | ## Key Considerations * **Homestead exemptions** may protect the primary residence from creditors in many states. * **Joint tenancy with right of survivorship** passes automatically to the surviving owner outside of probate. * **Transfer on death deeds** are available in about 30 states and allow property to pass without probate. * **Mortgage obligations** continue after death. Heirs who inherit the property can usually assume the mortgage under federal law. * **Property taxes** must continue to be paid during estate settlement to avoid tax liens. * **Rental income** from investment properties should be collected and tracked as estate income. # Request Access Source: https://api.hellosunset.com/request-access Learn how to get access to the Sunset API. # Request API Access The Sunset API is currently available by invitation only. We're onboarding integration partners on a rolling basis. ## Who should apply? The API is designed for organizations that manage estate settlements at scale: * **Estate law firms** looking to automate case intake and probate workflows * **Financial advisory practices** that need to monitor estate accounts and distributions * **Trust companies** managing multiple estates simultaneously * **Insurance providers** automating claims verification and document collection * **Software companies** embedding estate management into existing platforms ## How to request access Send an email to [api\_request@hellosunset.com](mailto:api_request@hellosunset.com) with: * Your name and organization * A brief description of your intended use case * Estimated volume (number of estates managed per month) Our team will review your request and follow up within a few business days. ## What you'll receive Once approved, you'll get: * **API credentials** — a Bearer token for authentication * **Staging environment access** — a sandbox to build and test your integration * **Technical documentation** — full access to this API reference * **Developer support** — direct access to our engineering team during onboarding # Retirement Accounts Guide Source: https://api.hellosunset.com/retirement-guide Guide to managing retirement accounts, beneficiary designations, and distributions during estate settlement. # Retirement Accounts Guide The Sunset API helps you manage inherited retirement accounts including IRAs, 401(k)s, pensions, and TSP accounts. This guide covers the typical workflow from discovery through distribution. ## API Path ``` /cases/{case_id}/retirement-accounts /cases/{case_id}/retirement-accounts/{account_id} ``` ## Typical Workflow ### 1. Add discovered retirement accounts Record accounts as they are identified: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/retirement-accounts" \ -H "Content-Type: application/json" \ -d '{ "account_type": "401k", "custodian_name": "Fidelity Investments", "account_number": "Z99-876543", "status": "active", "balance": 185000.00, "employer_name": "Acme Corporation", "tax_treatment": "pre_tax", "rmd_required": false, "beneficiaries": [ { "name": "John Johnson", "relationship": "spouse", "percentage_share": 100, "designation": "primary" } ] }' ``` ### 2. Record distribution options Update the account with available distribution methods: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/retirement-accounts/{account_id}" \ -H "Content-Type: application/json" \ -d '{ "distribution_options": ["rollover_to_inherited_ira", "lump_sum", "life_expectancy"], "distribution_status": "in_progress" }' ``` ### 3. Track distribution completion ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/retirement-accounts/{account_id}" \ -H "Content-Type: application/json" \ -d '{ "distribution_status": "completed", "status": "distributed", "notes": "Rolled over to inherited IRA at Fidelity - account #INH-123456" }' ``` ## Account Types | Type | Description | | ------------------ | --------------------------------------- | | `traditional_ira` | Traditional IRA (pre-tax contributions) | | `roth_ira` | Roth IRA (post-tax contributions) | | `401k` | Employer-sponsored 401(k) | | `403b` | 403(b) for nonprofits/education | | `457` | 457 deferred compensation plan | | `sep_ira` | Simplified Employee Pension IRA | | `simple_ira` | SIMPLE IRA for small employers | | `pension` | Defined benefit pension | | `tsp` | Thrift Savings Plan (federal employees) | | `military_pension` | Military retirement pension | | `inherited_ira` | Previously inherited IRA | | `other` | Other retirement account | ## Distribution Options | Option | Description | | --------------------------- | -------------------------------------------------------- | | `lump_sum` | One-time full distribution | | `rollover_to_inherited_ira` | Roll into an inherited IRA | | `periodic_payments` | Scheduled periodic withdrawals | | `five_year_rule` | Distribute within 5 years | | `life_expectancy` | Stretch distributions over beneficiary's life expectancy | ## Key Considerations * **Beneficiary designations** override the will for retirement accounts. Named beneficiaries receive funds directly. * **Spousal beneficiaries** have the unique option to roll the account into their own IRA or treat it as their own. * **Non-spouse beneficiaries** under the SECURE Act generally must distribute inherited IRAs within 10 years. * **RMDs (Required Minimum Distributions)** may be required in the year of death if the deceased was over 73. * **Tax implications** vary significantly by account type. Traditional/pre-tax distributions are taxable income; Roth distributions are generally tax-free. * **Pensions** may offer survivor benefits depending on the election made at retirement. # Communication Tools Guide Source: https://api.hellosunset.com/tools-guide Phone calls, email, notarization, and fax tools for estate management. # Communication Tools Sunset provides integrated tools for communicating with financial institutions and handling legal documents. All tools are case-scoped and maintain a full audit trail. *** ## Phone Tool Make outbound calls to financial institutions via Twilio. Calls are automatically recorded, transcribed, and summarized by AI. ### Initiate a Call ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/phone-calls" \ -H "Content-Type: application/json" \ -d '{ "to_number": "+11112223333", "institution_contact_id": "01K8IC04DJ3T10HRYE78AN7DDD", "notes": "Calling to request account closure forms." }' ``` ### What Happens After a Call Once the call completes, the system automatically: 1. **Records** the full call audio 2. **Transcribes** the recording to text 3. **Summarizes** the call with AI, extracting key outcomes 4. **Extracts action items** from the conversation ### Retrieve Call Details ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/phone-calls/{call_id}"``` Response includes: ```json { "data": { "id": "...", "to_number": "+11112223333", "status": "completed", "duration_seconds": 342, "recording_url": "https://recordings.example.com/...", "recording_status": "completed", "transcript": "Agent: Thank you for calling Chase...", "summary": "Called Chase estate services. Spoke with John Johnson. He confirmed they received the death certificate. Letters Testamentary are still needed before they can release account info. Ref# EST-2025-00456.", "action_items": [ { "description": "Mail Letters Testamentary to Chase Estate Services", "completed": false }, { "description": "Call back in 5-7 business days after mailing", "completed": false } ] } } ```` ### Download Recording ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/phone-calls/{call_id}/recording" \ --output recording.mp3 ``` ### Call Statuses | Status | Description | | ------------- | ------------------------------------ | | `initiated` | Call request sent to Twilio | | `ringing` | Phone is ringing | | `in_progress` | Call is connected | | `completed` | Call ended normally | | `failed` | Call could not be completed | | `no_answer` | No one answered | | `busy` | Line was busy | | `cancelled` | Call was cancelled before connecting | *** ## Email Tool Send emails with forms and attachments from case documents. Delivery is tracked with read receipts. ### Send an Email ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/emails" \ -H "Content-Type: application/json" \ -d '{ "to_addresses": ["estates@chase.com"], "subject": "Estate of John J. Johnson - Death Certificate and Account Closure Request", "body_text": "Dear Estate Services,\n\nPlease find attached the death certificate and account closure form for the estate of John J. Johnson.\n\nCase Reference: EST-2025-00456\n\nThank you.", "attachment_document_ids": [ "01K5XB07CJ5T22HRYE78AN7DEF", "01K5XB08CJ5T33HRYE78AN7GHI" ], "institution_contact_id": "01K8IC04DJ3T10HRYE78AN7DDD" }' ``` ### Checking Delivery Status ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/emails/{email_id}"``` ### Email Receipt Get the delivery receipt with provider-level details: ```bash curl "https://api.example.com/v1/cases/{case_id}/emails/{email_id}/receipt"``` Response: ```json { "data": { "email_id": "...", "message_id": "msg_01abc123def456", "provider": "sendgrid", "status": "delivered", "sent_at": "2025-10-15T14:30:00Z", "delivered_at": "2025-10-15T14:30:05Z", "opened_at": "2025-10-15T15:12:00Z" } } ```` ### Email Statuses | Status | Description | | ----------- | --------------------------------------------------- | | `draft` | Email created but not yet sent | | `queued` | Queued for sending | | `sent` | Sent to email provider | | `delivered` | Confirmed delivered to recipient's server | | `bounced` | Delivery failed (invalid address, full inbox, etc.) | | `failed` | Could not be sent | *** ## Notarization Tool Initiate online notarization sessions powered by DocuSign's Notary API. Signers join a live video session with a commissioned notary. ### Initiate Notarization ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/notarizations" \ -H "Content-Type: application/json" \ -d '{ "document_id": "01K5XB07CJ5T22HRYE78AN7DEF", "title": "Small Estate Affidavit - Notarization", "description": "Online notarization for Cache County probate filing.", "signers": [ { "name": "John Jonas Johnson", "email": "john.johnson@example.com", "role": "signer" }, { "name": "John Jonas Johnson", "email": "john.johnson@example.com", "role": "witness" } ] }' ``` ### Notarization Flow ``` Create request -> Status: pending_signer (signers receive email with session link) Signer joins -> Status: pending_notary (waiting for notary to join) Session starts -> Status: in_session (live video notarization) Notary stamps -> Status: completed (notarized document available for download) ``` ### Download Notarized Document ```bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/notarizations/{id}/download" \ --output notarized_document.pdf ``` ### Notarization Statuses | Status | Description | | ---------------- | ------------------------------------- | | `draft` | Not yet sent to signers | | `pending_signer` | Waiting for signers to join | | `pending_notary` | Signer ready, waiting for notary | | `in_session` | Live notarization session in progress | | `completed` | Document notarized successfully | | `declined` | A signer or notary declined | | `expired` | Session expired before completion | | `failed` | Technical failure | *** ## Fax Tool One-click fax sending. Attach case documents and optionally include a cover page. ### Send a Fax ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/faxes" \ -H "Content-Type: application/json" \ -d '{ "to_number": "+11112223333", "institution_contact_id": "01K8IC04DJ3T10HRYE78AN7DDD", "document_ids": [ "01K5XB07CJ5T22HRYE78AN7DEF", "01K5XB08CJ5T33HRYE78AN7GHI" ], "cover_page": true, "cover_page_note": "Re: Estate of John J. Johnson. Please process enclosed death certificate and account closure form. Reference: EST-2025-00456." }' ``` ### Fax Receipt Get the delivery receipt with confirmation details: ````bash theme={null} curl "https://api.example.com/v1/cases/{case_id}/faxes/{fax_id}/receipt"``` Response: ```json { "data": { "fax_id": "...", "confirmation_number": "FAX-2025-1015-001", "pages_sent": 3, "duration_seconds": 45, "status": "confirmed", "remote_station_id": "CHASE FAX", "timestamp": "2025-10-15T14:35:00Z" } } ```` ### Fax Statuses | Status | Description | | ----------- | ---------------------------------------- | | `queued` | Fax queued for sending | | `sending` | Fax transmission in progress | | `delivered` | Fax confirmed delivered | | `failed` | Delivery failed (busy, no answer, error) | | `cancelled` | Fax cancelled before sending | # Unclaimed Property Guide Source: https://api.hellosunset.com/unclaimed-property-guide Guide to searching for and claiming unclaimed property from state databases during estate settlement. # Unclaimed Property Guide The Sunset API helps you track unclaimed property discovered through state databases. Every state holds billions in unclaimed assets from dormant accounts, uncashed checks, and forgotten deposits. This guide covers the search and claim process. ## API Path ``` /cases/{case_id}/unclaimed-property /cases/{case_id}/unclaimed-property/{property_id} ``` ## Typical Workflow ### 1. Record discovered unclaimed property After searching state databases, add discoveries to the case: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/unclaimed-property" \ -H "Content-Type: application/json" \ -d '{ "property_type": "dormant_bank_account", "state": "IL", "holder_name": "State of Illinois", "reported_amount": 1250.00, "property_description": "Dormant checking account", "owner_name_on_record": "JANE M DOE", "claim_status": "discovered", "claim_url": "https://icash.illinoistreasurer.gov", "required_documents": ["death_certificate", "letters_testamentary", "government_id"] }' ``` ### 2. File a claim Update the status when you submit a claim: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/unclaimed-property/{property_id}" \ -H "Content-Type: application/json" \ -d '{ "claim_status": "claim_filed", "claim_filed_date": "2025-10-25", "document_ids": ["01K9DOC001", "01K9DOC002", "01K9DOC003"], "notes": "Submitted online via state portal. Confirmation #CLM-2025-98765" }' ``` ### 3. Track claim resolution ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/unclaimed-property/{property_id}" \ -H "Content-Type: application/json" \ -d '{ "claim_status": "paid", "claim_approved_date": "2025-12-10", "claim_paid_amount": 1250.00 }' ``` ## Property Types | Type | Description | | ---------------------- | ------------------------------------------ | | `dormant_bank_account` | Inactive bank account turned over to state | | `uncashed_check` | Check that was never cashed | | `insurance_proceeds` | Unclaimed insurance payouts | | `utility_deposit` | Utility security deposit | | `rental_deposit` | Rental security deposit | | `safe_deposit_box` | Contents of abandoned safe deposit box | | `stocks_bonds` | Unclaimed stocks or bonds | | `retirement_account` | Unclaimed retirement funds | | `gift_card` | Unused gift card balance | | `mineral_rights` | Unclaimed mineral/oil rights royalties | | `wages` | Unclaimed wages or payroll | | `refund` | Unclaimed tax or other refund | ## Required Documents | Document | When Needed | | --------------------------- | ---------------------------------------- | | `death_certificate` | Always required | | `letters_testamentary` | If estate is in probate with a will | | `letters_of_administration` | If estate is in probate without a will | | `affidavit` | Small estate affidavit (when no probate) | | `government_id` | Executor/administrator photo ID | | `proof_of_heirship` | To establish heir relationship | ## Key Considerations * **Search all 50 states** where the deceased lived, worked, or had financial accounts. Don't limit searches to the state of residence. * **Name variations** matter. Search maiden names, middle names, misspellings, and initials. * **No deadline** to file in most states. Unclaimed property is held indefinitely in most jurisdictions. * **No fee** to claim. Never pay a "finder" to retrieve unclaimed property you can claim yourself for free through state portals. * **Processing time** varies widely from 2 weeks to 6+ months depending on the state and claim complexity. * **Multiple claims** can be filed across different states simultaneously. # Vehicles Guide Source: https://api.hellosunset.com/vehicles-guide Guide to managing vehicles, title transfers, and disposition during estate settlement. # Vehicles Guide The Sunset API helps you manage vehicles owned by the deceased, including cars, boats, RVs, and other titled property. This guide covers the workflow from inventory through title transfer. ## API Path ``` /cases/{case_id}/vehicles /cases/{case_id}/vehicles/{vehicle_id} ``` ## Typical Workflow ### 1. Add vehicles to the case Record each vehicle with title and valuation details: ```bash theme={null} curl -X POST "https://api.example.com/v1/cases/{case_id}/vehicles" \ -H "Content-Type: application/json" \ -d '{ "vehicle_type": "automobile", "year": 2019, "make": "Toyota", "model": "Camry SE", "vin": "4T1B11HK5KU123456", "license_plate": "ABC-1234", "registration_state": "UT", "title_status": "clean", "ownership_type": "sole_owner", "estimated_value": 18500.00, "valuation_source": "kelley_blue_book", "mileage": 45000, "condition": "good", "location": "Deceased residence - 123 Main Street, Salt Lake City" }' ``` ### 2. Record liens If a vehicle has a loan: ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/vehicles/{vehicle_id}" \ -H "Content-Type: application/json" \ -d '{ "title_status": "lien_present", "lien_holder": "Toyota Financial Services", "lien_payoff_amount": 8200.00 }' ``` ### 3. Decide disposition and transfer title ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/vehicles/{vehicle_id}" \ -H "Content-Type: application/json" \ -d '{ "disposition": "transfer_to_heir", "disposition_details": { "transferred_to": "John Jonas Johnson" }, "title_transfer_status": "dmv_paperwork_filed" }' ``` ### 4. Complete the transfer ```bash theme={null} curl -X PATCH "https://api.example.com/v1/cases/{case_id}/vehicles/{vehicle_id}" \ -H "Content-Type: application/json" \ -d '{ "title_transfer_status": "completed", "status": "transferred" }' ``` ## Vehicle Types | Type | Description | | ---------------------- | ------------------------------- | | `automobile` | Car, truck, SUV | | `motorcycle` | Motorcycle or scooter | | `recreational_vehicle` | RV or motorhome | | `boat` | Boat or watercraft | | `commercial_vehicle` | Commercial truck or van | | `classic_car` | Classic/antique vehicle | | `trailer` | Trailer (utility, travel, etc.) | | `off_highway_vehicle` | ATV, UTV, snowmobile | | `farm_equipment` | Tractor, combine, etc. | | `aircraft` | Airplane or helicopter | ## Disposition Options | Option | Description | | ------------------ | ------------------------- | | `keep` | Retain for estate use | | `transfer_to_heir` | Transfer to a beneficiary | | `sell` | Sell the vehicle | | `donate` | Donate to charity | | `junk` | Scrap/junk the vehicle | | `pending_decision` | Not yet decided | ## Valuation Sources | Source | Description | | ------------------ | ----------------------- | | `kelley_blue_book` | KBB valuation | | `nada` | NADA Guides valuation | | `edmunds` | Edmunds valuation | | `appraisal` | Professional appraisal | | `owner_estimate` | Owner/executor estimate | ## Key Considerations * **DMV requirements** vary by state. Most require a death certificate, letters testamentary, and a title transfer form. * **Joint ownership** vehicles typically pass to the surviving owner by presenting a death certificate at the DMV. * **Liens must be satisfied** before a title can be transferred. Contact the lien holder to arrange payoff. * **Insurance** should be maintained on vehicles until they are transferred or sold to protect the estate from liability. * **Registration** may need to be renewed during estate settlement. Some states offer temporary estate plates. * **Fair market value** at date of death is needed for estate tax purposes. KBB or NADA values are generally accepted.