RiskAccountTask

  • id
    Type: string
    required

    Unique identifier of the risk task.

  • requirement_id
    Type: string

    Identifier of the underlying requirement that triggered this task.

  • kind
    Type: "document_upload" or "kyc_info" or "agreement"enum
    required

    The type of remediation task required for the account.

  • blocking
    Type: boolean
    required

    Whether this task blocks the account until completed.

  • status
    Type: "action_required" or "optional" or "info"enum
    required

    The current status of the task.

  • title
    Type: string

    Human-readable task title for account status and remediation UIs.

  • description
    Type: string

    Optional short explanation of why the task is present.

  • banner_type
    Type: string

    Stable presentation category that helps clients group or label similar remediation tasks.

  • body
    Type: RiskAccountTaskBody

    Generic body content that can be rendered by hosted or partner remediation UIs.

    Properties: 2
  • cta
    Type: RiskAccountTaskCta

    Suggested primary call to action for this task.

    Properties: 3
  • resolution_path
    Type: "account_update" or "agreement_acceptance" or "contact_support"enum

    Stable remediation route category that tells clients which flow can resolve the task.

  • remediation_link_params
    Type: RiskAccountTaskRemediationLinkParams

    Optional hosted remediation routing hints for dashboard or embedded account update flows.

    Properties: 1
  • requirements
    Type: array of RiskAccountTaskRequirement

    Field-level requirements represented by this task.

    Properties: 7
  • error_messages
    Type: array of RiskAccountTaskErrorMessage

    Requirement-specific errors that explain why previously submitted information did not satisfy the task.

    Properties: 3
  • affected_capabilities
    Type: array of RiskAccountTaskAffectedCapability

    Capabilities that can be affected if the task is not resolved.

    Properties: 3
  • agreement_bundle
    Type: AgreementBundle

    Agreement content that must be reviewed and accepted when the task kind is agreement.

    Properties: 4