Home Kiosk & Hardware How to Collect a Custom Field (e.g. HKID) and Show It on the Security Monitor

How to Collect a Custom Field (e.g. HKID) and Show It on the Security Monitor

Last updated on Jul 20, 2026

KyberAccess lets you collect any custom piece of information at check-in — for example a national ID such as an HKID — and display that value as an overlay on the visitor's photo inside the Security Monitor guard card.

This guide covers the two parts, end to end:

  1. Add the custom field so it's collected on the kiosk at check-in.
  2. Turn on the overlay so guards see that value on the visitor card.

Part 1 — Add the custom field to the kiosk

Custom questions are configured on the kiosk Flow Builder, in the Custom Form step.

Step 1. In the left sidebar, go to Settings → Kiosk → Flow Builder.

Step 2. If your flow doesn't already include a Custom Form step, add it from the step list. Then click the Custom Form step to open its settings.

Step 3. Under Custom Questions, click + Add Field and set:

  • Label: what the visitor sees, e.g. HKID
  • Key: auto-fills from the label (e.g. HKID). This is the internal name — keep it simple and unique.
  • Type: choose Text for an HKID
  • Required: tick it if every visitor must provide it

Step 4. Click Save (and Publish the flow). The HKID question now appears on the kiosk's Additional Info step, so every visitor is asked for it during check-in.

Note: The field's Key is what links everything together — it's how the value is stored and how the guard card finds it in Part 2. You don't need to memorize it; the overlay in Part 2 lists your fields by name.


Part 2 — Show the field on the Security Monitor guard card

Once the field is configured, tell the guard card which fields to overlay.

Step 1. Go to Settings → Guard Verification.

Step 2. Make sure Enable guard verification card is turned on.

Step 3. Under Overlay fields on the visitor card, you'll see two groups:

  • Custom kiosk fields — every custom field you created in Part 1 (e.g. HKID)
  • Built-in fields — ID Number, Company, Visitor Type, Host, Phone

Click the HKID chip so it turns blue. That's it — it saves automatically.

Tip: The custom-field chips are populated directly from your kiosk custom fields, so the keys always match. If you don't see your field here, confirm you saved and published the flow in Part 1 first.


Part 3 — See it in action

  1. Have a visitor check in on the kiosk and enter their HKID on the Additional Info step.
  2. Open the Security Monitor (left sidebar → Security Monitor, or the Guard app's live monitor).
  3. When the guard views or scans that visitor, the guard card now shows the HKID value overlaid on the visitor's photo, alongside the other fields you enabled.

Troubleshooting

  • The field chip doesn't appear under Guard Verification. The custom field wasn't saved/published. Go back to Settings → Kiosk → Flow Builder → Custom Form, add the field, then Save & Publish. Refresh Guard Verification.
  • The value is blank on the guard card. The visitor checked in before the field existed, or skipped it. Custom values are captured at check-in — have the visitor check in again with the field present. Returning visitors get the value saved on their next check-in.
  • Guards don't see the card at all. Turn on Enable guard verification card under Settings → Guard Verification.