Party Activity Snapshots

Get party activity snapshot by ID

Changed on
get/api/party-activity-snapshots/{id}

Request

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

Path parameters

idstring uuid required

Party activity snapshot ID

Response

Party activity snapshot

account_holder_idstring uuid required
high_risk_transaction_countinteger

Transactions exceeding risk thresholds

idstring uuid
inserted_atstring date-time
kyc_status_at_end'not_started' | 'in_progress' | 'approved' | 'rejected' | 'expired' nullable

AccountHolder.kyc_status at period close

kyc_status_at_start'not_started' | 'in_progress' | 'approved' | 'rejected' | 'expired' nullable

AccountHolder.kyc_status at period open

notesstring nullable

Free-text analyst notes

period_endstring date required

End of the reporting period (inclusive)

period_startstring date required

Start of the reporting period (inclusive)

period_type'daily' | 'weekly' | 'monthly' | 'quarterly' required

Reporting period cadence — daily/weekly/monthly snapshots feed ongoing CDD (FATF Rec 10); quarterly snapshots support SAR narrative evidence (FinCEN 31 CFR §1020.320).

risk_level_at_end'low' | 'medium' | 'high' | 'very_high' | 'prohibited' nullable

AccountHolder.risk_level at period close

risk_level_at_start'low' | 'medium' | 'high' | 'very_high' | 'prohibited' nullable

AccountHolder.risk_level at period open

sar_indicatorboolean

SAR (Suspicious Activity Report) filing consideration flag

screening_hitsinteger

Potential/confirmed screening matches

tenant_idstring uuid required
total_credit_amountinteger

Total credit amount (minor currency units)

total_debit_amountinteger

Total debit amount (minor currency units)

total_screeningsinteger

Compliance screenings run in the period

transaction_countinteger

Transactions in the period

updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "high_risk_transaction_count": 0,
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "kyc_status_at_end": "not_started",
  "kyc_status_at_start": "not_started",
  "notes": "",
  "period_end": "2020-04-20",
  "period_start": "2020-04-20",
  "period_type": "daily",
  "risk_level_at_end": "low",
  "risk_level_at_start": "low",
  "sar_indicator": false,
  "screening_hits": 0,
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "total_credit_amount": 0,
  "total_debit_amount": 0,
  "total_screenings": 0,
  "transaction_count": 0,
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      added the new prohibited enum value to the response property for the response status

    • warning

      added the new prohibited enum value to the response property for the response status