The Visit Object
The Object
Attribute | Description |
*id
| It is a UUID v4 (36 characters long) automatically generated |
*checkinAt
| Date and time of the visit check-in, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds) |
*type
| This is an immutable field which indicates the type of the object. In this case 'visit' |
event
| Only used by Webhook Endpoint |
checkoutAt
| Date and time of the visit checkout, e.g.: "2014-09-08T08:02:17-05:00" (ISO 8601, no fractional seconds) |
isInsideCompany
| Indicates if the visitor has or has not checked out yet |
name
| Visitor name |
host
| |
pictureUrl
| A string containing the URL of the visit picture in |
ndaUrl
| A string containing the URL of the visit signed the document in |
phone
| The phone of the visitor |
cpf
| CPF of the visitor. (Brazil only) |
rg
| RG of the visitor. (Brazil only) |
document
| Document of the visitor. |
| Email of the visitor. |
address
| Address of the visitor. |
company
| Company of the visitor. |
position
| Position of the visitor. |
sector
| The sector of the visitor. |
customFields
| Extra fields following the Custom Field Object |
authorizationStatus
| If authorization is enabled. This field can accept only 3 values: |
notes
| Private notes |
Custom Field Object
Attribute | Description |
*id
| Id of the field (Default: 9 characters long) |
*name
| Name of the field |
*type
| Type of the field. E.g.: |
value
| Response provided by the visitor |
Short Sample
Available Methods
GET /v1/visit/:id
GET /v1/visits
PATCH /v1/visit/allow/:id
PATCH /v1/visit/deny/:id
PATCH /v1/visit/checkout/:id
DELETE /v1/visit/:id
Table of Errors
Method | Type | Description |
| INVALID_QUERY_OPERATOR INVALID_QUERY_KEY INVALID_LIMIT_VALUE INVALID_OFFSET_VALUE | |
| ALREADY_CHECKOUT | |
| CHECKOUT_AT_BEFORE_CHECKIN | |
| WRONG_CHECKOUT_AT_FORMAT | |
| INVITEE_NOT_FOUND | |
| NOT_FOUND | |
| MISSING_ID | |
| INTERNAL | |
| UNAUTHORIZED |
Last updated