Skip to content

Country ​

Reference for the 6 CryptoComply MCP tools in the Country family.

Tools in this group ​

country_list ​

Read-only: yes.

List the countries this organization can pick: every ISO 3166-1 country, and the organization's own entries (custom jurisdictions, is_custom: true). Use to resolve alpha-2 codes (e.g. 'IR'), alpha-3 codes ('IRN') or names ('Iran') for profile creation, citizenship updates, jurisdiction audits, etc.; a country argument takes the alpha2 of any row, a custom entry's included. Optional query substring-matches the name and matches either code exactly (case-insensitive).

By default every country comes in one page, so a country missing from it is not in the list.

Parameters

  • organization_id (integer, required) — Organization scope.
  • query (string, optional) — Case-insensitive substring matched against english_name, or an exact alpha2 or alpha3 code. Omit to return all countries.
  • limit (integer, optional) — Max results.
  • offset (integer, optional) — Results to skip.

country_risk_bulk_update ​

Read-only: no.

Set or reset the risk level of many countries at once (e.g. from a document the person shares) for the organization, or for one group. Map every row of the document to rows: the country as the document names it (code, alpha-3 or name; the organization's own entries too) and its level, null to remove this scope's level. Call once for the organization, then once per group with its group_id. The preview groups the changes by level, counts the countries already at their level and lists each name not in the country list, with suggestions, and each own entry a null level would leave without an organization level; those are left out. A country's level in force is the group's when the group sets one, else the organization's, else the platform's default. Nothing uses the level yet: it changes no profile's risk, screening or alert. Answers how many countries changed.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • rows (array[CountryLevelRow], required) — Each country once, with the level to give it (null removes this scope's level).
  • group_id (integer, optional) — Group id (from group_list). The group whose levels to use; omit for the organization's.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.

country_risk_delete ​

Read-only: no.

Reset a country's risk level for the organization, or for one group: remove the level that scope set, so the next tier applies (the organization's level or the default). A country's level in force is the group's when the group sets one, else the organization's, else the platform's default. Refused when that scope sets no level for the country, and for an own entry's organization level, which it always keeps (a group's level on it can be reset). Answers with the country's levels.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • country (string, required) — The country: its code (e.g. 'VE'), alpha-3 code or name, or an own entry's code or name.
  • group_id (integer, optional) — Group id (from group_list). The group whose levels to use; omit for the organization's.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.

country_risk_list ​

Read-only: yes.

List the country risk levels (jurisdiction risk) of the organization, or of one group: for each country of the organization's list, the level in force (low, medium, high, severe) and where it comes from (source: default, organization or group), the default, and each tier's own level. A country's level in force is the group's when the group sets one, else the organization's, else the platform's default. An own entry has no default, so it always keeps an organization level. Every country comes in one page; query keeps the countries whose name contains it or whose code is it.

Parameters

  • organization_id (integer, required) — Organization scope.
  • group_id (integer, optional) — Group id (from group_list). The group whose levels to use; omit for the organization's.
  • query (string, optional) — Part of a country's name, or its code.
  • limit (integer, optional) — Max results.
  • offset (integer, optional) — Results to skip.

country_risk_retrieve ​

Read-only: yes.

Read the risk level of one country (e.g. Venezuela's) for the organization, or for one group: the level in force and where it comes from, the default, and each tier's own level. A country's level in force is the group's when the group sets one, else the organization's, else the platform's default.

Parameters

  • organization_id (integer, required) — Organization scope.
  • country (string, required) — The country: its code (e.g. 'VE'), alpha-3 code or name, or an own entry's code or name.
  • group_id (integer, optional) — Group id (from group_list). The group whose levels to use; omit for the organization's.

country_risk_update ​

Read-only: no.

Set the risk level of one country (e.g. set Venezuela to high) for the organization, or for one group. A country's level in force is the group's when the group sets one, else the organization's, else the platform's default. A country already set takes the new level. Nothing uses the level yet: it changes no profile's risk, screening or alert. Answers with the country's levels.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • country (string, required) — The country: its code (e.g. 'VE'), alpha-3 code or name, or an own entry's code or name.
  • level (string, required) — (no description)
  • group_id (integer, optional) — Group id (from group_list). The group whose levels to use; omit for the organization's.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.