Custom Credential Attributes

Add extra data fields to your credentials — course hours, scores, instructor names, and more — with custom attributes (Pro plan).

Custom credential attributes configuration in CertLister

Custom Credential Attributes

Time to read: 8 minutes


Overview

Custom credential attributes let you attach domain-specific data fields to credentials at the category level. Define fields like "Score", "Instructor", "Training Hours", or "Permit Number" — then fill them in for each credential recipient. Values appear in generated PDFs and on the public verify page.

Example use cases:

  • A Python training provider adds "Score" and "Instructor" fields to their "Python Training" category
  • A food safety certifier adds "Permit Number" and "Issuing Authority" to their compliance category
  • A fitness organization adds "Hours Completed" and "Trainer Name" to each certification

Requires: Pro plan


How the Feature Works

Custom attributes follow a four-step flow:

  1. Define fields on a category (Admin, Pro plan)
  2. Enter values when creating or editing individual credentials
  3. Place tokens in your credential design to print the values in PDFs
  4. Verify page shows the values publicly when someone looks up a credential

Part 1: Define Custom Fields on a Category

Requires: Admin role and Pro plan

Step 1: Go to Categories

  1. Log into CertLister at https://app.certlister.com
  2. Click Categories in the left navigation

Step 2: Open the Custom Fields Dialog

  1. Find the category you want to add fields to
  2. Click the Sliders icon in that category's row — this opens the Custom Fields dialog
  3. If your organization is on the Free or Basic plan, you will see a lock icon and an Upgrade button instead of the field editor

Step 3: Add Fields

  1. Click Add Field
  2. Fill in the three properties for each field:
PropertyDescriptionRules
KeyInternal identifier used in design tokensLowercase letters, numbers, and underscores only. Max 30 characters. Example: score
LabelDisplay name shown to users and on the verify pageMax 50 characters. Example: Score
RequiredWhether this field must be filled in when creating a credentialCheck or uncheck
  1. Add as many fields as you need — there is no limit
  2. Click Save Fields when done

Example setup for a "Python Training" category:

KeyLabelRequired
scoreScoreNo
instructorInstructorYes
hoursTraining HoursNo

Important: Renaming or Removing Field Keys

A warning appears in the dialog if you rename or remove a key that already has stored values on existing credentials. Changing the key does not delete the stored data — but the values will not display until the original key is restored. Rename keys carefully and only before credentials have been created in that category.


Part 2: Enter Values When Creating a Credential

Once a category has custom fields, those fields appear automatically in the Add Credential and Edit dialogs when that category is selected.

Creating a Credential with Custom Fields

  1. Go to Credentials → click Add Credential (or Import for bulk)
  2. Fill in the standard fields (recipient name, title, dates)
  3. Select a category that has custom fields defined
  4. The custom fields appear below the standard section — fill them in
  5. Required fields are marked with an asterisk (*) and must be completed before saving
  6. Click Save

Editing Existing Credentials

  1. Open a credential that belongs to a category with custom fields
  2. Click Edit
  3. The custom fields appear with any previously saved values
  4. Update values as needed and save

Note: Adding custom fields to a category does not retroactively fill in values for existing credentials. You can edit each credential individually to add the values, or re-import with a CSV that includes the extra columns (see Part 5 below).


Part 3: Use Tokens in Credential Designs

Custom attribute tokens follow the format {{custom.fieldkey}}. Place them in the Design Studio to print custom values in generated PDFs.

Step 1: Open the Design Studio

  1. Click Design Studio in the left navigation
  2. Open the design you want to update — or create a new one

Step 2: Find Custom Field Tokens in the Attributes Panel

  1. Click the Attributes icon in the left toolbar
  2. Scroll down to the Custom Fields section in the Selection Panel
  3. Your custom field tokens appear as clickable buttons — one per unique field key, across all of your organization's categories
  4. If two categories have a field with the same key but different labels (e.g., "Score" in one and "Test Score" in another), both labels are shown merged on the button

Step 3: Add a Token to the Canvas

  • Click a token button to add it to the canvas at a default position
  • Drag the token button directly onto the canvas to place it exactly where you want it
  • Style the token element like any other text element: font, size, colour, alignment

Step 4: Save the Design

Click Save in the top right. The design is now ready to generate PDFs with custom values.

At generation time:

  • {{custom.score}} → replaced with the actual score for each recipient (e.g., "92%")
  • {{custom.instructor}} → replaced with the instructor's name (e.g., "Dr. Smith")
  • If a credential has no value for a token, the token is replaced with an empty string (blank space)

