---
title: "Set Entry Code for User"
method: PUT
path: "/access/v1/access_users/user/entry_code"
tags: ["Access User Information"]
---

# Set Entry Code for User

`PUT /access/v1/access_users/user/entry_code`

Given the user defined external ID or Verkada defined user ID (but not both), set the entry code for a user. Pin code value will be passed as a parameter in a json payload.
Returns the updated Access Information Object.

## Query parameters

- `user_id` string, uuid — The unique identifier of the user managed by Verkada.
- `external_id` string — A unique identifier managed externally provided by the customer.
- `email` string — The email address of the user.
- `employee_id` string — The organization-defined employee ID of the user.
- `override` boolean — The flag that states whether or not the client wants to apply the given entry code to the given user even if the entry code is already in use by another user. This will reset the other user's entry code.

## Request body

- PutEntryCodeAccessUserRequestBodyV1
  - `entry_code` string, required — The access entry code used for keypad readers alone or in 2FA mode. Formatted as a string of digits between 4 and 16 in length. Must be unique within the organization.

## Response `200`

OK

- AccessInformationResponseV1
  - `access_groups` AccessGroupObjectResponseV1[] — Access Groups to which a user belongs.
    - `group_id` string, uuid — The unique identifier of the Access Group managed by Verkada.
    - `name` string — The unique name of the Access Group provided by the customer.
  - `ble_unlock` boolean — The permission state of a user's ability to perform a Bluetooth Unlock. Format is a boolean True or False. Default is False.
  - `cards` CardObjectResponseV1[] — Access cards associated with the user.
    - `active` boolean — Bool value specifying if the credential is currently active. Can be True or False. Default value is False.
    - `card_id` string — The unique identifier of the Access Card managed by Verkada.
    - `card_number` string — The card number used to grant or deny access to a door.
    - `card_number_hex` string — The card number in hexadecimal used to grant or deny access to a door.
    - `facility_code` string — The facility code used to grant or deny access to a door.
    - `type` string — The type of card used during the credential evaluation process.
  - `end_date` string — The end time value of the time range controlling when a users credentials are active. Formatted as a Unix timestamp in seconds. Default is Null.
  - `entry_code` string — The access pin code used for keypad readers alone or in 2FA mode. Formatted as a string of digits between 4 and 16 in length. Must be unique within the organization.
  - `external_id` string — A unique identifier managed externally provided by the customer.
  - `face_credential` FaceCredentialObjectResponseV1
    - `source` string — The source of the face credential.
    - `status` string, required — The status of the face credential.
  - `has_profile_photo` boolean — A flag that states whether or not the user has a profile photo.
  - `license_plates` LicensePlateObjectResponseV1[] — License plates associated with the user.
    - `active` boolean — Bool value specifying if the license plate credential is currently active. Default value is False.
    - `license_plate_number` string — The unique license plate number identifying a license plate credential for a user.
    - `name` string, required — The name to be given to the license plate credential.
  - `mfa_codes` MFACodeObjectResponseV1[] — MFA codes associated with the user.
    - `code` string, required — The code corresponding to a user's MFA code credential.
  - `profile_photo_last_updated` string, date-time — The timestamp when the user's profile photo was last updated.
  - `qr_codes` QRCodeObjectResponseV1[] — QR codes associated with the user.
    - `activation_state` string — Detailed (lost/auto-deactivated) state of a QR code.
    - `active` boolean — Whether this QR code credential grants access.
    - `card_number` string — The card number used to grant or deny access to a door.
    - `card_number_hex` string — The card number in hexadecimal used to grant or deny access to a door.
    - `encoding_type` string, required — The encoding type of a user's QR code credential.
    - `facility_code` string — The facility code used to grant or deny access to a door.
    - `qr_code` string — The data within a user's QR code credential.
  - `remote_unlock` boolean — The permission state of a user's ability to perform a Remote Unlock. Format is a boolean True or False. Default is False.
  - `start_date` string — The start time value of the time range controlling when a users credentials are active. Formatted as a Unix timestamp in seconds. Default is Null.
  - `user_id` string, uuid — The unique identifier of the user managed by Verkada.

---

[API](https://skmtc.net/verkada/apis/api-tokens.md) · [All operations](https://skmtc.net/verkada/apis/api-tokens/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/verkada/api-tokens/revisions/4a79d2d949a6/schema)