> For the complete documentation index, see [llms.txt](https://help.security.gallagher.com/knowledge-hub/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/configuring-licensable-features/universal-credential/creating-a-universal-credential-type.md).

# Creating a Universal Credential Type

### Introduction

This procedure describes how to create and configure a Universal Credential Type.

**Note:** The "Configure Site" or "Edit Card Types", and the “Manage Keys” operator privilege is required to perform this procedure.

### Before you begin

If you are reading a third-party Apple Wallet, Google Wallet, or physical credential format, you must first create a JSON file that defines the format. The JSON files must be stored in the folders identified below. Valid JSON files stored in the App Host Module folder will be selectable from the **Provider** drop-down list. For configuration details, refer to [JSON File Configuration](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/configuring-licensable-features/universal-credential/json-file-configuration.md).

For Command Centre sites upgrading to v9.60, JSON files must be stored in:

`C:\Program Files\Gallagher\Command Centre\AppHost Service\Modules\Credential Types`

For new Command Centre sites, the JSON files must be stored in:

`C:\Program Files (x86)\Gallagher\Command Centre\AppHost Service\Modules\Credential Types`

For details on how to configure a JSON file, refer to the topic [JSON File Configuration](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/configuring-licensable-features/universal-credential/json-file-configuration.md).

**Notes:**

* Command Centre will validate the JSON file, ensuring it is correct before displaying it in the **Provider** drop-down list. Invalid formats will not be displayed.
* Editing the name of a JSON file will not update the name shown in Command Centre. Instead, edit the providerName field within the JSON file.
* If a JSON file is modified, a refresh of the Universal Credentials Viewer will retrieve the updated JSON file.
* If a Universal Credential Type is created and saved using a JSON file, modification of the JSON after saving will not change the credential format. In this scenario, if the JSON file requires modification, a new Universal Credential format should be created.

**Important:** Cryptographic keys are not defined within the JSON file. They must be entered directly into Command Centre, where they are securely encrypted and stored in the database. If sensitive cryptographic keys need to be handled outside the Gallagher system, follow the procedures outlined in the [Cryptographic Key Handling Guide](https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/configuring-licensable-features/universal-credential/json-file-configuration/universal-credential-files).

### Procedure

1. Click the **New Universal Credential Type** button on the Universal Credentials Viewer.

   The Create New Credential Type wizard displays.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-d43c6deffe6d36cb6ca6b71c0afe4562a7cdb86d%2F44955.png?alt=media)
2. Select the credential technology from the **Technology** drop-down list.

   **Note:** Once the Technology is assigned, it cannot be changed.
3. Select the credential provider from the **Provider** drop-down list, then select **Next**.

   **Note:** Once the Provider is assigned, it cannot be changed.
4. Refer to the option you have selected for further detail:

<details>

<summary>Apple Wallet - Gallagher</summary>

Select this option when reading Gallagher Apple Wallet credentials, synced from another Gallagher system.

