Objects

Objects

---

Address

Fields

Name	Description
id ID	A unique address identifier.
priority Int	Level of priority.
addressIdentifier String	A unique identifier of an address.
street String	Street Line 1 information.
streetLine2 String	Street Line 2 information.
streetNumber String	Street number.
city String	City name.
province String	Province name.
postalCode String	Postal code information.
countryCode String	Country code information.
businesses [Business]	List of companies related to a particular address.
created DateTime	The date and time when the address information is entered - the entry is saved for the first time.
modified DateTime	Date and time when address information is modified.
deleted DateTime	Date and time when address information is deleted.

Business

Fields

Name	Description
id ID	A unique business identifier.
companyIdType String	A unique company identifier type.
companyId String	A unique company identifier.
companyName String	Company name.
foundingDate String	Date of establishment of the company.
persons [Person]	List of all persons related to a particular business.
addresses [Address]	List of all addresses related to a particular business.
documents [BusinessDocument]	List of all documents related to a particular company.
communications [Communication]	List of types of communication with a particular company (i.e. email, IP address, phone, LinkedIn, website).
created DateTime	The date and time when company information is entered into the system for the first time.
modified DateTime	Date and time when the company information is modified.
deleted DateTime	Date and time when the company information is deleted.

BusinessDocument

Fields

Name	Description
id ID	A unique company document identifier.
number String	Company document number.
expiry DateTime	Company document expiration date.
type String	Document type.
created DateTime	The date and time the company document information is entered into the system for the first time.
modified DateTime	Date and time when the company document information is modified.
deleted DateTime	Date and time when the company document information is deleted.

Check

Fields

Name	Description
id ID	A unique check identifier.
configurationId ID	A unique check configuration identifier.
sessionId ID	A unique session identifier.
session Session	Session information.
checkType CheckType	Check type information.
checkStatus CheckStatus	Check status information.
description String	Check description.
cost Decimal	Check cost.
price Decimal	Check price.
errorCode String	Check error code.
errorDescription String	Check error code description.
results [CheckResult]	Arguments Name Description skip Int How many elements to skip so that they are not included on the results page? take Int How many elements should be included on the results page?
matches Int	List of check matches.
availableGroups [String]	List of all available check groups.
availableFields [String]	List of all available fields.
started DateTime	Date and time when check is started.
finished DateTime	Date and time when check is finished.
created DateTime	Date and time when check is created.
modified DateTime	Date and time when check is modified.
deleted DateTime	Date and time when check is deleted.

CheckResult

Fields

Name	Description
id ID	A unique check result identifier.
note String	Check notes.
sessionCheckId ID	A unique session check identifier.
sessionCheck Check	Session check type.
falsePositiveUserId ID	A unique user identifier of False check result.
falsePositive DateTime	False check result.
truePositiveUserId ID	A unique user identifier of True check result.
truePositive DateTime	True check result.
person Person	Personal data of the verified person.
business Business	Business information of the business verified.
entityType String	Entity type.
entityUniqueId String	A unique entity identifier.
category String	Check result category, True, False or Pending
matchRate String	Calculating how well a company's data set "matches" or overlaps with the data in the check results.
errorCode String	Check result error code.
errorDescription String	Check result error description.
groups [CheckResultGroup]	List of all check result groups. Arguments Name Description names [String] Names of the check result groups.
status String	Check result status.
created DateTime	Date and time when the check result is created.
modified DateTime	Date and time when the check result is modified.
deleted DateTime	Date and time when the check result is deleted.

CheckResultField

Fields

Name	Description
id ID	A unique check results field identifier.
priority Int	Check results priority.
field String	Check results field.
value String	Check results value.
groupId ID	A unique check results group identifier.
group CheckResultGroup	List of all check results groups.
created DateTime	Date and time the check result field is created.
modified DateTime	Date and time the check result field is modified.
deleted DateTime	Date and time the check result field is deleted.

CheckResultGroup

Fields

Name	Description
id ID	A unique check results group identifier.
sequenceNumber Int	Check results sequence number.
group String	Check result group information.
description String	Check result group description.
isPrimary Boolean	Flag that indicates whether this is the primary check result group or not.
priority Boolean	A Boolean value that indicates whether this is the priority check result group or not.
checkResultId ID	A unique check results group identifier.
checkResult CheckResult	Check results group information.
fields [CheckResultField]	List of all check results group fields.
created DateTime	Date and time the check results group is created.
modified DateTime	Date and time the check results group is modified.
deleted DateTime	Date and time the check results group is deleted.

