Previous ← Pickup Locations
Next Donations →

Referrers

Manage the organisations and referrer contacts that refer recipients to your food bank, including the auth code system that links recipients to their referrers during registration.

Overview

The referrer system connects external organisations (such as social services, community groups, and health providers) to the recipients they refer. It uses an auth code mechanism so that every recipient who registers is linked back to the referring organisation and the individual referrer contact who referred them.

You will find the referrer system under Referrers in the admin sidebar. It has three sub-pages:

Admins only see referrers, contacts, and auth codes that belong to their own food bank.

Key Concepts

Referrers

A referrer is an organisation that refers recipients to your food bank. Each referrer record stores:

A referrer can have many referrer contacts, many auth codes, and many recipients linked through those auth codes.

Referrer Contacts

A referrer contact is an individual staff member at a referrer organisation. Each contact record stores:

Referrer Contacts can also have their own admin login (see Referrer Contact Invitation below).

Auth Codes

An auth code is an 8-digit number that a recipient enters during registration. It is composed of two parts:

| Part | Length | Source | Example | |------|--------|--------|---------| | Prefix | 4 digits | The referrer's auth code prefix | 1234 | | Suffix | 4 digits | A randomly generated code unique within the referrer | 5678 |

The full auth code in this example is 12345678.

Key rules:

Customer Groups

Both referrers and referrer contacts can be linked to a customer group. When a recipient registers with an auth code:

  1. The system finds the auth code's referrer and (optionally) referrer contact.
  2. If the referrer contact has a customer group set, the recipient is placed into that group.
  3. Otherwise, the recipient inherits the default group from your food bank's settings.

This lets you control which products and order limits apply to recipients from different referrers or referrer contacts.

How It Works

Auth Code Generation

Auth codes are generated in batches from the Referrer Contacts grid:

  1. Navigate to Referrers > Referrer Contacts.
  2. Find the referrer contact you want to generate codes for.
  3. Click Generate 10 More Auth Codes in the Actions column.
  4. The system creates 10 new auth codes linked to that referrer contact and their referrer.

Each auth code is an 8-digit number that is unique across the entire system. The system generates codes automatically and ensures there are no duplicates.

Auth Code Validation During Registration

When a recipient registers on the shop front and your food bank requires auth codes, the following happens:

  1. The recipient enters the 8-digit auth code they received from their referrer contact.
  2. The system looks up the auth code and verifies it is valid and has not already been used.
  3. If the code is valid, registration proceeds.
  4. The recipient is linked to the referrer and (if applicable) the referrer contact who issued the code.
  5. The referrer contact's customer group is applied to the recipient.
  6. If the code is invalid, already used, or does not exist, registration is blocked with an error message.

Auth code validation only applies to food banks with the orders or smart_orders plan that have the Require Auth Code setting enabled. Food banks without this requirement skip the auth code step entirely.

Referrer Contact Invitation System

Referrer Contacts can be given their own admin login so they can view their recipients and orders. The invitation flow works as follows:

  1. Navigate to Referrers > Referrer Contacts.
  2. Find the referrer contact and click Create Login in the Actions column.
  3. The system creates a disabled admin user account and sends an email invitation with a unique token.
  4. The referrer contact clicks the link in the email and is taken to a password creation page.
  5. They set a password (minimum 8 characters) and confirm it.
  6. The account is activated and the referrer contact can log in to the referrer portal.

If a referrer contact has already been invited but has not yet set their password, clicking Create Login again resends the invitation email with a new token. If the referrer contact already has an active login, the system shows an error message.

Referrer Contact logins can be managed and deleted from the Referrer Logins section.

Exporting Auth Codes

You can export unused auth codes as a plain text file:

The exported file contains one full 8-digit auth code per line (prefix + suffix). You can then print or share these codes with the referrer organisation.

Copying Auth Codes

The Auth Codes grid includes a Copy Auth Codes button at the top. This lets you copy all visible unused auth codes to the clipboard for quick sharing.

Common Tasks

Add a new referrer

  1. Go to Referrers > Referrers.
  2. Click + Create.
  3. Enter the organisation name, email, phone, and select a customer group.
  4. Save. The system automatically generates a unique 4-digit auth code prefix.

