The Visit Object

The Object

Attribute	Description
*id string required	It is a UUID v4 (36 characters long) automatically generated
*checkinAt string required	Date and time of the visit check-in, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)
*type string required	This is an immutable field which indicates the type of the object. In this case 'visit'
event string	Only used by Webhook Endpoint
checkoutAt string	Date and time of the visit checkout, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds)
isInsideCompany bool	Indicates if the visitor has or has not checked out yet
name string	Visitor name
host object	The Host Object
pictureUrl string	A string containing the URL of the visit picture in .jpg or .png
ndaUrl string	A string containing the URL of the visit signed the document in .pdf
phone string	The phone of the visitor
cpf string	CPF of the visitor. (Brazil only)
rg string	RG of the visitor. (Brazil only)
document string	Document of the visitor.
email string	Email of the visitor.
address string	Address of the visitor.
company string	Company of the visitor.
position string	Position of the visitor.
sector string	The sector of the visitor.
customFields array	Extra fields following the Custom Field Object
authorizationStatus string	If authorization is enabled. This field can accept only 3 values: waiting allowed denied
notes string	Private notes

Custom Field Object

Attribute	Description
*id string required	Id of the field (Default: 9 characters long)
*name string required	Name of the field
*type string required	Type of the field. E.g.: Text or Dropdown
value string	Response provided by the visitor

Short Sample

{
    "id": "43d2895a-6785-4442-b065-d4c80d7825c8",
    "checkinAt": "2019-07-09T08:02:17-03:00",
    "isInsideCompany": true,
    "type": "visit",
    "name": "Alisson Enz",
    "host": {
        "id": "b98ff2895de825dec050af67d57a23e1",
        "name": "Gabriel Gratival",
        "email": "[e-mail]",
        "type": "host",
    },
    "pictureUrl": "https://firebasestorage.googleapis.com/v0/b/w3lcome-cbcbb.appspot.com/o/AlissonEnz.jpg?alt=media&token=e2f80260-fc3e-417d-b3ad-572513cf8e18",
    "phone": "(43) 9 9982-0420",
    "email": "[e-mail]",
    "customFields": [
        {
            "id": "aqg-QM4xL",
            "name": "Do you want to receive promotional emails?",
            "type": "Dropdown",
            "value": "Yes",
        }, { 
            ... 
        }
    ],
    "authorizationStatus": "allowed",
    "notes": "He forgot his id"
}

Available Methods

• GET /v1/visit/:id

• GET /v1/visits

• PATCH /v1/visit/allow/:id

• PATCH /v1/visit/deny/:id

• PATCH /v1/visit/checkout/:id

• POST /v1/visit/inviteeCheckin/:inviteeId

• DELETE /v1/visit/:id

Table of Errors

Method	Type	Description
GET /visits	INVALID_QUERY_OPERATOR INVALID_QUERY_KEY INVALID_LIMIT_VALUE INVALID_OFFSET_VALUE
PATCH /visit/checkout/:id	ALREADY_CHECKOUT
PATCH /visit/checkout/:id	CHECKOUT_AT_BEFORE_CHECKIN
PATCH /visit/checkout/:id	WRONG_CHECKOUT_AT_FORMAT
POST /visit/inviteeCheckin/:inviteeId	INVITEE_NOT_FOUND
GET PATCH DELETE	NOT_FOUND
GET PATCH DELETE	MISSING_ID
GET PATCH DELETE	INTERNAL
GET PATCH DELETE	UNAUTHORIZED