Creating a registered visitor
curl --request POST \
--url https://api.vizito.eu/api/knownvisitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_id": "5f2a1b9c4d3e2f0011223344"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({company_id: '5f2a1b9c4d3e2f0011223344'})
};
fetch('https://api.vizito.eu/api/knownvisitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/knownvisitors"
payload = { "company_id": "5f2a1b9c4d3e2f0011223344" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vizito.eu/api/knownvisitors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company_id' => '5f2a1b9c4d3e2f0011223344'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Known Visitor added!",
"data": {
"_id": "5f2a1b9c4d3e2f0011223344",
"company_id": [
"5f2a1b9c4d3e2f0011223344"
],
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"recipient": "<string>",
"visit_type": "5f2a1b9c4d3e2f0011223344",
"visiting_on": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"persistent": true,
"language": "<string>",
"pre_registration_by_visitor": true,
"create_date": "2023-11-07T05:31:56Z",
"mod_date": "2023-11-07T05:31:56Z"
}
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}Registered visitors
Creating a registered visitor
Creates a registered visitor: somebody you expect. When they arrive and sign in, a visit is created from this record and the record itself stays as it is.
Creating the record does not mail anybody — send the invitation as a separate step.
POST
/
knownvisitors
Creating a registered visitor
curl --request POST \
--url https://api.vizito.eu/api/knownvisitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"company_id": "5f2a1b9c4d3e2f0011223344"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({company_id: '5f2a1b9c4d3e2f0011223344'})
};
fetch('https://api.vizito.eu/api/knownvisitors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vizito.eu/api/knownvisitors"
payload = { "company_id": "5f2a1b9c4d3e2f0011223344" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vizito.eu/api/knownvisitors",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'company_id' => '5f2a1b9c4d3e2f0011223344'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"message": "Known Visitor added!",
"data": {
"_id": "5f2a1b9c4d3e2f0011223344",
"company_id": [
"5f2a1b9c4d3e2f0011223344"
],
"first_name": "<string>",
"last_name": "<string>",
"company": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"recipient": "<string>",
"visit_type": "5f2a1b9c4d3e2f0011223344",
"visiting_on": {
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z"
},
"persistent": true,
"language": "<string>",
"pre_registration_by_visitor": true,
"create_date": "2023-11-07T05:31:56Z",
"mod_date": "2023-11-07T05:31:56Z"
}
}{
"error": "Invalid API key"
}{
"error": "Invalid API key"
}Authorizations
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
A 24-character hexadecimal id.
Pattern:
^[0-9a-fA-F]{24}$Example:
"5f2a1b9c4d3e2f0011223344"
A 24-character hexadecimal id.
Pattern:
^[0-9a-fA-F]{24}$Example:
"5f2a1b9c4d3e2f0011223344"
Required if you want to invite them.
When a visit is expected. Absent means "any day".
Show child attributes
Show child attributes

