Security

Manage security scanning, entry logs, emergency contacts, and lost card reports.

Scan Identity Code

POST/api/hr/security/scan

Scan an identity code for entry/exit (Security only).

Field	Type	Required	Description
`identityCode`	string	Required	Identity code to scan

{ "user": { "id": "...", "name": "John Doe", "avatarUrl": "..." }, "entryLog": { "id": "...", "type": "entry", "method": "qr-scan", "timestamp": "2024-01-15T09:00:00Z" } }

Get Security Members

GET/api/hr/security/members

Get all security team members.

{ "members": [ { "id": "...", "name": "Security Guard", "role": "security" } ] }

Get Entry Logs

GET/api/hr/security/entry-logs

Get entry/exit logs with optional filters.

Query Param	Type	Required	Description
`from`	string	Optional	Start date (YYYY-MM-DD)
`to`	string	Optional	End date (YYYY-MM-DD)
`userId`	string	Optional	Filter by user ID

{ "logs": [ { "id": "...", "user": { "id": "...", "name": "John" }, "type": "entry", "method": "qr-scan", "timestamp": "2024-01-15T09:00:00Z" } ] }

Create Entry Log

POST/api/hr/security/entry-logs

Manually create an entry/exit log.

Field	Type	Required	Description
`userId`	string	Optional	User ID (for employees)
`visitorPassId`	string	Optional	Visitor pass ID (for visitors)
`type`	string	Required	Entry type (entry/exit)
`method`	string	Optional	Scan method (qr-scan/manual/id-card)

{ "log": { "id": "...", "type": "entry", "timestamp": "2024-01-15T09:00:00Z" } }

Get Emergency Contacts

GET/api/hr/security/emergency-contacts

Get all emergency contacts for the company.

{ "contacts": [ { "id": "...", "name": "Emergency Contact", "phone": "+1234567890", "relation": "Spouse" } ] }

Get Lost Card Reports

GET/api/hr/security/lost-cards

Get all lost card reports.

{ "reports": [ { "id": "...", "user": { "id": "...", "name": "John" }, "reason": "lost", "status": "reported", "lastLocation": "Office Floor 2", "lostDateTime": "2024-01-14T15:30:00Z" } ] }

Report Lost Card

POST/api/hr/security/lost-cards

Report a lost/stolen/damaged ID card.

Field	Type	Required	Description
`userId`	string	Required	User reporting the lost card
`reason`	string	Required	Reason (lost/stolen/damaged/not-working)
`lastLocation`	string	Optional	Last known location
`lostDateTime`	string	Optional	When card was lost (ISO)
`policeComplaintNumber`	string	Optional	Police complaint number (if stolen)
`isEmergency`	boolean	Optional	Mark as emergency

{ "report": { "id": "...", "status": "reported", "reason": "lost" } }

Update Lost Card Report

PATCH/api/hr/security/lost-cards/[id]

Update lost card report status.

Field	Type	Required	Description
`status`	string	Required	New status

{ "report": { ... updated report } }

Open Ticket

POST/api/hr/security/lost-cards/[id]/open-ticket

Open a ticket for lost card replacement.

Field	Type	Required	Description
`assignedJuniorSecurityId`	string	Optional	Assign to junior security

{ "report": { ... updated report } }

Accept Ticket

POST/api/hr/security/lost-cards/[id]/accept-ticket

Accept a lost card ticket for processing.

{ "report": { ... updated report } }

Complete Ticket

POST/api/hr/security/lost-cards/[id]/complete-ticket

Mark a lost card ticket as completed.

Field	Type	Required	Description
`notes`	string	Optional	Completion notes

{ "report": { ... updated report } }

Disable Access

POST/api/hr/security/lost-cards/[id]/disable-access

Disable access for a lost card.

Field	Type	Required	Description
`disabledZones`	string[]	Optional	Zones to disable access for

{ "report": { ... updated report } }

Card Found

POST/api/hr/security/lost-cards/[id]/found

Mark a lost card as found.

Field	Type	Required	Description
`oldCardFound`	boolean	Optional	Whether old card was found
`oldCardDestroyed`	boolean	Optional	Whether old card was destroyed

{ "report": { ... updated report } }

Security

Manage security scanning, entry logs, emergency contacts, and lost card reports.

Scan Identity Code

POST/api/hr/security/scan

Scan an identity code for entry/exit (Security only).

Field	Type	Required	Description
`identityCode`	string	Required	Identity code to scan

