Credentials schema - Card Synchronization 3.2

Card Synchronization Plugin Guide 3.2

Applies to
Card Synchronization 3.2
Last updated
Content type
Guides > Plugin and extension guides
Card Synchronization
Plugin and extension guides

For credentials to be imported into Security Center, the database view or file credentials must follow the Card Synchronization schema.

  • For credentials using custom card formats, you must create corresponding custom card formats in Security Center.
  • In database views, all mandatory and optional columns must be included.
  • If you have additional columns, map them to custom fields.
  • In delimited text files, optional columns can be excluded.
Column Data type Description
Mandatory columns
UniqueId String A unique ID for the credential. The unique ID can be an alphanumeric code, an email address, or a Security Center GUID.
Name String A name for the credential.
CredentialValue String The value of the credential, depending on the type of credential:
  • PIN
  • Wiegand format values separated by ‘|’ (vertical bar)
    NOTE: If the credential uses a custom card format, do not include any fixed values.
  • License plate number
CredentialType Integer The value that indicates the type of credential:
  • 0 = Keypad
  • 1 = Undecoded Wiegand
  • 2 = License plate
WiegandCredentialFormatName String The card format of the credential.

The format must either be a custom card format or it must use one of the card format aliases.

NOTE: This field is only required when the value of CredentialType is 1.
Optional columns
ActivationDateInUtc DateTime The date on which the cardholder becomes active. The date must be entered in the ISO 8601 format.
Example: 2018-06-28T22:15:00Z
ExpirationDateInUtc DateTime The date on which the cardholder expires. The date must be entered in the ISO 8601 format.
Example: 2018-06-28T22:15:00Z
CredentialState Integer The value that sets the credential status:
  • 0 = Active
  • 1 = Expired
  • 2 = Inactive
  • 3 = Lost
  • 4 = Stolen
NOTE: If there is a conflict between the state implied by the ActivationDateInUtc, the ExpirationDateInUtc, and the CredentialState, the state in Security Center will be set to inactive.
ExternalCardholderId String The unique ID of a cardholder.
The following image is an example of a credentials view in a Microsoft SQL Server database.