RiskAccountStatus

  • blocking
    Type: boolean
    required

    Whether the current account status prevents the account from operating normally.

  • status
    Type: string enum
    required

    The overall risk status of the account. ok means no outstanding blocking risk issues exist. action_required means the account has pending remediation tasks. restricted means the account is currently limited due to unresolved risk or compliance requirements.

    values
    • action_required
    • restricted
    • ok
  • tasks
    Type: array object[] · RiskAccountTask[]

    The list of outstanding risk or compliance tasks required for the account.

    • blocking
      Type: boolean
      required

      Whether this task blocks the account until completed.

    • id
      Type: string
      required

      Unique identifier of the risk task.

    • kind
      Type: string enum
      required

      The type of remediation task required for the account.

      values
      • document_upload
      • kyc_info
      • agreement
    • status
      Type: string enum
      required

      The current status of the task.

      values
      • action_required
      • optional
      • info
    • affected_capabilities
      Type: array object[] · RiskAccountTaskAffectedCapability[]

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

    • agreement_bundle

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

    • banner_type
      Type: string

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

    • body
      Type: object · RiskAccountTaskBody

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

    • cta
      Type: object · RiskAccountTaskCta

      Suggested primary call to action for this task.

    • description
      Type: string

      Optional short explanation of why the task is present.

    • error_messages
      Type: array object[] · RiskAccountTaskErrorMessage[]

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

    • remediation_link_params
      Type: object · RiskAccountTaskRemediationLinkParams

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

    • requirement_id
      Type: string

      Identifier of the underlying requirement that triggered this task.

    • requirements
      Type: array object[] · RiskAccountTaskRequirement[]

      Field-level requirements represented by this task.

    • resolution_path
      Type: string enum

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

      values
      • account_update
      • agreement_acceptance
      • contact_support
    • title
      Type: string

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