Skip to main content
POST
Signing in a visitor

Authorizations

Authorization
string
header
required

An API key issued in the Backoffice, sent as Authorization: Bearer vzk_<key id>_<secret>. A Microsoft Entra ID access token obtained with the client credentials grant is accepted on the same header. The same value is also accepted in an X-API-Key header.

Body

application/json
company_id
string
required

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

visit_type
string

Falls back to the location's default visit type.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

first_name
string
last_name
string
company
string
email
string<email>
phone
string

Prefixed with the visit type's default country code when it does not start with +.

recipient
string

Name of the host. Match an existing host's cn and their contact details are filled in automatically.

recipient_mail
string<email>
known_visitor_id
string

Links the visit to a registered visitor. Hidden fields stored on that record are carried over.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

entrypoint_id
string

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
Example:

"5f2a1b9c4d3e2f0011223344"

signed_in_source
enum<string>
default:1

0 Backoffice or API, 1 kiosk, 2 contactless.

Available options:
0,
1,
2
signed_in_frombo
string<date-time>

Backdates the sign-in. Defaults to now.

fo_language
string

Language for the visitor's emails.

Response

The visit that was created.

message
string
Example:

"Visitor added!"

data
object

One visit. Every custom field the visit type defines is also present, under its own field_name.