Input objects

AddressInput

---

Arguments

Name	Description
id ID	A unique address identifier.
priority Int	Level of the 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.

BusinessDocumentInput

Arguments

Name	Description
id ID	A unique business document identifier.
type String	Business document type.
number String	Business document number.
expiry DateTime	Business document expiration date.

BusinessInput

Arguments

Name	Description
id ID	A unique business identifier.
companyIdType String	A unique company type identifier.
companyId String	A unique company identifier.
companyName String	Company name.
foundingDate String	Date of founding the company.
persons [PersonInput]	Company persons information.
addresses [AddressInput]	Company addresses.
documents [BusinessDocumentInput]	Company documents information.
communications [CommunicationInput]	Company communication types.

CheckInput

Arguments

Name	Description
checkType CheckType	Filters checks by check type.
description String	Filters checks by description.

CommunicationInput

Arguments

Name	Description
id ID	A unique communication identifier.
priority Int	Level of priority.
communicationIdentifier String	Communication identifier.
phone String	Communication by phone number.
email String	Communication by e-mail.
website String	Communication input data is website URL.
websiteIp String	Communication input data is website IP address.
linkedIn String	Communication input data is LinkedIn account.
ipAddress String	Communication input data is IP address.

DocumentImageInput

Arguments

Name	Description
id ID	A unique document image identifier.
documentId ID	A unique document identifier.
imagePath String	Document image path.
imageBase64 String	An encoding algorithm that converts any characters, binary data, and even images or sound files into a readable string, which can be saved or transported over the network without data loss.
description String	Document image description.

DocumentInput

Arguments

Name	Description
id ID	A unique document identifier.
type DocumentType	Document type.
number String	Document number.
expiry DateTime	Document expiration date.
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 of issue of document.
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 [DocumentImageInput]	Document images.

PageRequestInput

Arguments

Name	Description
query String	A query that includes all query parameters for pagination, search, and filtering data.
sortBy String	Sorting collections by different columns - according to the sorting policy.
sortOrder String	Sorting collections by different orders, possible options are by ascending or descending order.
skip Int	How many elements of the collection to skip so they are not included on the results page?
take Int	How many elements of the collection should be included on the results page?
showDeleted Boolean	Deleted items of the collections will be included on the result page.
grouping StatsMetric	Grouping elements in collections by specific StatsMetric values.
startDate DateTime	The DateTime scalar represents an ISO-8601 compliant date time type - start date when page request is created.
endDate DateTime	The DateTime scalar represents an ISO-8601 compliant date time type - request's expiration date.
statsFrom DateTime	The DateTime scalar represents an ISO-8601 compliant date time type - start period for statistics.
statsTo DateTime	The DateTime scalar represents an ISO-8601 compliant date time type - end period for statistics.
sessionIds [ID]	Filters elements from collections by unique session identifiers.
referenceIds [String]	Filters elements from collections by unique reference identifiers.
companyCheckIds [ID]	Filters elements from collections by unique company check identifiers.
companyIds [ID]	Filters elements from collections by unique company identifiers.
configurationIds [ID]	Filters elements from collections by unique configurations identifiers.

PersonInput

Arguments

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	Person's ownership percentage.
dob DateTime	Date of Birth.
addresses [AddressInput]	Address information.
documents [DocumentInput]	Documents information.
communications [CommunicationInput]	Communication type information.

SessionInput

Arguments

Name	Description
id ID	A unique session identifier.
description String	Session description.
code String	Session code.
configurationId ID!	A unique configuration identifier.
referenceId String	A unique reference identifier.
referenceUserId String	A unique user identifier reference .
referenceCompanyId String	A unique company identifier reference.
responseTransport ResponseTransport	Type of response transport.
isTesting Boolean	The checkbox "Is Testing" is used for launching test sessions with test entity data.
webHook String	Response will be returned to specified Webhook.
businesses [BusinessInput]	Businesses information.
persons [PersonInput]	Persons sessions information.
checks [CheckInput]	Types of checks.