AccessCriteria Json Schema

In This Topic

Description

The AccessCriteria object contains fields for internal use used to tailor the search. They are not required by the customer.

Overview

AccessCriteria

The AccessCriteria object contains fields for internal use used to tailor the search. They are not required by the customer.

accessPortal : string

internal only

companyIds : Array[ObjectId]

Pass an array of company IDs to search on those lenders only. Required field.

internal only

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

dataLog : boolean

Select True to log search data. Default value is False.

internal only

fieldsToRemove : Array[string]

An array of fields to remove from the search results.

internal only

id : ObjectId

Metadata for the AccessCriteria object is stored within the id field.

internal only

counter : integer

internal only

date : string

The current date.

internal only

machineIdentifier : integer

internal only

processIdentifier : integer

internal only

time : integer

internal only

timeSecond : integer

internal only

timestamp : integer

internal only

marketPlaceSearch : boolean

Set this value to True if you want to simulate a "marketplace" for the broker search.

Default value is False.

overrideNode : integer

internal only

userContext : UserContext

groupType : string

groups : Array[GroupOverride]

externalId : string

nmlsId : string

id : ObjectId

overrided : boolean

userEmail : string

userId : ObjectId

username : string

Properties

Name	Description	Data Type
accessPortal	internal only	string
companyIds	Pass an array of company IDs to search on those lenders only. Required field. internal only	Array[ObjectId]
dataLog	Select True to log search data. Default value is False. internal only	boolean
fieldsToRemove	An array of fields to remove from the search results. internal only	Array[string]
id	Metadata for the AccessCriteria object is stored within the `id` field. internal only	ObjectId
marketPlaceSearch	Set this value to True if you want to simulate a "marketplace" for the broker search. Default value is False.	boolean
overrideNode	internal only	integer
userContext		UserContext