Account
A deposit account: one balance in the ledger, on one product version, owned by one or more customers and reachable through one or more account numbers.
OBJECTThe Account objectA deposit account: one balance in the ledger, on one product version, owned by one or more customers and reachable through one or more account numbers.POSTCreate an account
/accounts · Open an account; a consumer (person) product needs the acknowledgement of its opening documents, and electronic delivery the E-SIGN consentGETList all accounts/accounts · List accountsPOSTRun the monthly fee, withholding and statement cycle for a period/accounts/cyclesPOSTReturn every outstanding sweep from an earlier business date to its demand deposit/accounts/deposit-sweep-returnsPOSTSweep every configured account's end-of-day balance above its target into the internal sweep vehicle/accounts/deposit-sweep-runsPOSTReview every account for dormancy and list escheat candidates by state/accounts/dormancy-runsPOSTRenew or pay out every certificate past its maturity and grace period, recording the Reg DD maturity notice that preceded each renewal/accounts/maturitiesPOSTIssue the Reg DD 1030.5(b) maturity notice for renewing certificates maturing 30 to 60 days out/accounts/maturity-notice-runsGETList current opt-ins awaiting confirmation delivery/accounts/overdraft-confirmationsPOSTRepay outstanding advances from available deposits/accounts/overdraft-repaymentsPOSTRetry a bounded batch of durable consumer deposit privacy relationship deliveries/accounts/privacy-relationship-runs · Deposit servicing staff with accounts:servicing:write or service with accounts:write requiredPOSTReport notice deadlines and activate a bounded page of due notices/accounts/product-notice-runsGETList product notices and outstanding notice work/accounts/product-noticesPOSTVerify an exact retained retirement or contractual-fee journal for the restricted ledger verifier/accounts/protected-movement-proofs · Internal actual svc_ledger service identity with only accounts:protected:verify and no API keyGETList statement deliveries by status for dispatch and paper fulfilment/accounts/statement-deliveriesPOSTGenerate, issue and dispatch a bounded page of account statements/accounts/statement-runsGETGet an account by ID/accounts/{id} · Get an accountPOSTCapture exact confidential account ownership and time coverage for an approved request and native candidate set/accounts/information-requests/search · Confidential bounded 314(a) request custodyPOSTCheck an original customer identity's account permission (internal)/accounts/{id}/access-checksPOSTCreate an account number/accounts/{id}/account-numbersPOSTAssess an eligible fee for a committed card clearing/accounts/{id}/card-overdraft-feesGETRead minimal verified cardholder eligibility/accounts/{id}/cardholder-eligibilityPOSTClose an empty account (optional Idempotency-Key replays the recorded outcome)/accounts/{id}/closePOSTSettle final interest and pay the remaining balance to the same owner's account/accounts/{id}/closureGETRead closure and payout evidence/accounts/{id}/closureGETRead captured official-check instructions for bank processing/accounts/{id}/closure-payoutPOSTCreate a credit (branch, teller or ITM deposit; Reg CC availability by kind)/accounts/{id}/creditsPOSTPropose an account debit restriction or its release after reviewing a confirmed death/accounts/{id}/death-controls · Staff evidence onlyGETList staff evidence and decisions for account death controls/accounts/{id}/death-controls · Staff evidence onlyPOSTWithdraw from a certificate inside its term, forfeiting the product's days of interest/accounts/{id}/early-withdrawalsPOSTRecord the due-diligence notice sent to a dormant account's owner/accounts/{id}/escheat-noticesPOSTClose an abandoned account into an exact state payable for separately evidenced outward remittance/accounts/{id}/escheatmentsPOSTPropose an evidenced estate or complete POD allocation for independent review/accounts/{id}/estate-disbursements · Fresh dedicated accounts:estate:write staff identity; then different accounts:estate:approve reviewerGETList evidenced estate/POD cash disbursements and retained ledger receipts/accounts/{id}/estate-disbursements · Fresh dedicated accounts:estate:read staff identityPOSTPlace a Reg CC exception hold/accounts/{id}/exception-holdsGETList exception holds and notices/accounts/{id}/exception-holdsGETList an account's fees/accounts/{id}/feesPOSTFreeze an account (optional Idempotency-Key replays the recorded outcome)/accounts/{id}/freezePOSTConvert on an unexpired quote the same customer was given on this account, once (fresh step-up; Idempotency-Key bound to the quote)/accounts/{id}/fx-conversions · The customer who obtained the quote on this account converts it, with authentication within five minutes (step_up_required, 403) and an Idempotency-Key bound to the quotePOSTQuote a conversion from this account to another of the customer's deposit accounts in a different currency, on the bank's approved customer rate sheet (the customer's own instruction; Idempotency-Key bound to the request)/accounts/{id}/fx-quotes · The customer's own instruction: a customer token (not an API key) with initiate permission on this account and on target_account_id; staff and services are refused 403POSTRecord a served garnishment, levy or child-support order once (Idempotency-Key; an issuer's reference is served once) and freeze what it reaches after the federal benefits found in the lookback/accounts/{id}/garnishmentsGETList an account's archived certificate maturity notices/accounts/{id}/maturity-noticesGETThe immutable acknowledgement a consumer account opened on: document versions and hashes, method, delivery, E-SIGN consent, verified actor and time (staff or service identity)/accounts/{id}/opening-evidenceGETRead account-wide overdraft consent and confirmation/accounts/{id}/overdraft-consentPUTOpt in or revoke ATM and one-time debit overdraft consent/accounts/{id}/overdraft-consentPOSTCover or return an item/accounts/{id}/overdraft-decisionsGETList overdraft decisions/accounts/{id}/overdraft-decisionsGETRead overdraft protection/accounts/{id}/overdraft-protectionPUTSet overdraft protection/accounts/{id}/overdraft-protectionPOSTRetitle an account: payable-on-death beneficiaries, trust, estate, UTMA, IOLTA, HSA, IRA, custodial/accounts/{id}/ownershipPOSTPrepare and archive a fee or limit change notice/accounts/{id}/product-noticesGETList an account's product notices/accounts/{id}/product-noticesPOSTCapture final December ledger cut for independent retirement FMV review/accounts/{id}/retirement-annual-positions · Fresh retirement writer then independent retirement approverGETList retained final year-end cash positions/accounts/{id}/retirement-annual-positionsPOSTPropose a classified cash contribution, distribution, excess return, original-receipt rollover or same-wrapper trustee transfer/accounts/{id}/retirement-commands · Fresh dedicated retirement writer, then different retirement approverGETList reviewed classified retirement monetary commands and ledger receipts/accounts/{id}/retirement-commandsPOSTPropose receiving a direct trustee-to-trustee transfer from another custodian for independent review/accounts/{id}/retirement-inbound-transfers · Fresh dedicated retirement writer, then a different retirement approverGETList inbound direct transfer instructions from other custodians and their confirmations/accounts/{id}/retirement-inbound-transfersPOSTClassify one captured beneficiary and fix the inherited distribution schedule for independent review/accounts/{id}/retirement-inheritances · Fresh dedicated retirement writer, then a different retirement approverGETList beneficiary classifications of a deceased holder's IRA or HSA/accounts/{id}/retirement-inheritancesPOSTCalculate an inherited IRA's annual requirement from the prior year-end position and reviewed Single Life Table/accounts/{id}/retirement-inherited-rmd-reviews · Fresh retirement writer then independent approverGETList inherited IRA required minimum distribution reviews/accounts/{id}/retirement-inherited-rmd-reviewsPOSTRecord affirmative owner tax-specific format-access consent or a written withdrawal confirmation/accounts/{id}/retirement-tax-delivery-consent · Actual bound sole-owner session onlyGETRead the current owner tax-specific electronic delivery election/accounts/{id}/retirement-tax-delivery-consentGETServe the reviewed electronic tax disclosure in the delivery format and retain bound access evidence/accounts/{id}/retirement-tax-delivery-notice · Actual bound sole-owner session with accounts:read and policy_id requiredPOSTRecord actual paper dispatch or electronic availability-notification evidence for the exact approved copy/accounts/{id}/retirement-tax-furnishings · Fresh retirement writer, then different retirement approverGETList separately reviewed paper or electronic tax-furnishing evidence/accounts/{id}/retirement-tax-furnishingsPOSTAssemble complete supported annual retirement form boxes from proved cash sources and retained taxpayer identity/accounts/{id}/retirement-tax-packets · Assembles supported 5498, 5498-SA, 1099-R and 1099-SA boxes from an approved sealed year-end cash position, actual classified journal receipts and a separately encrypted immutable taxpayer-identity snapshotGETList immutable retirement annual packets and their review status/accounts/{id}/retirement-tax-packetsGETRead posted retirement contribution/distribution source evidence for information reporting/accounts/{id}/retirement-tax-records · Fresh dedicated retirement reader or actual svc_reporting with accounts:retirement:readGETRead electronic statement consent/accounts/{id}/statement-consentPUTGrant or withdraw electronic statement consent/accounts/{id}/statement-consentGETRead an account's investment-sweep configuration/accounts/{id}/sweep-configurationPUTSet or replace a demand-deposit account's investment-sweep configuration (enabled, target balance, internal vehicle)/accounts/{id}/sweep-configurationGETList an account's end-of-day sweep movements and their next-morning returns/accounts/{id}/sweep-movementsGETList an account's transactions with running balance/accounts/{id}/transactionsPOSTUnfreeze an account (optional Idempotency-Key replays the recorded outcome)/accounts/{id}/unfreezeGETList business account users and permissions/accounts/{id}/usersGETRead the retained cycle progress or complete report/accounts/cycles/periods/{period}GETA business checking account's analysis for a period: fees, earnings credit and the net charged/accounts/{id}/analysis/{period}GETRead an account death control and independent decision/accounts/{id}/death-controls/{control} · Staff evidence onlyGETRead a posted currency conversion from or to this account/accounts/{id}/fx-conversions/{conversion} · Read permission on this account, which must be the conversion's source or targetPOSTCreate an overdraft opt-in disclosure/accounts/{id}/overdraft-consent/offersGETRead captured terms and notice evidence/accounts/{id}/product-notices/{notice}POSTCreate a PDF access challenge with electronic delivery disclosures/accounts/{id}/statement-consent/challengesGETGet a period statement/accounts/{id}/statements/{period}PUTSet or revoke a business account user's role and payment limit/accounts/{id}/users/{user}GETList retained per-account cycle outcomes, optionally by status (pending, complete, failed)/accounts/cycles/periods/{period}/accountsPOSTIndependently approve or reject an account death control/accounts/{id}/death-controls/{control}/decisions · Staff evidence onlyPOSTIndependently fence an unposted estate instruction or recover already committed money/accounts/{id}/estate-disbursements/{command}/cancellations · Fresh independent estate reviewer must resolve/fence the svc_accounts-owned ledger cancellation key before cancellingPOSTIndependently decide a succession disbursement with exact authority and recipient evidence/accounts/{id}/estate-disbursements/{command}/decisionsPOSTExecute or recover actual estate/POD book entries while retaining death restrictions/accounts/{id}/estate-disbursements/{command}/executions · Captures an immutable exact balanced estate_disbursement journal before postingGETDownload an archived maturity notice/accounts/{id}/maturity-notices/{notice}/pdfPOSTRecord customer receipt or staff evidence of confirmation delivery/accounts/{id}/overdraft-consent/{consent}/confirmationGETRead the opt-in confirmation PDF/accounts/{id}/overdraft-consent/{consent}/pdfPOSTActivate delivered product terms on their effective date/accounts/{id}/product-notices/{notice}/activationPOSTApprove a notice with a different authenticated staff identity/accounts/{id}/product-notices/{notice}/approvalPOSTCancel a notice before activation/accounts/{id}/product-notices/{notice}/cancellationPOSTRecord an owner's actual notice delivery evidence/accounts/{id}/product-notices/{notice}/deliveryGETDownload the archived product notice/accounts/{id}/product-notices/{notice}/pdfPOSTIndependently review an exact year-end ledger position/accounts/{id}/retirement-annual-positions/{position}/decisionsPOSTIndependently cancel an unposted retirement command after resolving the ledger idempotency key/accounts/{id}/retirement-commands/{command}/cancellations · Fresh retirement approver distinct from makerPOSTIndependently approve or reject an IRA/HSA cash movement with tax classification/accounts/{id}/retirement-commands/{command}/decisionsPOSTExecute or repair a reviewed retirement command through a journal-bound protected ledger proof/accounts/{id}/retirement-commands/{command}/executions · Captures immutable exact journal and capacity reservation before postingPOSTSend the approved transfer request to the delivering custodian and retain its validation or exception/accounts/{id}/retirement-inbound-transfers/{transfer}/custodian-requests · Fresh retirement writerPOSTIndependently approve or reject an inbound transfer instruction/accounts/{id}/retirement-inbound-transfers/{transfer}/decisionsPOSTIndependently approve or reject a beneficiary classification/accounts/{id}/retirement-inheritances/{inheritance}/decisionsPOSTIndependently approve or reject an inherited RMD review/accounts/{id}/retirement-inherited-rmd-reviews/{review}/decisionsGETReconcile an inherited requirement to executed inherited distributions and the final-year balance/accounts/{id}/retirement-inherited-rmd-reviews/{review}/status · Counts executed inherited distributions with captured cash dates in the requirement year; unresolved attempts refuse a determinationPOSTIndependently decide tax-furnishing evidence after rechecking the approved packet and active electronic consent/accounts/{id}/retirement-tax-furnishings/{furnishing}/decisionsPOSTIndependently review exact annual retirement form and recipient-copy bytes/accounts/{id}/retirement-tax-packets/{packet}/decisions · Fresh dedicated retirement approver different from the makerGETExport approved annual form boxes and exact retained full taxpayer identity under fresh tax authority/accounts/{id}/retirement-tax-packets/{packet}/export · Fresh human retirement reader also holding customers:tax:readGETRead the exact retained printable recipient copy without claiming delivery or IRS filing/accounts/{id}/retirement-tax-packets/{packet}/recipient-copy · Actual bound sole owner may retrieve the exact approved historical printable HTML, including after a correction or delivery-consent withdrawalGETRead the issued statement and its hash/accounts/{id}/statements/{period}/archivePOSTPrepare an immutable correction for independent review/accounts/{id}/statements/{period}/correctionsGETList staff correction evidence/accounts/{id}/statements/{period}/correctionsPOSTDeliver an issued statement notice or queue paper delivery/accounts/{id}/statements/{period}/deliveryGETRead statement delivery status/accounts/{id}/statements/{period}/deliveryPOSTGenerate a draft statement from the ledger/accounts/{id}/statements/{period}/generationsPOSTIssue and archive an immutable statement PDF/accounts/{id}/statements/{period}/issuesGETDownload the latest issued statement PDF/accounts/{id}/statements/{period}/pdfGETList issued statement versions/accounts/{id}/statements/{period}/versionsGETRead the overdraft disclosure PDF/accounts/{id}/overdraft-consent/offers/{offer}/pdfGETDownload the electronic consent verification PDF/accounts/{id}/statement-consent/challenges/{challenge}/pdfGETRead a correction proposal and review/accounts/{id}/statements/{period}/corrections/{correction}POSTRecord a provider or paper delivery outcome/accounts/{id}/statements/{period}/delivery/evidenceGETRead statement delivery evidence/accounts/{id}/statements/{period}/delivery/evidenceGETRead a specific issued statement version/accounts/{id}/statements/{period}/versions/{version}POSTRerun one failed cycle account after its cause is fixed; completes the cycle when it was the last outstanding/accounts/cycles/periods/{period}/accounts/{id}/reconciliationsGETDownload a proposed correction PDF/accounts/{id}/statements/{period}/corrections/{correction}/pdfPOSTApprove and issue or reject a correction/accounts/{id}/statements/{period}/corrections/{correction}/reviewsPOSTDispatch a specific statement version/accounts/{id}/statements/{period}/versions/{version}/deliveryGETRead delivery for a specific statement version/accounts/{id}/statements/{period}/versions/{version}/deliveryGETDownload an immutable issued statement version/accounts/{id}/statements/{period}/versions/{version}/pdfPOSTRecord delivery evidence against an exact version/accounts/{id}/statements/{period}/versions/{version}/delivery/evidenceGETRead delivery evidence for a specific version/accounts/{id}/statements/{period}/versions/{version}/delivery/evidence