Sign in
Account Activity Snapshots

Get account activity snapshot by ID

Returns a single account activity snapshot.

get/api/account-activity-snapshots/{id}

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/account-activity-snapshots/{id}
  • Auth: none required

Path parameters

idstring uuid required

Account activity snapshot ID

Response

Account activity snapshot

account_holder_idstring uuid required
closing_balanceinteger nullable

Balance at period end in minor currency units (camt:053 <Bal> ClosingBooked)

currencystring nullable

ISO 4217 3-letter currency code (e.g. USD, EUR, GBP)

external_referencestring nullable

Caller-supplied idempotency key (unique per tenant when set)

flagged_for_reviewboolean

AML review flag — true when activity patterns exceed FinCEN AML thresholds (31 CFR §1020.320 SAR requirements)

idstring uuid
inserted_atstring date-time
ledger_account_idstring uuid nullable

LedgerAccount scoping this snapshot (chart-of-accounts view)

opening_balanceinteger nullable

Balance at period start in minor currency units (camt:053 <Bal> OpeningBooked)

payment_account_idstring uuid nullable

PaymentAccount scoping this snapshot (camt:052/053 <Acct>)

period_endstring date-time required

End of the reporting period (inclusive)

period_startstring date-time required

Start of the reporting period (inclusive)

review_reasonstring nullable

Human-readable description of why this snapshot was flagged for AML review

sar_referencestring nullable

SAR (Suspicious Activity Report) filing reference (FinCEN SAR form 111)

snapshot_type'intraday' | 'daily' | 'weekly' | 'monthly' required

Reporting period type — intraday maps to camt:052 (on-demand report); daily/weekly/monthly map to camt:053 (periodic statement)

status'pending' | 'computed' | 'published' nullable

Snapshot lifecycle status — pending (queued), computed (aggregates ready), published (sent to downstream / regulatory reporting)

tenant_idstring uuid required
total_credit_amountinteger

Total credit amount in minor currency units (camt:052/053 <TtlNtries> TtlCdtNtries Amt)

total_credit_countinteger

Number of credit entries in the period (camt:052/053 <TtlNtries> CdtNb)

total_debit_amountinteger

Total debit amount in minor currency units (camt:052/053 <TtlNtries> TtlDbtNtries Amt)

total_debit_countinteger

Number of debit entries in the period (camt:052/053 <TtlNtries> DbtNb)

transaction_countinteger

Total number of transactions (debit + credit) in the period

updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "closing_balance": 0,
  "currency": "",
  "external_reference": "",
  "flagged_for_review": false,
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "ledger_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "opening_balance": 0,
  "payment_account_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "period_end": "2020-04-20T16:20:00Z",
  "period_start": "2020-04-20T16:20:00Z",
  "review_reason": "",
  "sar_reference": "",
  "snapshot_type": "intraday",
  "status": "pending",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "total_credit_amount": 0,
  "total_credit_count": 0,
  "total_debit_amount": 0,
  "total_debit_count": 0,
  "transaction_count": 0,
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

No recorded changes to this operation across all 4 revisions of this API.