Source System Identifier

The Source System ID field can be used as a unique identifier to associate employees with your source systems. For example this field could be Employee ID from an HRIS or a payroll code from you payroll system. This field must be unique in the tenant across Team Members AND Employees. If you attempt to use a Source System Identifier that is already in use, you will receive an error message.

The Source System ID is intended to come from your system of truth. You can easily add it to Click Boarding via the API, in the UI, or via bulk import. This field can be used to search for records in the Action Center as well as in SSO. 

Updating the UI

The Source System ID can be updated via the UI by accessing the Team Member or Employee profile you wish to add the Source System ID to.

• For new Team Members: [Home] -> [Company] -> [Team Members] -> [Create Team Member]
• For existing Team Members: [Home] -> [Company] -> [Team Members] -> [Edit]
• For new Employee: [Home] -> [Employee List] -> [Create Employee]
• For existing Employees: [Home] -> [Employee List] -> [Select Employee] -> [Edit]

Updating via Bulk Import

The Source System ID can be added via import by accessing the Bulk Import section of Click Boarding. Please note that at this time, Bulk Imports only supports creating new employees or team members. Existing employees and team members cannot be updated. For more information on bulk imports, please visit our Bulk Import Resource Center articles.

Updating via API

We offer a variety of endpoints to update the Source System ID via API. For more information regarding our API, please visit our developer portal. 

• For new Team Members: Users-POST
• For existing Team Members: Users/{id}-PATCH
• For new Employees: Candidates-POST
• For existing Employees: Candidates/{id}-PATCH
• Returns Team Member or Candidate api identifier information based on the Source System ID: SourceSystemUser-Post
• Retrieve Source System ID for Team Members: Users/{id}-GET
• Retrieve Source System ID for Employees: Candidates/{id}-GET