MonitoringAlert.md

Synctera::MonitoringAlert

Properties

Name	Type	Description	Notes
business_id	String	Unique ID for the business. Exactly one of `business_id` or `person_id` must be set.	[optional]
creation_time	Time	The date and time the resource was created.	[optional][readonly]
id	String	Unique identifier for this alert.	[optional][readonly]
last_updated_time	Time	The date and time the resource was last update.	[optional][readonly]
metadata	Object	Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.	[optional]
person_id	String	Unique ID for the person. Exactly one of `person_id` or `business_id` must be set.	[optional]
status	MonitoringStatus		[optional]
title	String	A description of the monitoring alert.	[optional]
type	String	The type of customer alert. Any of the following: * `WATCHLIST` – the customer was added to a known watchlist. * `BANKRUPTCY` – the customer filed for bankruptcy. * `NEGATIVE_NEWS` – the customer was mentioned in negative news articles. * `LICENSE_VALIDITY` – the license is no longer valid. Exmaple of this would be if a license was suspended	[optional][readonly]
urls	Array<String>	Where to get more information about this alert.	[optional][readonly]
vendor_info	VendorInfo		[optional]

Example

require 'synctera'

instance = Synctera::MonitoringAlert.new(
  business_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7,
  creation_time: 2010-05-06T12:23:34.321Z,
  id: null,
  last_updated_time: 2010-05-06T12:23:34.321Z,
  metadata: null,
  person_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7,
  status: null,
  title: Ireland Competition and Consumer Protection Commission Criminal Court Cases,
  type: null,
  urls: ["https://example.com/alert-document-1","https://example.com/alert-document-2"],
  vendor_info: null
)