Skip to content

RFIs

Reference for the 3 CryptoComply MCP tools in the RFIs family.

Tools in this group

rfi_create

Read-only: no.

Send a Request-For-Information to a client: a unique public link is generated and emailed asking them to provide specific fields and/or document types.

Two-step write tool. First call without confirm_token returns a dry-run preview + a 60-second token. Second call with the same arguments + confirm_token creates the RFI and queues the email. On success: {status: "ok", rfi_id, profile_id, unique_link}.

Parameters

  • organization_id (int, required) — Organization the profile belongs to.
  • profile_id (int, required) — Profile id to send the RFI to.
  • request_text (str, required) — Body of the request — shown to the client in the email.
  • requested_fields (list[str] | None, optional) — Profile-field names to request (e.g. ['date_of_birth', 'address']). Optional.
  • requested_documents (list[str] | None, optional) — ProfileAttachmentType codes (e.g. ['IDENTIFICATION', 'PROOF_OF_ADDRESS']). Optional.
  • additional_recipients (list[str] | None, optional) — Extra emails to CC on the request. Optional.
  • confirm_token (str | None, optional) — Token from a prior dry-run call. Omit on the first call.

rfi_list

Read-only: yes.

List Request-For-Information records sent for a profile, most recent first. Status is derived: sent (not opened), opened (client clicked the link), or responded (client submitted the form). Use when the analyst wants to see what KYC info has been asked of a client.

Parameters

  • organization_id (int, required) — Organization the profile belongs to.
  • profile_id (int, required) — Profile id (from profile_list.results[].id).
  • sort_by (Literal, optional) — Sort order. Prefix with '-' for descending (e.g. '-created_at' for newest first).
  • limit (int, optional) — Max results (1-100).
  • offset (int, optional) — Results to skip for pagination.

rfi_retrieve

Read-only: yes.

Get full details of one RFI: request body, requested fields/documents, recipient(s), and the client's response payload (field answers + additional information) when present.

Parameters

  • organization_id (int, required) — Organization the profile belongs to.
  • profile_id (int, required) — Profile id the RFI belongs to.
  • rfi_id (int, required) — RFI id (from rfi_list.results[].id).