Add a referrer contact to a referrer

  1. Go to Referrers > Referrer Contacts.
  2. Click + Create.
  3. Enter first name, last name, email, phone, and select the referrer organisation.
  4. Optionally assign a customer group override.
  5. Save.

Generate auth codes for a referrer contact

  1. Go to Referrers > Referrer Contacts.
  2. Find the referrer contact in the grid.
  3. Click Generate 10 More Auth Codes.
  4. The codes appear in the Auth Codes grid, linked to that referrer contact and referrer.

Give a referrer contact admin access

  1. Go to Referrers > Referrer Contacts.
  2. Find the referrer contact and click Create Login.
  3. An invitation email is sent to the referrer contact's email address.
  4. The referrer contact follows the link to set their password.

View auth codes for a specific referrer or referrer contact

Export unused auth codes

  1. On the Referrers grid, click Export Unused to download a text file of all unused codes for that referrer.
  2. On the Referrer Contacts grid, click Export Unused to download codes for a specific referrer contact.

The Referrers Grid

Navigate to Referrers > Referrers. The grid displays:

| Column | Description | |--------|-------------| | Name | Organisation name (sortable). | | Created On | Date the referrer was added (sortable). | | Referrer Contacts | Number of referrer contacts linked to this referrer. | | Recipients | Number of recipients referred by this organisation. Click the count to view them. | | Auth Codes | Total number of auth codes (used and unused). | | Group | The customer group assigned to this referrer. |

Actions per row: Edit, Delete, Contacts (view referrer contacts), Auth Codes (view codes), Export Unused (download unused codes).

The Referrer Contacts Grid

Navigate to Referrers > Referrer Contacts. The grid displays:

| Column | Description | |--------|-------------| | First Name | Referrer Contact's first name (sortable). | | Last Name | Referrer Contact's last name (sortable). | | Referrer | The organisation this referrer contact belongs to (sortable). | | Recipients | Number of recipients linked to this referrer contact. Click the count to view them. | | Auth Codes | Total number of auth codes assigned to this referrer contact. | | Group | Customer group override (if set). |

Actions per row: Edit, Delete, Generate 10 More Auth Codes, Auth Codes (view codes), Export Unused, Create Login (send invitation).

The grid can be filtered by referrer using the Filters panel.

The Auth Codes Grid

Navigate to Referrers > Auth Codes. The grid displays:

| Column | Description | |--------|-------------| | Auth Code | The full 8-digit code (prefix + suffix). | | Assigned | Date the code was used by a recipient (blank if unused). | | Recipient | The recipient who used this code (blank if unused). | | Referrer Contact | The referrer contact this code is linked to. | | Referrer | The referrer organisation. |

The grid can be filtered by referrer and referrer contact using the Filters panel.

A Copy Auth Codes button at the top of the page copies all visible unused codes to the clipboard.

FAQ

What happens if a recipient enters an invalid auth code?

Registration is blocked and an error message is displayed. The recipient must enter a valid, unused 8-digit code to proceed.

Can an auth code be reused after a recipient is deleted?

No. Once an auth code is assigned to a recipient, it remains assigned even if the recipient is later deleted.

How many auth codes can a referrer have?

There is no fixed limit. Each referrer has a 4-digit suffix space (1000--9999), giving a theoretical maximum of approximately 9000 codes per referrer. In practice, the system retries up to 100 times to find an unused suffix, so performance may degrade if a referrer approaches this limit.

Can I change a referrer's auth code prefix?

The prefix is generated automatically when the referrer is created and must be unique. Changing it would invalidate all existing auth codes for that referrer. This is not recommended.

What is the difference between a referrer's customer group and a referrer contact's customer group?

The referrer contact's customer group is an override. If the referrer contact has a group set, recipients who use that referrer contact's auth codes are placed into the referrer contact's group. If the referrer contact has no group set, your food bank's default group applies.

Do all food banks require auth codes?

No. Auth code validation only applies when your food bank has a plan of orders or smart_orders and the Require Auth Code setting is enabled. Other food banks skip the auth code step during registration.

Previous ← Pickup Locations
Next Donations →