Communication

Fields

Name	Description
id ID	A unique communication type identifier.
priority Int	Priority level.
communicationIdentifier String	Communication identifier protocol.
phone String	Communication data is phone number.
email String	Communication data is an e-mail.
website String	Communication data is website's information - URL.
websiteIp String	Communication data is website IP address.
linkedIn String	Communication data is LinkedIn account.
ipAddress String	Communication data is IP address.
persons [Person]	List of all persons related to a particular company.
businesses [Business]	List of all businesses related to communication types.
created DateTime	The date and time when the communication information is entered into the system.
modified DateTime	Date and time the communication information is modified.
deleted DateTime	Date and time the communication information is deleted.

Company

Fields

Name	Description
id ID	A unique company identifier.
name String	Company name.
description String	Company description.
status CompanyStatus	Company status.
contactPersonPosition String	Company contact person position.
contactPersonName String	Company contact person name.
statusUserNote String	Company user notes.
adminNote String	Company administrator notes.
idNumber String	A unique company identification number.
address String	Company Address Line 1 information.
address2 String	Company Address Line 2 information.
zip String	ZIP code.
city String	City where the company is located.
state String	State where the company is located.
email String	Contact e-mail.
facebook String	Social networks company account - Facebook.
linkedin String	Social networks company account - LinkedIn.
phoneNumber String	Contact phone number.
website String	Official company website.
ipAddresses String	Company IP address.
pricePerCheck Decimal	Price per check information.
revShare Decimal	Revenue Share information.
countryId ID	A unique identifier of the country where the company is located.
country Country	Country where the company is located.
categoryId ID	A unique company category identifier.
category CompanyCategory	Company category.
avatarId ID	A unique identifier of the company logo file.
coverId ID	A unique identifier of the company cover file.
created DateTime	Date and time when the company was created - registered in the system.
modified DateTime	Date and time when the company information is modified.
deleted DateTime	Date and time when the company information is deleted.
users [User]	A list of all users associated with a particular company.

CompanyCategory

Fields

Name	Description
id ID	A unique company category identifier.
name String!	Company category name.
description String	Company category description.
created DateTime	Date and time the company category is created.
modified DateTime	Date and time the company category is modified.
deleted DateTime	Date and time the company category is deleted.

CompanyCheck

Fields

Name	Description
id ID	A unique company check identifier.
name String!	Company check name.
description String	Company check description.
isActive Boolean	Company check flag - "Is active".
companyId ID	A unique company identifier associated with a particular company check.
company Company	Company information.
providerCheckId ID	A unique provider check identifier associated with a particular company check.
providerCheck ProviderCheck	Provider check name.
checkType CheckType	Company check type.
pricePerCheck Decimal	Price per check.
revShare Decimal	Revenue Share information.
maxRateMonthly Int	Maximal monthly rate.
configurations [Configuration]	Lits of all configurations associated with a particular company check.
created DateTime	Date and time when the company check is created.
modified DateTime	Date and time when company check is modified.
deleted DateTime	Date and time when the company check is deleted.

ConfigApplication

Fields

Name	Description
id ID	A unique ConfigApplication identifier.
name String	ConfigApplication name.
description String	ConfigApplication description.
companyId ID	A unique company identifier.
company Company	All company data.
application Application	All application information.
defaultResponse ResponseTransport	Predefined - default response.
isTesting Boolean	The "Is Testing" flag is used for launching test sessions with test entities' data.
pricePerCheck Decimal	Price per check.
revShare Decimal	Revenue Share information.
configurations [Configuration]	List of all configurations.
created DateTime	Date and time the ConfigApplication is created.
modified DateTime	Date and time the ConfigApplication is modified.
deleted DateTime	Date and time the ConfigApplication is deleted.

Configuration

Fields

Name	Description
id ID	A unique configuration identifier.
name String	Configuration name.
description String	Configuration description.
configCode String	Configuration code.
companyId ID	A unique company identifier associated with a particular configuration.
company Company	Company information.
configApplicationId ID	A unique configApplication identifier associated with a particular configuration.
configApplication ConfigApplication	List of all configApplication information associated with a particular configuration.
isTesting Boolean	The "Is Testing" flag is used for launching test sessions with test entities' data.
allowOverrides Boolean	Flag that indicates whether the associated configuration section can be overridden by lower-level configuration files.
fieldSets [ConfigurationFieldSet]	List of all fieldSets that are associated with a particular configuration.
checks [CompanyCheck]	List of all check types associated with a particular configuration.
created DateTime	Date and time when the configuration is created.
modified DateTime	Date and time when the configuration is modified.
deleted DateTime	Date and time when the configuration is deleted.

