Sign in

v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Access Credentials

Add Card to User

Create and add an access card for a specified user_id or external_id and org_id. Card object will be passed in the body of the request as a json. We require facility code and card number OR card_number_hex. The successful repsonse will be the created credential information.

post/access/v1/credentials/card

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.

Request body

activeboolean

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

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 required

One of the following supported card types, <code>Standard 26-bit Wiegand</code>,<code>HID 37-bit</code>, <code>HID 37-bit No Facility Code</code>, <code>HID 34-bit</code>,<code>Casi Rusco 40-Bit</code>, <code>HID Corporate 1000-35</code>, <code>HID Corporate 1000-48</code>,<code>HID iClass</code>, <code>DESFire CSN</code>, <code>Verkada DESFire</code>, <code>Third Party DESFire 40X</code>,<code>Apple Wallet Pass</code>, <code>MiFare 4-Byte (32 bit) CSN</code>, <code>MDC Custom 64-bit</code>,<code>HID 36-bit Keyscan</code>, <code>HID 33-bit DSX</code>, <code>HID 33-bit RS2</code>,<code>HID 36-bit Simplex</code>, <code>Cansec 37-bit</code>, <code>Credit Card BIN Number</code>,<code>Kantech XSF</code>, <code>Schlage 34-bit</code>, <code>Schlage 37-bit</code>, <code>RBH 50-bit</code>,<code>Guardall G-Prox II 36-bit</code>, <code>AMAG 32-bit</code>, <code>Securitas 37-bit</code>,<code>Kastle 32-bit</code>, <code>PointGuard MDI 37-bit</code>, <code>Blackboard 64-bit</code>,<code>IDm 64-bit</code>, <code>Continental 36-bit</code>, <code>AWID 34-bit</code>, <code>License Plate</code>,<code>HID Infinity 37-bit</code>, <code>HID Ceridian 26-bit</code>, <code>iClass 35-bit</code>,<code>Andover Controls 37-bit</code>.

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.