class

Plaid::WatchlistScreeningEntityGetResponse

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

The entity screening object allows you to represent an entity in your system, update its profile, and search for it on various watchlists. Note: Rejected entity screenings will not receive new hits, regardless of entity program configuration.

Constants

MIN_LENGTH_FOR_CLIENT_USER_ID = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, id : String | Nil = nil, search_terms : EntityWatchlistScreeningSearchTerms | Nil = nil, assignee : String | Nil = nil, status : Plaid::WatchlistScreeningStatus | Nil = nil, client_user_id : String | Nil = nil, audit_trail : WatchlistScreeningAuditTrail | Nil = nil, request_id : String | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

assignee

ID of the associated user.

Source
assignee=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] assignee Object to be assigned

Source
audit_trail
Source
audit_trail=(new_value : WatchlistScreeningAuditTrail | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] audit_trail Object to be assigned

Source
client_user_id

A unique ID that identifies the end user in your system. This ID can also be used to associate user-specific data from other Plaid products. Financial Account Matching requires this field and the /link/token/create client_user_id to be consistent. Personally identifiable information, such as an email address or phone number, should not be used in the client_user_id.

Source
client_user_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_user_id Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

id

ID of the associated entity screening.

Source
id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] id Object to be assigned

Source
list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
request_id

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Source
request_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] request_id Object to be assigned

Source
search_terms
Source
search_terms=(new_value : EntityWatchlistScreeningSearchTerms | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] search_terms Object to be assigned

Source
status
Source
status=(new_value : Plaid::WatchlistScreeningStatus | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] status Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source