Country

Fields

Name	Description
id ID	A unique country identifier.
name String!	Country name.
isoCode2 String	ISO 3166-2 – Codes for the country representation and subdivisions.
isoCode3 String	ISO 3166-3 – Codes for the representation of names of countries and their subdivisions.
isDefault Boolean	A flag indicating whether the country entry is default or not.
order Int	Country order values.
created DateTime	Date and time the country information is entered into the system.
modified DateTime	Date and time the country information is modified.
deleted DateTime	Date and time the country information is deleted.

Document

Fields

Name	Description
id ID	A unique document identifier.
number String	Document number.
expiry DateTime	Document expiration date.
type DocumentType	Document type.
mrz1 String	Machine-readable zone one.
mrz2 String	Machine-readable zone two.
idType String	A unique type identifier.
districtOfIssue String	District where the document was issued.
cityOfIssue String	City where the document was issued.
provinceOfIssue String	Province where the document was issued.
countyOfIssue String	County where the document was issued.
state String	State where the document was issued.
images [DocumentImage]	List of all document images.
created DateTime	Date and time when the document is created.
modified DateTime	Date and time the document is modified.
deleted DateTime	Date and time the document is deleted.

DocumentImage

Fields

Name	Description
id ID	A unique document image identifier.
documentId ID	A unique document identifier.
document Document	Document information.
imagePath String	Document image path.
imageBase64 String	Converts image to Base64 (encode to Base64).
description String	Image description.
created DateTime	Date and time when the document image is created.
modified DateTime	Date and time the document image is modified.
deleted DateTime	Date and time the document image is deleted.

Field

Fields

Name	Description
id ID	A unique field identifier.
name String!	Field name.
label String	Field label - for which input types it is predefined.
description String	Field description.
defaultValue String	Default field value.
valueType ValueType	Types of fields values - string, integer, date/time.
min Int	Minimal field value.
max Int	Maximal field value.
minLength Int	Minimal field length.
maxLength Int	Maximal field length.
orderNumber Int	Field values automatically display in ascending order, beginning with the lowest value and continuing to the highest.
required Boolean	A flag indicating whether a field is required or not.
pattern String	Field pattern.
type String	Field type.
visible Boolean	A flag indicating whether a field is visible or not.
isSystemLocked Boolean	Returns a true value if the field is locked by the system.
fieldSetId ID	A unique fieldSet identifier that is associated with a particular field.
fieldSet FieldSet	FieldSet information.
created DateTime	Date and time when the field is created.
modified DateTime	Date and time when the field is modified.
deleted DateTime	Date and time when the field is deleted.

Language

Fields

Name	Description
id Int!	A unique language identifier.
isoCode2 String!	Language ISO code 2 information, ISO 639-2 - three-letter codes, for the same languages as 639-1.
isoCode3 String	ISO 639-3: three-letter codes, the same as 639-2/T for languages, but with distinct codes for each variety of an ISO 639 macrolanguage.
name String!	Language information.
isDefault Boolean!	A flag indicating whether a particular language is the default or not.

PaginatorConfigApplicationGType

Fields

Name	Description
totalCount Int	Total count of PaginatorConfigApplicationGType data.
data [ConfigApplication]	List of all PaginatorConfigApplicationGType data.

PaginatorConfigurationGType

Fields

Name	Description
totalCount Int	Total count of PaginatorConfigurationGType data.
data [Configuration]	List of all PaginatorConfigurationGType data.

PaginatorSessionGType

Fields

Name	Description
totalCount Int	Total count of PaginatorSessionGType data.
data [Session]	List of all PaginatorSessionGType data.

Person

Fields