Part 4: Custom Attributes on the Public Verify Page

When someone looks up a credential on your public verify page, an Additional Details section appears below the standard credential information — but only if the credential has custom attribute values and your organization is on the Pro plan.

Example of what visitors see:

Additional Details

Score            92%
Instructor       Dr. Smith
Training Hours   16 hours

Only fields that have a saved value are shown. Fields without a value are omitted. Email addresses, internal notes, and other private data are never exposed on the verify page.


Part 5: Import Custom Attributes via CSV

When you import credentials via CSV, any column that is not a standard CertLister field is automatically treated as a custom attribute. No extra configuration is needed.

How It Works

Standard fields that the importer recognizes: Credential Number, Title, Recipient Name, Recipient Email, Issue Date, Expiry Date, Status, Category

Any column name outside this list is mapped to {{custom.columnname}}. For example, a column named score becomes {{custom.score}} in generated PDFs.

Example CSV

Credential Number,Title,Recipient Name,Recipient Email,Issue Date,Expiry Date,Status,Category,score,instructor
,Python Training,Sarah Johnson,sarah@email.com,2026-01-15,2027-01-15,active,Python Training,92%,Dr. Smith
,Python Training,Michael Chen,mchen@company.com,2026-01-15,2027-01-15,active,Python Training,87%,Dr. Smith

The columns score and instructor are saved as custom attribute values and will render in PDFs via {{custom.score}} and {{custom.instructor}} tokens.

Notes:

  • Column names in the CSV are used as-is as the attribute key. Keep them lowercase and without spaces to match your category field keys.
  • The importer does not validate CSV custom columns against the category's defined schema. Values are stored regardless.
  • The category schema (defined in the Custom Fields dialog) controls display names, required validation, and token resolution — not the import.

Learn more: Bulk Import Credentials from CSV


Troubleshooting

The Custom Fields dialog shows a lock icon

Cause: Your organization is on the Free or Basic plan. Custom attributes require Pro.

Solution: Upgrade at https://app.certlister.com/billing


Custom fields do not appear in the credential dialog

Check:

  1. You selected a category that has at least one field defined — open the Categories page, find the category, click the Sliders icon, and confirm fields are listed
  2. Your organization is on the Pro plan
  3. You are selecting the category before looking for the fields (fields load when the category is selected)

A token in the PDF shows as {{custom.score}} instead of a real value

Causes and fixes:

CauseFix
The credential has no value saved for that fieldEdit the credential and enter the value
The token key does not match the field keyKeys are case-sensitive and must be exact. {{custom.Score}} is not the same as {{custom.score}}
The credential was created before the field was addedEdit the credential to add the value

The verify page does not show custom attributes for a credential

Check:

  • Your organization is on the Pro plan (the API does not return custom attributes for non-Pro orgs)
  • The credential has at least one custom attribute value saved (edit the credential to confirm)
  • The attribute key in the verify response matches the category schema

The design preview shows [score] instead of a real value

This is expected. The Design Studio canvas preview has no real credential data. Custom tokens display as [fieldkey] in the preview to show that the token is recognized. The actual value is substituted at PDF generation time.


Frequently Asked Questions

Q: How many custom fields can I add per category?

A: There is no limit.


Q: Can different categories have different custom fields?

A: Yes — each category has its own independent field schema. "Python Training" can have Score and Instructor; "Food Safety" can have Permit Number and Expiry Region. These are completely separate.


Q: What happens to existing credentials when I add new fields to a category?

A: Existing credentials are not affected. New fields appear blank for existing credentials. Required validation applies only when creating new credentials — editing an existing credential will show the new field but not force you to fill it in.


Q: Can I use the same token key in multiple categories?

A: Yes. The Design Studio merges all unique keys across all category schemas into one list in the Attributes panel. A token like {{custom.score}} in your design will resolve to the score value of whichever category the specific credential belongs to.


Q: Are custom attribute values searchable in the credentials list?

A: Not currently. Search works on recipient name, credential number, and title.


Q: Can custom attribute values be exported to CSV?

A: Not currently. The standard CSV export includes the core fields only. Custom attribute export may be added in a future update.


Q: Do custom attributes work with the legacy SVG credential generator?

A: Yes. The legacy SVG generator also resolves {{custom.key}} tokens when they appear in an SVG template.


Q: What happens to custom attribute data if I downgrade from Pro to Basic?

A: The stored values remain in the database. However, the verify page will stop showing the Additional Details section, and the Custom Fields dialog will show a lock icon. Values are restored immediately if you upgrade back to Pro.

Still need help?

We respond to every message within 24 hours.