Verify Identity
Public endpoints for verifying employee identity codes and visitor passes. These are typically used by security personnel or third-party systems to confirm identity.
Note: All endpoints below are public and do not require authentication.
Verify Employee Identity
GET
/api/public/verify/[identityCode]Verify an employee's company identity code. Returns employee and company info if the code is valid and the ID card has been issued and not revoked.
| Field | Type | Required | Description |
|---|---|---|---|
identityCode | string | Required | Employee identity code (path param) |
Response (200) - Verified
{
"verified": true,
"name": "John Doe",
"role": "Software Engineer",
"companyIdentityCode": "ACME-001",
"companyJoined": "2024-01-15T00:00:00Z",
"companyStatus": "approved",
"avatarUrl": "https://...",
"company": {
"name": "Acme Corp",
"icon": "https://...",
"status": "active",
"primaryColor": "#6366f1"
}
}
Response (200) - Not Verified
{
"verified": false,
"reason": "not-found",
"message": "No employee found with this ID."
}
Failure Reasons
| Reason | Description |
|---|---|
not-found | No employee found with this identity code |
revoked | The ID card has been revoked. Contact HR. |
not-issued | No ID card has been issued for this employee |
Errors
| Status | Message |
|---|---|
400 | Invalid identity code |
Example
GET https://flowzen-azure.vercel.app/api/public/verify/ACME-001
Verify Visitor Identity
GET
/api/public/verify-visitor/[identityCode]Verify a visitor's identity code. Returns visitor pass details if valid and approved.
| Field | Type | Required | Description |
|---|---|---|---|
identityCode | string | Required | Visitor identity code (path param) |
Response (200) - Verified
{
"verified": true,
"visitorName": "Jane Smith",
"visitorCompany": "Tech Inc",
"purpose": "Meeting",
"hostName": "John Doe",
"validFrom": "2024-02-01T09:00:00Z",
"validUntil": "2024-02-01T17:00:00Z"
}
Response (200) - Not Verified
{
"verified": false,
"reason": "not-found"
}
Failure Reasons
| Reason | Description |
|---|---|
not-found | No visitor pass found with this identity code |
expired | Visitor pass has expired |
not-approved | Visitor pass is not approved (pending or rejected) |
Example
GET https://flowzen-azure.vercel.app/api/public/verify-visitor/VIS789