This page details the standard values, enums, and models that will be passed into or returned by requests.
The Enums and Models sections will be listed in alphabetical order for ease of access.
Important Information
All DateTime objects leaving our system will be in UTC format so you will have to convert them into your local time once you receive them.
Models
Account Info
| Property | Type | Description |
|---|---|---|
| id | Guid | The account Id in our system. |
| name | string | The name of the account. |
| isActive | boolean | The active state of the account. |
| termsAndConditions | string | The URL for the terms and conditions page that you want to display in emails and SMS messages sent out. |
| templateId | string | The email template Id for your company. |
| created | DateTime | The DateTime of your account's creation. |
Organization
| Property | Type | Description |
|---|---|---|
| id | Guid | The Id of that organization. |
| name | string | The name of that organization. |
| isActive | boolean | Whether or not that organization is active. |
| matchOnCreate | boolean | Whether or not that organization allows for duplicate faces. By default, this value is true. |
| created | DateTime | The DateTime of that organization's creation. |
| updated | DateTime? | The DateTime of the last time that organization was updated, if applicable. |
Webhook Response
| id | Guid | The Id of the event from our system. |
| accountId | Guid | The account Id of the your account. |
| organizationId | Guid | The Id of the organization from which the event occurred. |
| correlationId | Guid | The correlation Id provided. |
| eventCode | string | The event code. For a complete list on available codes, see here. |
| payload | object | The object, if any, that will be provided with the event. |
| timestamp | long | The Unix timestamp (in seconds) of the event. |