Skip to main content
Design resources
Back

Caseworker guidance banner

Use this banner to provide concise, essential instructions for caseworkers in internal HMRC services.

When to use

To display critical guidance for the caseworker, such as:

  • instructions to input internal data (not user-provided)
  • warnings to avoid disclosure
  • links to documentation

When not to use

Avoid overuse. Reserve this banner for highlighting truly critical or essential caseworker guidance.

This banner is strictly for internal use and should never be displayed on public-facing pages.

How it works

You need HMRC Frontend to use this pattern — find out how to install HMRC Frontend. If you use the HMRC Nunjucks macro, you must copy and paste the entire macro into your code.

Refer to the operator as ‘caseworker’ or ‘agent’, whichever is appropriate for your service.

Place the guidance banner immediately below the page’s <h1>.

The banner should be the same width as the main page content.

When multiple pieces of internal guidance are necessary, consolidate them into a single banner, rather than using multiple instances of this pattern on the same page.

Data entry

Open this example in a new tab: data-entry Display in English Display in Welsh 
              <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Caseworker guidance
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-body">Use HMRC records to complete this page. Do not request this information from the user.</p>
  </div>
</div>
            
                <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Arweiniad Gweithiwr Achos
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-body">Defnyddiwch gofnodion CThEF er mwyn cwblhau’r dudalen hon. Peidiwch â gwneud cais i’r defnyddiwr am y wybodaeth hon.</p>
  </div>
</div>
              
                {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  text: "Use HMRC records to complete this page. Do not request this information from the user."
}) }}
              
                  {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  language: "cy",
  text: "Defnyddiwch gofnodion CThEF er mwyn cwblhau’r dudalen hon. Peidiwch â gwneud cais i’r defnyddiwr am y wybodaeth hon."
}) }}

Security

Open this example in a new tab: security Display in English Display in Welsh 
              <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Caseworker guidance
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-body">The account balance shown on this page is restricted information. Do not disclose to callers.</p>
  </div>
</div>
            
                <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Arweiniad Gweithiwr Achos
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-body">Mae balans y cyfrif sydd wedi’i ddangos ar y dudalen hon yn wybodaeth o dan gyfyngiadau. Peidiwch â’i ddatgelu i’r galwyr.</p>
  </div>
</div>
              
                {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  text: "The account balance shown on this page is restricted information. Do not disclose to callers."
}) }}
              
                  {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  language: "cy",
  text: "Mae balans y cyfrif sydd wedi’i ddangos ar y dudalen hon yn wybodaeth o dan gyfyngiadau. Peidiwch â’i ddatgelu i’r galwyr."
}) }}

Documentation

Open this example in a new tab: documentation Display in English Display in Welsh 
              <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Caseworker guidance
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Debt management guidance (opens in new tab)</a>
  </div>
</div>
            
                <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Arweiniad Gweithiwr Achos
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Arweiniad Rheoli Dyledion (yn agor tab newydd)</a>
  </div>
</div>
              
                {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  html: '<a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Debt management guidance (opens in new tab)</a>'
}) }}
              
                  {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{{ hmrcCaseworkerBanner({
  language: "cy",
  html: '<a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Arweiniad Rheoli Dyledion (yn agor tab newydd)</a>'
}) }}

Multiple instructions

Open this example in a new tab: multiple-instructions Display in English Display in Welsh 
              <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Caseworker guidance
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <ul class="govuk-list govuk-list--bullet">
      <li>the account balance shown on this page is restricted information, do not disclose to callers</li>
      <li><a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Debt management guidance (opens in new tab)</a></li>
    </ul>
  </div>
</div>
            
                <div class="govuk-notification-banner hmrc-caseworker-banner" role="region" aria-labelledby="govuk-notification-banner-title" data-module="govuk-notification-banner" data-disable-auto-focus="true">
  <div class="govuk-notification-banner__header">
    <h2 class="govuk-notification-banner__title" id="govuk-notification-banner-title">
      Arweiniad Gweithiwr Achos
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <ul class="govuk-list govuk-list--bullet">
      <li>mae balans y cyfrif sydd wedi’i ddangos ar y dudalen hon yn wybodaeth o dan gyfyngiadau, peidiwch â’i ddatgelu i’r galwyr</li>
      <li><a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Arweiniad Rheoli Dyledion (yn agor tab newydd)</a></li>
    </ul>
  </div>
</div>
              
                {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{% set html %}
  <ul class="govuk-list govuk-list--bullet">
    <li>the account balance shown on this page is restricted information, do not disclose to callers</li>
    <li><a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Debt management guidance (opens in new tab)</a></li>
  </ul>
{% endset %}

{{ hmrcCaseworkerBanner({
  html: html
}) }}
              
                  {%- from "hmrc/components/caseworker-banner/macro.njk" import hmrcCaseworkerBanner -%}

{% set html %}
  <ul class="govuk-list govuk-list--bullet">
    <li>mae balans y cyfrif sydd wedi’i ddangos ar y dudalen hon yn wybodaeth o dan gyfyngiadau, peidiwch â’i ddatgelu i’r galwyr</li>
    <li><a class="govuk-link caseworker-guidance-banner__link" rel="noopener noreferrer" href="https://www.gov.uk/government/organisations/hm-revenue-customs" target="_blank">Arweiniad Rheoli Dyledion (yn agor tab newydd)</a></li>
  </ul>
{% endset %}

{{ hmrcCaseworkerBanner({
  language: "cy",
  html: html
}) }}

Research

We need more research. If you have used the caseworker guidance banner, get in touch to share your research findings.

Discuss the caseworker guidance banner on GitHub