RiskAccountTask

  • 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.

    • id
      Type: string
      required

      Capability identifier affected by this task.

    • description
      Type: string

      Optional explanation of the impact on the capability.

    • status
      Type: string

      Optional current or projected status for the affected capability.

  • agreement_bundle

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

    • agreement_kind
      Type: string
      required

      The type of agreement to be presented to the account holder.

    • agreement_version
      Type: integer Format: int32
      required

      The version of the agreement bundle.

    • documents
      Type: array · AgreementDocument[]
      required

      The documents included in the agreement bundle.

    • locale
      Type: string
      required

      Locale of the agreement content.

  • 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.

    • template
      Type: string
      required

      Text or template key for the task body.

    • template_pairs
      Type: object

      Template replacement values keyed by placeholder name.

  • cta
    Type: object · RiskAccountTaskCta

    Suggested primary call to action for this task.

    • can_act
      Type: boolean
      required

      Whether the current caller can start remediation for this task.

    • text
      Type: string
      required

      Label for the suggested call to action.

    • type
      Type: string enum
      required

      Presentation type for the call to action.

      values
      • primary
      • secondary
  • 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.

    • code
      Type: string
      required

      Machine-readable reason code for the requirement error.

    • reason
      Type: string
      required

      Human-readable explanation of the requirement error.

    • requirement
      Type: string
      required

      Field-level requirement that the error applies to.

  • remediation_link_params
    Type: object · RiskAccountTaskRemediationLinkParams

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

    • embedded_resolution_path
      Type: string

      Dashboard or hosted remediation path hint understood by embedded clients.

  • 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.

    • currently_due
      Type: boolean
      required

      Whether the field is currently due.

    • eventually_due
      Type: boolean
      required

      Whether the field is eventually due.

    • field_name
      Type: string
      required

      Requirement field name that the integrator should collect or remediate.

    • id
      Type: string
      required

      Stable identifier for this field-level requirement entry.

    • past_due
      Type: boolean
      required

      Whether the field is past due.

    • pending_verification
      Type: boolean
      required

      Whether the field is waiting on verification.

    • alternatives
      Type: array string[]

      Alternative field names that could satisfy the same requirement.

  • 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.