For example, a third-party Gallagher system requires their Gallagher Apple credentials to be read at this system. In this example, the credential type will be assigned to cardholders in this system, using the [Gallagher Cardholder Sync Utility](https://media.gallagher.com/m/bb42baa6206f22f/original/Release-Note-Cardholder-Sync-utility-v9-00.pdf) or [Gallagher Cardholder REST APIs](https://gallaghersecurity.github.io/cc-rest-docs/ref/cardholders.html).

![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-9add82347b039ff536c6b80f6cfbc0e0fcd2cf2a%2F44950.png?alt=media)

<table><thead><tr><th width="156">Field</th><th>Description</th></tr></thead><tbody><tr><td>TCI</td><td>Enter the Terminal Capabilities Identifier (TCI) from the third-party Gallagher system into the TCI field. The TCI is located on the Server Properties>Mobile Wallet tab in the third-party Gallagher system.<br>The TCI is advertised by the reader to display the correct badge in Apple Wallet. A TCI with length 0 is invalid.</td></tr><tr><td>Terminal Subtype</td><td>Ensure <strong>Corporate</strong> is selected as the Terminal Subtype. Gallagher supports Apple Employee Badge only as the customer group, so Corporate is set by default.</td></tr><tr><td>Read Key Number</td><td>Enter the Read Key Number (2-6) belonging to the key shared from the third-party Gallagher system, into the <strong>Read Key Number</strong> field.</td></tr><tr><td>Read Key</td><td>Enter the Read Key belonging to the Read Key Number from the third-party Gallagher system, into the <strong>Read Key</strong> field. This is a 32 hexadecimal key.</td></tr><tr><td>Privacy Key</td><td>Enter the Privacy Key belonging to the third-party Gallagher system, into the <strong>Privacy Key</strong> field. This is a 32 hexadecimal key.</td></tr></tbody></table>

</details>

<details>

<summary>Apple Wallet - Custom</summary>

Select this option when reading Apple Wallet credentials, provisioned from a third-party provider.

![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-ebcb57ad986098423e54ed2a7a2f8493cdcd17dc%2F44951.png?alt=media)

<table><thead><tr><th width="156">Field</th><th>Description</th></tr></thead><tbody><tr><td>TCI</td><td>Enter the Terminal Capabilities Identifier (TCI) belonging to the Apple credentials provided by the third-party credential provider into the TCI field.<br>The TCI advertised by the reader to display the correct badge in Apple Wallet. A TCI with length 0 is invalid.</td></tr><tr><td>Terminal Subtype</td><td>Select Corporate or University as the <strong>Terminal Subtype</strong>. The third-party credential provider will issue either Corporate or University wallet credentials.</td></tr><tr><td>Read Key</td><td>Enter the Read Key belonging to the Apple credentials provided by the third-party credential provider, into the <strong>Read Key</strong> field. This is a 32 hexadecimal key.</td></tr><tr><td>Privacy Key</td><td>Enter the Privacy Key belonging to the Apple credentials provided by the third-party credential provider, into the <strong>Privacy Key</strong> field. This is a 32 hexadecimal key.</td></tr></tbody></table>

**Note:** If a third-party Apple credential does not support second-factor authentication (2FA) through either a secure or non-secure secondary application within the credential format, a Gallagher reader configured to require a second factor will not recognize the credential.

**Technical explanation:** When a reader broadcasts an ECP frame that expects a secondary application, the authentication process with the credential on the mobile device will fail if that application is not present. As a result, the TCI is not advertised, preventing the credential from being displayed to the user or read by the reader.

</details>

<details>

<summary>Google Wallet - Custom</summary>

Select this option when reading Google Wallet credentials, provisioned from a third-party provider.

![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-92d7da90b3fc7203a55eba2b34f392d4f42c6b65%2F44952.png?alt=media)

<table><thead><tr><th width="156">Field</th><th>Description</th></tr></thead><tbody><tr><td>Customer Code</td><td>Enter the Customer Code (the last three bytes of the DFNAME) into the <strong>Customer Code</strong> field. Alternatively, enter the full DFNAME and the Customer Code will be extracted automatically.</td></tr><tr><td>Read Key</td><td>Enter the Read Key belonging to the credential, into the <strong>Read Key</strong> field. This is a 32 hexadecimal key.</td></tr></tbody></table>

</details>

<details>

<summary>Physical - Gallagher Non-diversified</summary>

Select this option when reading DESFire cards, encoded with the Non-diversified DESFire object from another Gallagher system.

![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-f0d4b90da404ef2495d77ec3cf77c12493a5e0b6%2F44953.png?alt=media)

<table><thead><tr><th width="156">Field</th><th>Description</th></tr></thead><tbody><tr><td>Application ID</td><td>Enter the Application ID belonging to the Non-Diversified DESFire object encoded by the third-party Gallagher system, into the <strong>Application ID</strong> field. It must be 6 hexadecimal characters (0-9, A-F).</td></tr><tr><td>Read Key</td><td>Enter the Read Key belonging to the Non-Diversified DESFire object encoded by the third-party Gallagher system, into the <strong>Read Key</strong> field. This is a 32 hexadecimal key.</td></tr><tr><td>Site Code Format</td><td>Select Hexadecimal or Decimal as the <strong>Site Code Format.</strong> The chosen format does not change the data stored on the credential.</td></tr><tr><td>Site Code</td><td>Enter the Site Code belonging to the card type encoded with the Non-Diversified DESFire object, into the <strong>Site Code</strong> field. The Site Code is derived from the combination of the <strong>Region Code</strong> (ASCII) and <strong>Facility Code</strong> (Decimal), (e.g. A11111 is 0x412B67). Use a calculator in Programmer mode to convert and determine the required value.</td></tr><tr><td>First Bit of Site Code</td><td>Ensure 8 is the <strong>First Bit of Site Code</strong> value specified.</td></tr><tr><td>Bits in Site Code</td><td>Ensure 24 is the <strong>Bits in Site Code</strong> value specified.</td></tr><tr><td>Card Number Format</td><td>Ensure Decimal is the <strong>Card Number Format</strong> specified.</td></tr></tbody></table>

</details>

<details>

<summary>Physical - Custom</summary>

Use this method when reading DESFire cards, encoded with a third-party provider's format or encoded with your own custom format.

Select the JSON file from the **Provider** drop-down list.

![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-45a1b4c759ebba53a4582ae51a5a2aee75f7ae84%2F44954.png?alt=media)

<table><thead><tr><th width="156">Field</th><th>Description</th></tr></thead><tbody><tr><td>Read Key</td><td>Enter the Read Key belonging to the physical format, into the <strong>Read Key</strong> field. This is a 32 hexadecimal key.</td></tr><tr><td>Site Code Format</td><td>Select Decimal or Hexadecimal as the <strong>Site Code Format</strong>. The chosen format does not change the data stored on the credential.</td></tr><tr><td>Site Code</td><td>Enter the Site Code belonging to the physical format, into the <strong>Site Code</strong> field. Command Centre references the Site Code to identify cards of use on the site. Different Site Codes allow you to use identical keys and card numbers.</td></tr><tr><td>First Bit of Site Code</td><td>Specify the first bit for the Site Code. Command Centre will start reading bits from this position for the Site Code.<br><br><strong>Note:</strong> Not all physical formats have Site Codes. If this is the case, leave the field blank or enter 0.</td></tr><tr><td>Bits in Site Code</td><td>Specify the number of bits to read for the Site Code. This number of bits define the Site Code.</td></tr><tr><td>Card Number Format</td><td>Select Decimal or Hexadecimal as the <strong>Card Number Format</strong>. Typically, decimal is used when displaying and entering card numbers in Command Centre. The chosen format does not change the data stored on the credential.</td></tr></tbody></table>

**Note:** The fields First Bit of Site Code, Bits in Site Code, and Card Number Format are populated using values defined in the JSON file. These fields are editable when creating the credential type.

</details>

5. Select the **Next** button.

   The Name credential type page displays.

   ![](https://2455150842-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fi6UYAoyykM6nimMN9yss%2Fuploads%2Fgit-blob-c91082f1cb3d7ac024ed95346a676d695a54f6ed%2F44956.png?alt=media)
6. Enter an appropriate **Name** (limited to 110 characters) for this credential type.
7. Enter a logical **Description** (limited to 200 characters) for this credential type.
8. Select the appropriate **Division** from the drop-down list.

   **Note:** If you have not set up Divisions yet, you can add these to your item at a later stage.
9. Select the appropriate **Card State Set** (if only one exists it will default) to be associated with this credential type, from the drop-down box.

   **Note:** Once the Card State Set is assigned it cannot be changed.
10. Enter **Notes** if you want to add a note(s) about this credential type.
11. Click **Done** to exit the Create New Credential Type wizard and save your changes.

### Result

A new Universal Credential Type is created, configured and ready for assignment.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.security.gallagher.com/knowledge-hub/command-centre-client/configuring-command-centre/configuring-licensable-features/universal-credential/creating-a-universal-credential-type.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
