Appearance

Group ​

Reference for the 7 CryptoComply MCP tools in the Group family.

Tools in this group ​

group_create ​

Read-only: no.

Create a new group. It starts with a weekly re-screening schedule at every risk level, so each profile and wallet placed in it is screened again every week until the schedule is changed with group_screening_schedule_update.

Previews first.

Parameters

  • organization_id (int, required) — Organization scope.
  • name (str, required) — Group name (unique per org).
  • description (str, optional) — Free-text description.
  • screening_min_score (float | None, optional) — Lowest match score (0.50-1.00) a watchlist match needs to count as a hit in this group's screenings; lower means more alerts.
  • confirm_token (str | None, optional) — From this tool's preview; omit to get one.

group_field_schema_retrieve ​

Read-only: yes.

Read a group's field layout — the source of truth for what the group collects. Returns the compiled schema (both profile types, each section with its fields carrying visible / order / field_label / externally_requestable / is_custom) AND the editable sections_configuration layout to base edits on: the group's own, or the full default layout when it has none, so an edit never silently deletes a section by omission.

A field is offerable — requestable in an RFI (rfi_create) and askable in an intake form — only when it is visible AND externally_requestable; use those two flags to pick valid requested_fields. Visibility also governs the profile page (a hidden field that already holds data is still shown and enforced, with a warning) and blocks publishing an intake form that asks a hidden field. Edit visibility with group_sections_edit; add a new org custom field with custom_field_create.

Returns {group_id, schema, sections_configuration}.

Parameters

  • organization_id (int, required) — Organization scope.
  • group_id (int, required) — Group id (from group_list).

group_list ​

Read-only: yes.

List groups for an organization. Groups bundle screening schedules, the minimum match score, and section visibility — every Profile belongs to one. Use to discover valid group_id values for other tools and to read group-level configuration.

Parameters

  • organization_id (int, required) — Organization scope.
  • sort_by (Literal, optional) — '-' prefix = descending.
  • limit (int, optional) — Max results.
  • offset (int, optional) — Results to skip.

group_retrieve ​

Read-only: yes.

Get full details of one group: thresholds, section visibility, field configuration, and counts of profiles + blockchain addresses scoped to it.

Parameters

  • organization_id (int, required) — Organization scope.
  • group_id (int, required) — Group id (from group_list).

group_screening_schedule_update ​

Read-only: no.

Change how often the group's profiles and wallets are re-screened, per screening type and risk rating. Pass only the rows to change.

schedules is a list of {screening_type, risk_rating, frequency}. These take the stored values, not enum names — screening_type is 'Wallet' (blockchain addresses) or 'Party Screening'; risk_rating is 'Unknown' (Wallet only), 'Low', 'Medium', 'High', or 'Severe'; frequency is N (none), D, W, M, Q or Y. A (type, rating) combo the group has no schedule for is rejected.

A 'Party Screening' change moves every profile in the group at that risk to the new frequency, and a 'Wallet' change every address whose last screening has that risk, replacing a frequency set by hand; declined, archived and inactive profiles keep their screening off. The preview counts what each change reschedules.

Previews first.

Parameters

  • organization_id (int, required) — Organization scope.
  • group_id (int, required) — Group id (from group_list).
  • schedules (list, required) — Rows to change.
  • confirm_token (str | None, optional) — From this tool's preview; omit to get one.

group_sections_edit ​

Read-only: no.

Show, hide, reorder or move fields and sections in a group's profile layout, sending only the changes; read the keys with group_field_schema_retrieve first. Hiding a field hides it on the group's profiles (unless it already holds data) and drops it from RFIs and intake forms, so a form that asks it can't be published. The preview names each change.

Previews first.

Parameters

  • organization_id (int, required) — Organization scope.
  • group_id (int, required) — Group id (from group_list).
  • operations (list, required) — Applied in order, all or none. Each has op and profile_type: set_field {field, visible?, order?, section?}; set_section {section, visible?, order?, label?}; add_section {section, label?, visible?, order?}; move_field {field, to_section}. Fields must already exist; add new ones with custom_field_create.
  • confirm_token (str | None, optional) — From this tool's preview; omit to get one.

group_update ​

Read-only: no.

Update a group's name, description or minimum match score. A new score applies to the group's future screenings only: nothing is screened again now and existing hits and alerts stay as they are. A lower score means more matches, so more alerts.

For the rest of the group's configuration use the dedicated tools: group_screening_schedule_update (how often its profiles and wallets are re-screened) and group_sections_edit (field/section visibility, order, labels, custom sections — read the current layout first with group_field_schema_retrieve). Exposure / identification-risk THRESHOLDS are NOT editable via MCP yet — configure them in the Risk Engine UI.

All fields optional. Previews first.

Parameters

  • organization_id (int, required) — Organization scope.
  • group_id (int, required) — Group id (from group_list).
  • name (str | None, optional) — New group name.
  • description (str | None, optional) — New description.
  • screening_min_score (float | None, optional) — Lowest match score (0.50-1.00) a watchlist match needs to count as a hit in this group's screenings; lower means more alerts.
  • confirm_token (str | None, optional) — From this tool's preview; omit to get one.