Skip to main content
GET
Fetching a registered 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.

Path Parameters

knownvisitor_id
string
required

The registered visitor id. A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

Response

The registered visitor, or a message when there is none.

An expected visitor. Custom fields defined by the visit type are stored here too, under their own field_name, and carried onto the visit.

_id
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

company_id
string[]

A 24-character hexadecimal id.

Pattern: ^[0-9a-fA-F]{24}$
first_name
string
last_name
string
company
string
email
string<email>
phone
string
recipient
string
visit_type
string

A 24-character hexadecimal id.

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

"5f2a1b9c4d3e2f0011223344"

visiting_on
object

When a visit is expected. Absent means "any day".

persistent
boolean

Kept after the visit; never removed by data retention.

language
string

Language of the invitation email.

pre_registration_by_visitor
boolean

The visitor filled in their own details through the invitation.

create_date
string<date-time>
mod_date
string<date-time>