Identification Workflows

This endpoint is used to update the identification workflows of the specified device.

Identification workflows allows you some customization in how you allow people to access doors. You will be able to see all our available identification workflow credentials here.

All identification workflows for a device must start with a unique credential and the FaceOnCard credential cannot be used to start an identification workflow alongside the Card and ExternalCard credentials. Other identification workflows can contain the FaceOnCard, Card, and ExternalCard credentials, they just cannot be used to start identification workflows together.

Some examples of combinations that can be made would be:

  • Face -> Card
  • Card
  • CloudKey -> FaceOnCard
  • ExternalCard -> Face
  • Web

Controlled Errors

Error CodeError Message
error_device_invalid_serial_numberInvalid serial number provided.
error_empty_identification_workflow_listEither the list of identification workflows passed is empty or one of the identification workflows passed is empty. Every device must have at least 1 valid identification workflow.
error_invalid_credential_typeOne of the identification workflow credentials passed is not a valid type.
error_duplicated_work_flow_secuenceEither more than one identification workflow credential was found in one identification workflow or more than one identification workflow is starting with the same identification workflow credential.
error_conflict_identification_workflowThe FaceOnCard identification workflow credential cannot be used to start an identification workflow while other identification workflows start with the Card or ExternalCard identification workflow credentials.
error_device_not_foundThe device was not found.
error_device_update_errorThe device update failed.

Any status codes returned that are not provided here are generic status codes that can be found here.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!