Skip to content

Organization ​

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

Tools in this group ​

organization_brand_apply ​

Read-only: no.

Bring every intake form of the organization over to the brand's palette: each form's theme takes its colors (fonts, sizes and corners stay) and each form's emails drop their own colors so they use the palette. Logos and wording stay. The public pages change immediately. Needs a saved palette.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.

organization_brand_retrieve ​

Read-only: yes.

The organization's brand: the palette (primary, background, text), logo and footer details every external email (requests for information, intake form invitations and reminders) is drawn in, and every new intake form starts from. readability says for each pair of palette colors whether a reader can tell them apart, and what to change when not. Change it with organization_brand_update.

Returns {palette, logo_url, logo_width, logo_align, company_name, company_address, support_contact, email_colors, readability: [{pair, pair_label, is_readable, advice, ratio, minimum}]}.

Parameters

  • organization_id (integer, required) — Organization scope.

organization_brand_update ​

Read-only: no.

Change the organization's brand: every external email sent from now on, and every new intake form, uses it. Send only what changes; a footer detail sent empty is cleared. Choosing a palette replaces the default email template's own colors. Existing intake forms keep their theme until organization_brand_apply. Ask the person for their hex colors rather than inventing them; the preview says which pairs would be hard to read. use_organization_logo copies the organization's own logo into the emails; another image is uploaded in Settings.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • palette (object, optional) — All three colors, e.g. {"primary": "#1a3d7c", "background": "#f4f5f7", "text": "#1f2937"}.
  • logo_width (integer, optional) — The logo's width in pixels.
  • logo_align (string, optional) — Where the logo sits in the header.
  • company_name (string, optional) — The sender's name in the footer, one line.
  • company_address (string, optional) — The sender's address in the footer.
  • support_contact (string, optional) — An email address or https link the footer offers.
  • use_organization_logo (boolean, optional) — Show the organization's own logo in every external email.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.

organization_email_template_update ​

Read-only: no.

Customize the organization's default invitation emails, which every intake form inherits where it customizes nothing. Applies to every email sent from now on. Updated key by key: keys you send are set, keys you leave out are kept, and a key sent as null returns to the inherited value (branding: null or ""). An email type sent as {} returns to the inherited wording entirely. Shape and caps: intake_form_authoring_rules (email_template).

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • email_branding (object, required) — Per-email-type changes, e.g. {"invitation_public": {"subject": "Complete your onboarding"}, "branding": {"accent_color": "#1a73e8"}}.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.

organization_profile_retrieve ​

Read-only: yes.

How the organization describes itself: what it does, its business type, products and services, customers, the countries it operates in (ISO 3166-1 alpha-2 codes, or the codes of its own entries), its licenses and registrations, its website and other names it is known by. Change it with organization_profile_update.

Returns {organization_id, description, website_url, business_type, products_and_services, customer_types, operating_countries, regulatory_licenses, trade_names}; a field left empty is null.

Parameters

  • organization_id (integer, required) — Organization scope.

organization_profile_update ​

Read-only: no.

Change how the organization describes itself. Send only what changes: a text sent empty is cleared, and a list sent replaces the stored one (empty clears it). Country codes are ISO 3166-1 alpha-2, or the code of one of the organization's own entries from country_list; duplicates and blank trade names are dropped. Members and the assistant read it as the organization's own words.

Previews first.

Parameters

  • organization_id (integer, required) — Organization scope.
  • description (string, optional) — What the organization does, in a few sentences.
  • website_url (string, optional) — Its website, an http(s) URL.
  • business_type (string, optional) — The kind of business, e.g. 'Crypto exchange'.
  • products_and_services (string, optional) — The products and services it offers.
  • customer_types (string, optional) — Who it serves, e.g. retail customers or institutions.
  • operating_countries (array[string], optional) — Where it operates, as ISO 3166-1 alpha-2 codes or the organization's own entries' codes, e.g. ['US', 'GB'].
  • regulatory_licenses (string, optional) — The licenses and registrations it holds, and with whom.
  • trade_names (array[string], optional) — Other names it is known by.
  • confirm_token (string, optional) — From this tool's preview; omit to get one.