Credential Types

A DoorFlow account can have any number of credential types.

This is mostly for the convenience of the users. Traditionally an account is set up with a card, keyfob and a pin by default.

DoorFlow supports just about any credential type available - cards, keyfobs, pins, magsripe cards, mobile phones and QR codes to name a few.

The credentials supported in a particular DoorFlow account is described by the credential_types endpoint. This can be used to present appropriate fields to the users of those systems integrated with DoorFlow. Please see below for further description of the types and suggestions on field validations.

List all credential types

Returns a list of all Credential types in your account.

GET /api/3/credential_types

Example Response

[
    {
        "id": 8451,
        "label": "Card",
        "slug": "credentials_number",
        "code": 200
    },
    {
        "id": 8243,
        "label": "Keyfob",
        "slug": "key_fob",
        "code": 200        
    },
    {
        "id": 8033,
        "label": "Pin",
        "slug": "pin",
        "code": 10
    }
]

• Use the label in your UI to describe the field
• Use the slug when making simple updates via the people object
• Use the credential_type to show an appropriate field/size and for validation (see below)
• Use the code to determine underlying class of credential_type and the subsequent validations required (see below)

For complex credentials such as mobile id's (including issuing status) using the slug is not possible - please see You can do more with credentials and webhooks

For example when updating a person's card, the slug in this case is credentials_number

{
  	"first_name": "Renamed",
  	"last_name": "User",
  	"credentials_number": "121212",
  	"group_ids": [
      	1,
      	3
  	]
}

Some common Credential Types (and suggested validations)

Validation is important when processing user entered data. Use this table as a guide for how to validate different credential types.