Support Center

Client ID document templates

Last Updated: Jan 06, 2017 02:58PM CET

● Overview

● Creating a new ID template

● Editing / Removing an ID template





In this section Client ID document templates can be created, edited and deleted.

An ID template allows storing the various types of client IDs, such as passport, drivers license etc. for each type of ID document an ID template should be created.

When an ID template is created it will be available on client creation, please see the documents section in the Create Individual Clients article for more details.

────────────────────────────────────────────────────────────────────────────── Back to top

Creating a new ID template

Creating a new ID template
  • Go to Administration > General Settings > ID Templates
  • Add Template
  • Fill the details
  • Save
Required ID template fields:
  • ID Type is the kind of document template being created, such as passport or driver's licence. 
  • Issuing Authority is the document's issuing authority, such as passport office or municipality.
  • ID Document Template this is what is commonly referred to as an "input mask", and defines the format allowed for the ID number. Special characters are used o define the number and type of characters required> Use @ to indicate where and how many letters, # for numbers, $ for alphanumeric characters. 
For instance a template defined as ###-@@-$, means that when filling the information for a client, the ID will have to follow that format, valid examples would be 123-AB-1 or 876-FG-B.

Mandatory for Clients
When this is checked, this particular ID must be added to any client before saving.

Allow Attachments
If this option is checked, then the user will be able to attach a file (for example, a scan or picture of the ID) when adding this particular type of ID document  to the client's profile.

────────────────────────────────────────────────────────────────────────────── Back to top

Editing / Removing an ID template

To edit an ID template
  • Go to Administration - General Settings - ID templates
  • Click the pencil "edit" button for the template to be edited
  • Change the fields 
  • Save
 This may result in existing ID documents using the edited template to no longer fit the defined template, when editing those clients the ID document will need to be edited to fit the latest template, or removed if not mandatory.

To delete an ID template
  • Go to Administration - General Settings - ID templates
  • Click the red "delete" button for the template to be deleted
  • Confirm
 This can only be done for templates that are not in use
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
Invalid characters found