{ "user": { "id": "...", "name": "John Doe", "avatarUrl": "..." }, "entryLog": { "id": "...", "type": "entry", "method": "qr-scan", "timestamp": "2024-01-15T09:00:00Z" } }

Get Security Members

GET/api/hr/security/members

Get all security team members.

{ "members": [ { "id": "...", "name": "Security Guard", "role": "security" } ] }

Get Entry Logs

GET/api/hr/security/entry-logs

Get entry/exit logs with optional filters.

Query Param	Type	Required	Description
`from`	string	Optional	Start date (YYYY-MM-DD)
`to`	string	Optional	End date (YYYY-MM-DD)
`userId`	string	Optional	Filter by user ID

{ "logs": [ { "id": "...", "user": { "id": "...", "name": "John" }, "type": "entry", "method": "qr-scan", "timestamp": "2024-01-15T09:00:00Z" } ] }

Create Entry Log

POST/api/hr/security/entry-logs

Manually create an entry/exit log.

Field	Type	Required	Description
`userId`	string	Optional	User ID (for employees)
`visitorPassId`	string	Optional	Visitor pass ID (for visitors)
`type`	string	Required	Entry type (entry/exit)
`method`	string	Optional	Scan method (qr-scan/manual/id-card)

{ "log": { "id": "...", "type": "entry", "timestamp": "2024-01-15T09:00:00Z" } }

Get Emergency Contacts

GET/api/hr/security/emergency-contacts

Get all emergency contacts for the company.

{ "contacts": [ { "id": "...", "name": "Emergency Contact", "phone": "+1234567890", "relation": "Spouse" } ] }

Get Lost Card Reports

GET/api/hr/security/lost-cards

Get all lost card reports.

{ "reports": [ { "id": "...", "user": { "id": "...", "name": "John" }, "reason": "lost", "status": "reported", "lastLocation": "Office Floor 2", "lostDateTime": "2024-01-14T15:30:00Z" } ] }

Report Lost Card

POST/api/hr/security/lost-cards

Report a lost/stolen/damaged ID card.

Field	Type	Required	Description
`userId`	string	Required	User reporting the lost card
`reason`	string	Required	Reason (lost/stolen/damaged/not-working)
`lastLocation`	string	Optional	Last known location
`lostDateTime`	string	Optional	When card was lost (ISO)
`policeComplaintNumber`	string	Optional	Police complaint number (if stolen)
`isEmergency`	boolean	Optional	Mark as emergency

{ "report": { "id": "...", "status": "reported", "reason": "lost" } }

Update Lost Card Report

PATCH/api/hr/security/lost-cards/[id]

Update lost card report status.

Field	Type	Required	Description
`status`	string	Required	New status

{ "report": { ... updated report } }

Open Ticket

POST/api/hr/security/lost-cards/[id]/open-ticket

Open a ticket for lost card replacement.

Field	Type	Required	Description
`assignedJuniorSecurityId`	string	Optional	Assign to junior security

{ "report": { ... updated report } }

Accept Ticket

POST/api/hr/security/lost-cards/[id]/accept-ticket

Accept a lost card ticket for processing.

{ "report": { ... updated report } }

Complete Ticket

POST/api/hr/security/lost-cards/[id]/complete-ticket

Mark a lost card ticket as completed.

Field	Type	Required	Description
`notes`	string	Optional	Completion notes

{ "report": { ... updated report } }

Disable Access

POST/api/hr/security/lost-cards/[id]/disable-access

Disable access for a lost card.

Field	Type	Required	Description
`disabledZones`	string[]	Optional	Zones to disable access for

{ "report": { ... updated report } }

Card Found

POST/api/hr/security/lost-cards/[id]/found

Mark a lost card as found.

Field	Type	Required	Description
`oldCardFound`	boolean	Optional	Whether old card was found
`oldCardDestroyed`	boolean	Optional	Whether old card was destroyed

{ "report": { ... updated report } }

Security

Scan Identity Code

Get Security Members

Get Entry Logs

Create Entry Log

Get Emergency Contacts

Get Lost Card Reports

Report Lost Card

Update Lost Card Report

Open Ticket

Accept Ticket

Complete Ticket

Disable Access

Card Found

Loading FlowZen

Security

Scan Identity Code

Get Security Members

Get Entry Logs

Create Entry Log

Get Emergency Contacts

Get Lost Card Reports

Report Lost Card

Update Lost Card Report

Open Ticket

Accept Ticket

Complete Ticket

Disable Access

Card Found