Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Access Credentials

Activate Access Card

Given the Verkada defined user ID (OR user defined external ID)and Card ID, activate a specific access card for a user. Returns the updated access card information.

put/access/v1/credentials/card/activate

Query parameters

external_idstring

A unique identifier managed externally provided by the customer.

user_idstring uuid

The unique identifier of the user managed by Verkada.

card_idstring required

The unique identifier of the Access Card managed by Verkada.

Response

OK

activeboolean

Bool value specifying if the credential is currently active. Can be True or False. Default value is False.

card_idstring

The unique identifier of the Access Card managed by Verkada.

card_numberstring

The card number used to grant or deny access to a door.

card_number_hexstring

The card number in hexadecimal used to grant or deny access to a door.

facility_codestring

The facility code used to grant or deny access to a door.

typestring

The type of card used during the credential evaluation process.