Name	Description
id ID	A unique person identifier.
firstName String	Person's first name.
middleName String	Person's middle name.
lastName String	Person's last name.
isoLatin1Name String	Latin-1 character set, ISO-8859-1.
gender String	Person's gender.
nationality String	Person's nationality.
title String	Person's title.
role String	Person's role.
ownerPercentage Int	Percentage of person's ownership.
dob DateTime	Date Of Birth.
businesses [Business]	A list of all businesses associated with a particular person.
addresses [Address]	A list of all addresses associated with a particular person.
documents [Document]	A list of all documents associated with a particular person.
communications [Communication]	List of all communication types associated with a particular person.
created DateTime	Date and time when the person information is entered into the system.
modified DateTime	Date and time the person information is modified.
deleted DateTime	Date and time the person information is deleted.

Provider

Fields

Name	Description
id ID	A unique provider identifier.
name String	Provider's name.
description String	Provider description.
code String	Provider's code.
created DateTime	Date and time the provider is created.
modified DateTime	Date and time the provider is modified.
deleted DateTime	Date and time the provider is deleted.

ProviderCheck

Fields

Name	Description
id ID	A unique provider check identifier.
name String	Provider check name.
description String	Provider check description.
sourceType SourceType	Provider check source type.
provider Provider	Provider information.
providerId ID	A unique provider identifier.
checkType CheckType	Check type.
costPerCheck Decimal	Cost per check.
pricePerCheck Decimal	Price per check.
revShare Decimal	Revenue Share information.
maxRateMonthly Int	Maximal monthly rate.
checkTypes [ProviderCheckType]	Provider check types.
fieldSets [FieldSet]	Provider field sets information.
fields [Field]	Provider check fields.
created DateTime	Date and time the provider check is created.
modified DateTime	Date and time the provider check is modified.
deleted DateTime	Date and time the provider check is deleted.

ProviderCheckType

Fields

Name	Description
id ID	A unique provider check type identifier.
providerCheckId ID	A unique provider check identifier.
providerCheck ProviderCheck	Provider check information.
checkType CheckType	Provider check type associated with a particular check type.
created DateTime	Date and time the provider check is created.
modified DateTime	Date and time the provider check is modified.

Session

Fields

Name	Description
id ID	A unique session identifier.
code String	Session code.
status SessionStatus	Sessions status.
overallCheckStatus CheckStatus	Overall check status - represents a set of all checks, and it includes all check statuses.
subjectName String	The name of the subject for which the session is launched.
companyId ID	A unique identifier of the company for which the session is launched.
configurationId ID	A unique configuration identifier of the session launched.
note String	Session results notes - Confirm Hit or Archive/Remove.
description String	Session description information.
userId ID	The unique identifier of the user who launched the session.
apiTokenId ID	A unique API Token identifier.
responseTransport ResponseTransport	Type of response transport.
checks [Check]	List of all checks included in the session launched.
businesses [Business]	List of all business associated with a particular check type.
persons [Person]	List of all persons associated with a particular check type.
cost Decimal	Check cost.
price Decimal	Check price.
isTesting Boolean	The "Is Testing" flag is used for launching test sessions with test entities' data.
webHook String	Specified webhook where response returns to.
errorCode String	Session error code.
errorDescription String	Session error description.
created DateTime	Date and time when the session is created.
modified DateTime	Date and time when the session is modified.
deleted DateTime	Date and time when the session is deleted.

User

Fields

Name	Description
id ID	A unique user identifier.
firstName String!	User's first name.
middleName String	User's middle name.
lastName String!	User's last name.
avatarId ID	A unique identifier of the user's logo file.
email String	User's e-mail.
title String	User's title.
phoneNumber String	User's phone number.
address String	User's Address Line 1.
address2 String	User's Address Line 2.
city String	User's residence city.
zip String	User's residence city ZIP code.
state String	User's residence state.
countryId ID	A unique identifier of the user's country of residence.
country Country	Country information.
languageId Int	A unique language identifier.
language Language	The language that the user sets according to his own preferences.
authToken String	An authorization token information.
emailConfirmed Boolean	A flag indicating whether the user's e-mail address is verified or not.
isLocked Boolean	The user's account is locked.
lockoutEnd DateTime	Date and time when the user account will be unlocked.
isPhoneValid Boolean	A flag indicating whether the user's phone number is valid or not.
companies [Company]	List of companies associated with a particular user.
lastLogin DateTime	Date and time of last login to the system.
created DateTime	Date and time when user's account is created.
modified DateTime	Date and time when user's account is modified.
deleted DateTime	Date and time when user's account is deleted.
permissions [Permission]	List of permissions associated with a particular user.
roles [String]	List of roles associated with a particular user.
company Company	Company information.
defaultCompany Company	Default company that the user has an access to.