Red Flag Alert GraphQL Reference
Red Flag Alert GraphQL Reference
Playground
GraphiQL
API Endpoints
https://graphql.redflagalert.net/graphql/
Queries
idCheck
Example
Query
query idCheck($id: Int!) {
idCheck(id: $id) {
options {
...CheckOptionsFragment
}
id
detail {
...DigitalCheckDetailFragment
}
authenticationLink {
...AuthenticationLinkFragment
}
checkStartUrl
user {
...UserFragment
}
reference
bulkReference
isBulk
isMonitored
createdDate
result {
...CheckResultFragment
}
statuses {
...CheckStatusFragment
}
verificationTypes {
...VerificationFragment
}
checkType
notifications {
...CheckNotificationFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"idCheck": {
"options": CheckOptions,
"id": 987,
"detail": DigitalCheckDetail,
"authenticationLink": AuthenticationLink,
"checkStartUrl": "abc123",
"user": User,
"reference": "abc123",
"bulkReference": "xyz789",
"isBulk": true,
"isMonitored": true,
"createdDate": "2007-12-03T10:15:30Z",
"result": CheckResult,
"statuses": [CheckStatus],
"verificationTypes": [Verification],
"checkType": "KNOW_YOUR_CLIENT",
"notifications": [CheckNotification]
}
}
}
idChecks
Response
Returns a ChecksCollectionSegment
Arguments
Name | Description |
---|---|
skip - Int
|
Default = 0 |
take - Int
|
Default = 10 |
where - CheckFilterInput
|
|
order - [CheckSortInput!]
|
Default = [{id: DESC}] |
Example
Query
query idChecks(
$skip: Int,
$take: Int,
$where: CheckFilterInput,
$order: [CheckSortInput!]
) {
idChecks(
skip: $skip,
take: $take,
where: $where,
order: $order
) {
pageInfo {
...CollectionSegmentInfoFragment
}
items {
...CheckSearchTypeFragment
}
totalCount
}
}
Variables
{
"skip": 0,
"take": 10,
"where": CheckFilterInput,
"order": [{"id": "DESC"}]
}
Response
{
"data": {
"idChecks": {
"pageInfo": CollectionSegmentInfo,
"items": [CheckSearchType],
"totalCount": 987
}
}
}
Mutations
idCreateCheck
Response
Returns a Check
Arguments
Name | Description |
---|---|
checkRequest - CheckRequestInput
|
Example
Query
mutation idCreateCheck($checkRequest: CheckRequestInput) {
idCreateCheck(checkRequest: $checkRequest) {
options {
...CheckOptionsFragment
}
id
detail {
...DigitalCheckDetailFragment
}
authenticationLink {
...AuthenticationLinkFragment
}
checkStartUrl
user {
...UserFragment
}
reference
bulkReference
isBulk
isMonitored
createdDate
result {
...CheckResultFragment
}
statuses {
...CheckStatusFragment
}
verificationTypes {
...VerificationFragment
}
checkType
notifications {
...CheckNotificationFragment
}
}
}
Variables
{"checkRequest": CheckRequestInput}
Response
{
"data": {
"idCreateCheck": {
"options": CheckOptions,
"id": 123,
"detail": DigitalCheckDetail,
"authenticationLink": AuthenticationLink,
"checkStartUrl": "xyz789",
"user": User,
"reference": "xyz789",
"bulkReference": "abc123",
"isBulk": true,
"isMonitored": false,
"createdDate": "2007-12-03T10:15:30Z",
"result": CheckResult,
"statuses": [CheckStatus],
"verificationTypes": [Verification],
"checkType": "KNOW_YOUR_CLIENT",
"notifications": [CheckNotification]
}
}
}
signIn
Description
Get authentication token for user
Response
Returns a SignInResponse
Arguments
Name | Description |
---|---|
credentials - SignInCredentialsInput
|
|
useManagementflow - Boolean
|
Default = false |
Example
Query
mutation signIn(
$credentials: SignInCredentialsInput,
$useManagementflow: Boolean
) {
signIn(
credentials: $credentials,
useManagementflow: $useManagementflow
) {
accessToken
refreshToken
expiresInSeconds
}
}
Variables
{
"credentials": SignInCredentialsInput,
"useManagementflow": false
}
Response
{
"data": {
"signIn": {
"accessToken": "abc123",
"refreshToken": "abc123",
"expiresInSeconds": 123
}
}
}
signInRefresh
Description
Get authentication token from refresh token
Response
Returns a SignInResponse
Arguments
Name | Description |
---|---|
credentials - RefreshCredentialsInput
|
|
useManagementflow - Boolean
|
Default = false |
Example
Query
mutation signInRefresh(
$credentials: RefreshCredentialsInput,
$useManagementflow: Boolean
) {
signInRefresh(
credentials: $credentials,
useManagementflow: $useManagementflow
) {
accessToken
refreshToken
expiresInSeconds
}
}
Variables
{
"credentials": RefreshCredentialsInput,
"useManagementflow": false
}
Response
{
"data": {
"signInRefresh": {
"accessToken": "xyz789",
"refreshToken": "abc123",
"expiresInSeconds": 987
}
}
}
Types
Account
Description
Company account
Fields
Field Name | Description |
---|---|
id - String
|
Company account domain |
companyName - String
|
Company name |
redirectCompleteUrl - String
|
Company redirect return URL |
redirectStartUrl - String
|
Company redirect entry URL |
accountTypeId - AccountTypeId!
|
Account type |
webHooks - [WebHook]
|
Webhook Type |
users - [User]
|
Account type |
gbgConfiguration - GbGConfiguration
|
Gbg Configuration |
smsConfiguration - SmsConfiguration
|
Sms Configuration |
idKitConfiguration - IdKitConfiguration
|
Id Kit Configuration |
accountSummary - AccountSumary
|
Account summary information |
accountStatistics - [StatisticDetail]
|
No longer for use No longer supported |
checkHighlights - [CheckHighlight]
|
Check highlights for account |
Arguments
|
Example
{
"id": "xyz789",
"companyName": "abc123",
"redirectCompleteUrl": "xyz789",
"redirectStartUrl": "xyz789",
"accountTypeId": "RFA",
"webHooks": [WebHook],
"users": [User],
"gbgConfiguration": GbGConfiguration,
"smsConfiguration": SmsConfiguration,
"idKitConfiguration": IdKitConfiguration,
"accountSummary": AccountSumary,
"accountStatistics": [StatisticDetail],
"checkHighlights": [CheckHighlight]
}
AccountFilterInput
Fields
Input Field | Description |
---|---|
and - [AccountFilterInput!]
|
|
or - [AccountFilterInput!]
|
|
id - StringOperationFilterInput
|
|
companyName - StringOperationFilterInput
|
|
slug - StringOperationFilterInput
|
|
freeCheckLimit - IntOperationFilterInput
|
|
dailyCheckLimit - IntOperationFilterInput
|
|
activeUsers - ListFilterInputTypeOfUserFilterInput
|
|
users - ListFilterInputTypeOfUserFilterInput
|
|
userRoles - ListFilterInputTypeOfUserRoleFilterInput
|
|
checks - ListFilterInputTypeOfCheckFilterInput
|
|
webHooks - ListFilterInputTypeOfWebHookFilterInput
|
|
accountType - AccountTypeFilterInput
|
|
gbgConfiguration - GbGConfigurationFilterInput
|
|
idKitConfiguration - IdKitConfigurationFilterInput
|
|
smsConfiguration - SmsConfigurationFilterInput
|
|
emailConfiguration - EmailConfigurationFilterInput
|
|
redirectStartUrl - StringOperationFilterInput
|
|
redirectCompleteUrl - StringOperationFilterInput
|
|
accountTypeId - AccountTypeIdOperationFilterInput
|
Example
{
"and": [AccountFilterInput],
"or": [AccountFilterInput],
"id": StringOperationFilterInput,
"companyName": StringOperationFilterInput,
"slug": StringOperationFilterInput,
"freeCheckLimit": IntOperationFilterInput,
"dailyCheckLimit": IntOperationFilterInput,
"activeUsers": ListFilterInputTypeOfUserFilterInput,
"users": ListFilterInputTypeOfUserFilterInput,
"userRoles": ListFilterInputTypeOfUserRoleFilterInput,
"checks": ListFilterInputTypeOfCheckFilterInput,
"webHooks": ListFilterInputTypeOfWebHookFilterInput,
"accountType": AccountTypeFilterInput,
"gbgConfiguration": GbGConfigurationFilterInput,
"idKitConfiguration": IdKitConfigurationFilterInput,
"smsConfiguration": SmsConfigurationFilterInput,
"emailConfiguration": EmailConfigurationFilterInput,
"redirectStartUrl": StringOperationFilterInput,
"redirectCompleteUrl": StringOperationFilterInput,
"accountTypeId": AccountTypeIdOperationFilterInput
}
AccountSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
companyName - SortEnumType
|
|
slug - SortEnumType
|
|
freeCheckLimit - SortEnumType
|
|
dailyCheckLimit - SortEnumType
|
|
accountType - AccountTypeSortInput
|
|
gbgConfiguration - GbGConfigurationSortInput
|
|
idKitConfiguration - IdKitConfigurationSortInput
|
|
smsConfiguration - SmsConfigurationSortInput
|
|
emailConfiguration - EmailConfigurationSortInput
|
|
redirectStartUrl - SortEnumType
|
|
redirectCompleteUrl - SortEnumType
|
|
accountTypeId - SortEnumType
|
Example
{
"id": "ASC",
"companyName": "ASC",
"slug": "ASC",
"freeCheckLimit": "ASC",
"dailyCheckLimit": "ASC",
"accountType": AccountTypeSortInput,
"gbgConfiguration": GbGConfigurationSortInput,
"idKitConfiguration": IdKitConfigurationSortInput,
"smsConfiguration": SmsConfigurationSortInput,
"emailConfiguration": EmailConfigurationSortInput,
"redirectStartUrl": "ASC",
"redirectCompleteUrl": "ASC",
"accountTypeId": "ASC"
}
AccountSumary
Description
Account summary.
Fields
Field Name | Description |
---|---|
freeCheckLimit - Int!
|
Free checks allowed. |
totalChecks - Int!
|
Total number of checks performed on account. |
isCustomer - Boolean!
|
Custsomer has payment account configured. |
isSubscriber - Boolean!
|
Customer has active subscription. |
canCreateChecks - Boolean!
|
Can the account create new checks. |
totalChecksLastDay - Int!
|
Number of checks in the last day. |
Example
{
"freeCheckLimit": 123,
"totalChecks": 123,
"isCustomer": false,
"isSubscriber": false,
"canCreateChecks": true,
"totalChecksLastDay": 123
}
AccountTypeFilterInput
Fields
Input Field | Description |
---|---|
and - [AccountTypeFilterInput!]
|
|
or - [AccountTypeFilterInput!]
|
|
accountTypeId - AccountTypeIdOperationFilterInput
|
|
accountTypeName - StringOperationFilterInput
|
|
accounts - ListFilterInputTypeOfAccountFilterInput
|
|
accountTypeWebHooks - ListFilterInputTypeOfAccountTypeWebHookFilterInput
|
Example
{
"and": [AccountTypeFilterInput],
"or": [AccountTypeFilterInput],
"accountTypeId": AccountTypeIdOperationFilterInput,
"accountTypeName": StringOperationFilterInput,
"accounts": ListFilterInputTypeOfAccountFilterInput,
"accountTypeWebHooks": ListFilterInputTypeOfAccountTypeWebHookFilterInput
}
AccountTypeId
Values
Enum Value | Description |
---|---|
|
|
|
Example
"RFA"
AccountTypeIdOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AccountTypeId
|
|
neq - AccountTypeId
|
|
in - [AccountTypeId!]
|
|
nin - [AccountTypeId!]
|
Example
{"eq": "RFA", "neq": "RFA", "in": ["RFA"], "nin": ["RFA"]}
AccountTypeSortInput
Fields
Input Field | Description |
---|---|
accountTypeId - SortEnumType
|
|
accountTypeName - SortEnumType
|
Example
{"accountTypeId": "ASC", "accountTypeName": "ASC"}
AccountTypeWebHookFilterInput
Fields
Input Field | Description |
---|---|
and - [AccountTypeWebHookFilterInput!]
|
|
or - [AccountTypeWebHookFilterInput!]
|
|
id - IntOperationFilterInput
|
|
accountTypeId - AccountTypeIdOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
accountType - AccountTypeFilterInput
|
Example
{
"and": [AccountTypeWebHookFilterInput],
"or": [AccountTypeWebHookFilterInput],
"id": IntOperationFilterInput,
"accountTypeId": AccountTypeIdOperationFilterInput,
"url": StringOperationFilterInput,
"accountType": AccountTypeFilterInput
}
Address
Fields
Field Name | Description |
---|---|
address_line_1 - String
|
|
address_line_2 - String
|
|
address_line_3 - String
|
|
address_line_4 - String
|
|
town - String
|
|
county - String
|
|
country - String
|
|
country_code - CountryCode
|
|
postcode - String
|
|
type - String
|
|
location - Location
|
|
postcode_area - String
|
|
postcode_district - String
|
|
original_county - String
|
|
district - String
|
|
os_easting - Int!
|
|
os_northing - Int!
|
|
la_ua_gsscode - String
|
|
la_ua_name - String
|
|
region - String
|
|
lep_name - String
|
|
combined_authority_name - String
|
Example
{
"address_line_1": "xyz789",
"address_line_2": "xyz789",
"address_line_3": "abc123",
"address_line_4": "abc123",
"town": "abc123",
"county": "xyz789",
"country": "abc123",
"country_code": "AFG",
"postcode": "abc123",
"type": "xyz789",
"location": Location,
"postcode_area": "xyz789",
"postcode_district": "xyz789",
"original_county": "xyz789",
"district": "abc123",
"os_easting": 987,
"os_northing": 123,
"la_ua_gsscode": "abc123",
"la_ua_name": "abc123",
"region": "abc123",
"lep_name": "xyz789",
"combined_authority_name": "abc123"
}
AddressFilterInput
Fields
Input Field | Description |
---|---|
and - [AddressFilterInput!]
|
|
or - [AddressFilterInput!]
|
|
address_line_1 - StringOperationFilterInput
|
|
address_line_2 - StringOperationFilterInput
|
|
address_line_3 - StringOperationFilterInput
|
|
address_line_4 - StringOperationFilterInput
|
|
town - StringOperationFilterInput
|
|
county - StringOperationFilterInput
|
|
country - StringOperationFilterInput
|
|
country_code - NullableOfCountryCodeOperationFilterInput
|
|
postcode - StringOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
location - LocationFilterInput
|
|
postcode_area - StringOperationFilterInput
|
|
postcode_district - StringOperationFilterInput
|
|
original_county - StringOperationFilterInput
|
|
district - StringOperationFilterInput
|
|
os_easting - IntOperationFilterInput
|
|
os_northing - IntOperationFilterInput
|
|
la_ua_gsscode - StringOperationFilterInput
|
|
la_ua_name - StringOperationFilterInput
|
|
region - StringOperationFilterInput
|
|
lep_name - StringOperationFilterInput
|
|
combined_authority_name - StringOperationFilterInput
|
Example
{
"and": [AddressFilterInput],
"or": [AddressFilterInput],
"address_line_1": StringOperationFilterInput,
"address_line_2": StringOperationFilterInput,
"address_line_3": StringOperationFilterInput,
"address_line_4": StringOperationFilterInput,
"town": StringOperationFilterInput,
"county": StringOperationFilterInput,
"country": StringOperationFilterInput,
"country_code": NullableOfCountryCodeOperationFilterInput,
"postcode": StringOperationFilterInput,
"type": StringOperationFilterInput,
"location": LocationFilterInput,
"postcode_area": StringOperationFilterInput,
"postcode_district": StringOperationFilterInput,
"original_county": StringOperationFilterInput,
"district": StringOperationFilterInput,
"os_easting": IntOperationFilterInput,
"os_northing": IntOperationFilterInput,
"la_ua_gsscode": StringOperationFilterInput,
"la_ua_name": StringOperationFilterInput,
"region": StringOperationFilterInput,
"lep_name": StringOperationFilterInput,
"combined_authority_name": StringOperationFilterInput
}
AddressVerificationCheckType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"INTERNATIONAL_PASSPORT"
AddressVerificationCheckTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AddressVerificationCheckType
|
|
neq - AddressVerificationCheckType
|
|
in - [AddressVerificationCheckType!]
|
|
nin - [AddressVerificationCheckType!]
|
Example
{
"eq": "INTERNATIONAL_PASSPORT",
"neq": "INTERNATIONAL_PASSPORT",
"in": ["INTERNATIONAL_PASSPORT"],
"nin": ["INTERNATIONAL_PASSPORT"]
}
AddressVerificationDecision
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"NA"
AddressVerificationDecisionOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AddressVerificationDecision
|
|
neq - AddressVerificationDecision
|
|
in - [AddressVerificationDecision!]
|
|
nin - [AddressVerificationDecision!]
|
Example
{"eq": "NA", "neq": "NA", "in": ["NA"], "nin": ["NA"]}
AddressVerificationDetail
Description
Address Verification Detail
Fields
Field Name | Description |
---|---|
id - Int!
|
Address verification detail Id |
checkType - AddressVerificationCheckType!
|
Type of check performed |
resultType - AddressVerificationResultType!
|
Result type |
description - String
|
Description of address verification detail |
Example
{
"id": 987,
"checkType": "INTERNATIONAL_PASSPORT",
"resultType": "MATCH",
"description": "xyz789"
}
AddressVerificationDetailFilterInput
Fields
Input Field | Description |
---|---|
and - [AddressVerificationDetailFilterInput!]
|
|
or - [AddressVerificationDetailFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
resultType - AddressVerificationResultTypeOperationFilterInput
|
|
checkType - AddressVerificationCheckTypeOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
result - AddressVerificationResultFilterInput
|
Example
{
"and": [AddressVerificationDetailFilterInput],
"or": [AddressVerificationDetailFilterInput],
"id": IntOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"resultType": AddressVerificationResultTypeOperationFilterInput,
"checkType": AddressVerificationCheckTypeOperationFilterInput,
"description": StringOperationFilterInput,
"result": AddressVerificationResultFilterInput
}
AddressVerificationItem
Description
Address Verification Item
Fields
Field Name | Description |
---|---|
id - Int!
|
Address verification item Id |
itemSource - AddressVerificationCheckType!
|
Source of check |
itemType - AddressVerificationMatchType!
|
Type of match |
itemResult - AddressVerificationMatchResult!
|
Result of match |
Example
{
"id": 987,
"itemSource": "INTERNATIONAL_PASSPORT",
"itemType": "OVERALL",
"itemResult": "NA"
}
AddressVerificationItemFilterInput
Fields
Input Field | Description |
---|---|
and - [AddressVerificationItemFilterInput!]
|
|
or - [AddressVerificationItemFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
itemSource - AddressVerificationCheckTypeOperationFilterInput
|
|
itemResult - AddressVerificationMatchResultOperationFilterInput
|
|
itemType - AddressVerificationMatchTypeOperationFilterInput
|
|
result - AddressVerificationResultFilterInput
|
Example
{
"and": [AddressVerificationItemFilterInput],
"or": [AddressVerificationItemFilterInput],
"id": IntOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"itemSource": AddressVerificationCheckTypeOperationFilterInput,
"itemResult": AddressVerificationMatchResultOperationFilterInput,
"itemType": AddressVerificationMatchTypeOperationFilterInput,
"result": AddressVerificationResultFilterInput
}
AddressVerificationMatchResult
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"NA"
AddressVerificationMatchResultOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AddressVerificationMatchResult
|
|
neq - AddressVerificationMatchResult
|
|
in - [AddressVerificationMatchResult!]
|
|
nin - [AddressVerificationMatchResult!]
|
Example
{"eq": "NA", "neq": "NA", "in": ["NA"], "nin": ["NA"]}
AddressVerificationMatchType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"OVERALL"
AddressVerificationMatchTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AddressVerificationMatchType
|
|
neq - AddressVerificationMatchType
|
|
in - [AddressVerificationMatchType!]
|
|
nin - [AddressVerificationMatchType!]
|
Example
{"eq": "OVERALL", "neq": "OVERALL", "in": ["OVERALL"], "nin": ["OVERALL"]}
AddressVerificationResult
Description
Address verification result information
Fields
Field Name | Description |
---|---|
checkResultId - Int!
|
Check result id |
id - String
|
Address verification result Id |
decision - AddressVerificationDecision!
|
Address verification decision |
details - [AddressVerificationDetail]
|
Details of result |
items - [AddressVerificationItem]
|
Source items |
Example
{
"checkResultId": 987,
"id": "abc123",
"decision": "NA",
"details": [AddressVerificationDetail],
"items": [AddressVerificationItem]
}
AddressVerificationResultFilterInput
Fields
Input Field | Description |
---|---|
and - [AddressVerificationResultFilterInput!]
|
|
or - [AddressVerificationResultFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
rawResponse - StringOperationFilterInput
|
|
decision - AddressVerificationDecisionOperationFilterInput
|
|
details - ListFilterInputTypeOfAddressVerificationDetailFilterInput
|
|
items - ListFilterInputTypeOfAddressVerificationItemFilterInput
|
Example
{
"and": [AddressVerificationResultFilterInput],
"or": [AddressVerificationResultFilterInput],
"id": IntOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"rawResponse": StringOperationFilterInput,
"decision": AddressVerificationDecisionOperationFilterInput,
"details": ListFilterInputTypeOfAddressVerificationDetailFilterInput,
"items": ListFilterInputTypeOfAddressVerificationItemFilterInput
}
AddressVerificationResultSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
checkResultId - SortEnumType
|
|
createdDate - SortEnumType
|
|
rawResponse - SortEnumType
|
|
decision - SortEnumType
|
Example
{
"id": "ASC",
"checkResultId": "ASC",
"createdDate": "ASC",
"rawResponse": "ASC",
"decision": "ASC"
}
AddressVerificationResultType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"MATCH"
AddressVerificationResultTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AddressVerificationResultType
|
|
neq - AddressVerificationResultType
|
|
in - [AddressVerificationResultType!]
|
|
nin - [AddressVerificationResultType!]
|
Example
{"eq": "MATCH", "neq": "MATCH", "in": ["MATCH"], "nin": ["MATCH"]}
AmlAddress
AmlAddressFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlAddressFilterInput!]
|
|
or - [AmlAddressFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
fullAddress - StringOperationFilterInput
|
|
country - StringOperationFilterInput
|
|
amlMatch - AmlMatchFilterInput
|
Example
{
"and": [AmlAddressFilterInput],
"or": [AmlAddressFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"fullAddress": StringOperationFilterInput,
"country": StringOperationFilterInput,
"amlMatch": AmlMatchFilterInput
}
AmlEntity
Description
AML Matched Entity
Fields
Field Name | Description |
---|---|
matchId - Int!
|
AML Match Unique ID |
id - String
|
Identification document Id |
name - String
|
AML Entity Name |
type - AmlEntityType!
|
AML Entity Type |
types - [AmlType!]
|
AML Entity Types |
sources - [AmlSourceNote]
|
AML Entity Types Use sources on AmlMatchType |
aka - [String]
|
AML Entity also known as |
associates - [AmlEntityAssociate]
|
AML Entity Associates |
assets - [AmlEntityAsset]
|
AML Entity Associates |
Example
{
"matchId": 987,
"id": "abc123",
"name": "xyz789",
"type": "PERSON",
"types": ["SANCTION"],
"sources": [AmlSourceNote],
"aka": ["abc123"],
"associates": [AmlEntityAssociate],
"assets": [AmlEntityAsset]
}
AmlEntityAsset
AmlEntityAssetFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlEntityAssetFilterInput!]
|
|
or - [AmlEntityAssetFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
source - StringOperationFilterInput
|
|
entity - AmlEntityFilterInput
|
Example
{
"and": [AmlEntityAssetFilterInput],
"or": [AmlEntityAssetFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"url": StringOperationFilterInput,
"type": StringOperationFilterInput,
"source": StringOperationFilterInput,
"entity": AmlEntityFilterInput
}
AmlEntityAssociate
Description
AML Entity Associate
Example
{
"id": 987,
"name": "xyz789",
"type": "abc123",
"comment": "xyz789"
}
AmlEntityAssociateFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlEntityAssociateFilterInput!]
|
|
or - [AmlEntityAssociateFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
comment - StringOperationFilterInput
|
|
entity - AmlEntityFilterInput
|
Example
{
"and": [AmlEntityAssociateFilterInput],
"or": [AmlEntityAssociateFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"name": StringOperationFilterInput,
"type": StringOperationFilterInput,
"comment": StringOperationFilterInput,
"entity": AmlEntityFilterInput
}
AmlEntityFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlEntityFilterInput!]
|
|
or - [AmlEntityFilterInput!]
|
|
matchId - IntOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
type - AmlEntityTypeOperationFilterInput
|
|
match - AmlMatchFilterInput
|
|
types - ListAmlTypeOperationFilterInput
|
|
aka - ListStringOperationFilterInput
|
|
associates - ListFilterInputTypeOfAmlEntityAssociateFilterInput
|
|
assets - ListFilterInputTypeOfAmlEntityAssetFilterInput
|
Example
{
"and": [AmlEntityFilterInput],
"or": [AmlEntityFilterInput],
"matchId": IntOperationFilterInput,
"name": StringOperationFilterInput,
"type": AmlEntityTypeOperationFilterInput,
"match": AmlMatchFilterInput,
"types": ListAmlTypeOperationFilterInput,
"aka": ListStringOperationFilterInput,
"associates": ListFilterInputTypeOfAmlEntityAssociateFilterInput,
"assets": ListFilterInputTypeOfAmlEntityAssetFilterInput
}
AmlEntityMedia
Description
AML Media
Example
{
"id": 987,
"dateTime": "2007-12-03T10:15:30Z",
"title": "xyz789",
"snippet": "abc123",
"url": "xyz789"
}
AmlEntityMediaFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlEntityMediaFilterInput!]
|
|
or - [AmlEntityMediaFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
dateTime - portfolio_DateTimeOperationFilterInput
|
|
title - StringOperationFilterInput
|
|
snippet - StringOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
match - AmlMatchFilterInput
|
Example
{
"and": [AmlEntityMediaFilterInput],
"or": [AmlEntityMediaFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"dateTime": portfolio_DateTimeOperationFilterInput,
"title": StringOperationFilterInput,
"snippet": StringOperationFilterInput,
"url": StringOperationFilterInput,
"match": AmlMatchFilterInput
}
AmlEntityType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PERSON"
AmlEntityTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AmlEntityType
|
|
neq - AmlEntityType
|
|
in - [AmlEntityType!]
|
|
nin - [AmlEntityType!]
|
Example
{"eq": "PERSON", "neq": "PERSON", "in": ["PERSON"], "nin": ["PERSON"]}
AmlMatch
Description
AML match
Fields
Field Name | Description |
---|---|
id - Int!
|
AML Match Id |
entity - AmlEntity
|
Match entity |
matchTypes - [AmlMatchType!]
|
AML Match Types |
sources - [AmlSourceNote]
|
AML match sources |
matchTypeDetails - [AmlMatchTypeDetail]
|
Match identification |
addresses - [AmlAddress]
|
Match identification |
positions - [AmlPosition]
|
Match identification |
media - [AmlEntityMedia]
|
AML Entity Associates |
Example
{
"id": 987,
"entity": AmlEntity,
"matchTypes": ["UNKNOWN"],
"sources": [AmlSourceNote],
"matchTypeDetails": [AmlMatchTypeDetail],
"addresses": [AmlAddress],
"positions": [AmlPosition],
"media": [AmlEntityMedia]
}
AmlMatchFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlMatchFilterInput!]
|
|
or - [AmlMatchFilterInput!]
|
|
id - IntOperationFilterInput
|
|
amlResultId - IntOperationFilterInput
|
|
entity - AmlEntityFilterInput
|
|
result - AmlResultFilterInput
|
|
matchTypes - ListAmlMatchTypeOperationFilterInput
|
|
matchTypeDetails - ListFilterInputTypeOfAmlMatchTypeDetailFilterInput
|
|
sources - ListFilterInputTypeOfAmlSourceNoteFilterInput
|
|
addresses - ListFilterInputTypeOfAmlAddressFilterInput
|
|
positions - ListFilterInputTypeOfAmlPositionFilterInput
|
|
media - ListFilterInputTypeOfAmlEntityMediaFilterInput
|
Example
{
"and": [AmlMatchFilterInput],
"or": [AmlMatchFilterInput],
"id": IntOperationFilterInput,
"amlResultId": IntOperationFilterInput,
"entity": AmlEntityFilterInput,
"result": AmlResultFilterInput,
"matchTypes": ListAmlMatchTypeOperationFilterInput,
"matchTypeDetails": ListFilterInputTypeOfAmlMatchTypeDetailFilterInput,
"sources": ListFilterInputTypeOfAmlSourceNoteFilterInput,
"addresses": ListFilterInputTypeOfAmlAddressFilterInput,
"positions": ListFilterInputTypeOfAmlPositionFilterInput,
"media": ListFilterInputTypeOfAmlEntityMediaFilterInput
}
AmlMatchType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
AmlMatchTypeDetail
Description
AML match type detail
Fields
Field Name | Description |
---|---|
id - Int!
|
AML Match Type Detail Id |
detail - String
|
AML Match Type Description |
field - String
|
AML Field Matched |
type - String
|
AML Match Type |
matchTypes - [AmlMatchType!]
|
AML Match Types |
Example
{
"id": 987,
"detail": "abc123",
"field": "abc123",
"type": "abc123",
"matchTypes": ["UNKNOWN"]
}
AmlMatchTypeDetailFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlMatchTypeDetailFilterInput!]
|
|
or - [AmlMatchTypeDetailFilterInput!]
|
|
id - IntOperationFilterInput
|
|
amlMatchId - IntOperationFilterInput
|
|
amlMatch - AmlMatchFilterInput
|
|
matchTypes - ListAmlMatchTypeOperationFilterInput
|
|
field - StringOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
detail - StringOperationFilterInput
|
Example
{
"and": [AmlMatchTypeDetailFilterInput],
"or": [AmlMatchTypeDetailFilterInput],
"id": IntOperationFilterInput,
"amlMatchId": IntOperationFilterInput,
"amlMatch": AmlMatchFilterInput,
"matchTypes": ListAmlMatchTypeOperationFilterInput,
"field": StringOperationFilterInput,
"type": StringOperationFilterInput,
"detail": StringOperationFilterInput
}
AmlMatchTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AmlMatchType
|
|
neq - AmlMatchType
|
|
in - [AmlMatchType!]
|
|
nin - [AmlMatchType!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
AmlPosition
AmlPositionFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlPositionFilterInput!]
|
|
or - [AmlPositionFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
country - StringOperationFilterInput
|
|
position - StringOperationFilterInput
|
|
amlMatch - AmlMatchFilterInput
|
Example
{
"and": [AmlPositionFilterInput],
"or": [AmlPositionFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"country": StringOperationFilterInput,
"position": StringOperationFilterInput,
"amlMatch": AmlMatchFilterInput
}
AmlResult
Description
AML result information
Fields
Field Name | Description |
---|---|
checkResultId - Int!
|
Check result id |
id - Int!
|
Unique Aml Result Id |
createdDate - DateTime!
|
Created Date |
status - AmlStatus!
|
AML Status |
riskLevel - AmlRiskLevel!
|
AML Risk Level |
identificationProvider - IdentificationProvider
|
Provider of identification URL |
matches - [AmlMatch]
|
AML match |
Example
{
"checkResultId": 123,
"id": 123,
"createdDate": "2007-12-03T10:15:30Z",
"status": "UNKNOWN",
"riskLevel": "UNKNOWN",
"identificationProvider": IdentificationProvider,
"matches": [AmlMatch]
}
AmlResultFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlResultFilterInput!]
|
|
or - [AmlResultFilterInput!]
|
|
id - IntOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
status - AmlStatusOperationFilterInput
|
|
riskLevel - AmlRiskLevelOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
checkResult - CheckResultFilterInput
|
|
matches - ListFilterInputTypeOfAmlMatchFilterInput
|
|
result - CheckResultTypeOperationFilterInput
|
|
verificationProviderId - IdentificationProviderIdOperationFilterInput
|
|
identificationProvider - IdentificationProviderFilterInput
|
Example
{
"and": [AmlResultFilterInput],
"or": [AmlResultFilterInput],
"id": IntOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"status": AmlStatusOperationFilterInput,
"riskLevel": AmlRiskLevelOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"checkResult": CheckResultFilterInput,
"matches": ListFilterInputTypeOfAmlMatchFilterInput,
"result": CheckResultTypeOperationFilterInput,
"verificationProviderId": IdentificationProviderIdOperationFilterInput,
"identificationProvider": IdentificationProviderFilterInput
}
AmlResultSearchType
Fields
Field Name | Description |
---|---|
id - Int!
|
Id |
status - AmlStatus!
|
AML Status |
riskLevel - AmlRiskLevel!
|
AML Risk Level |
createdDate - DateTime!
|
Created date of result |
identificationProvider - IdentificationProvider
|
Provider of verification |
Example
{
"id": 123,
"status": "UNKNOWN",
"riskLevel": "UNKNOWN",
"createdDate": "2007-12-03T10:15:30Z",
"identificationProvider": IdentificationProvider
}
AmlResultSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
createdDate - SortEnumType
|
|
status - SortEnumType
|
|
riskLevel - SortEnumType
|
|
checkResultId - SortEnumType
|
|
checkResult - CheckResultSortInput
|
|
result - SortEnumType
|
|
verificationProviderId - SortEnumType
|
|
identificationProvider - IdentificationProviderSortInput
|
Example
{
"id": "ASC",
"createdDate": "ASC",
"status": "ASC",
"riskLevel": "ASC",
"checkResultId": "ASC",
"checkResult": CheckResultSortInput,
"result": "ASC",
"verificationProviderId": "ASC",
"identificationProvider": IdentificationProviderSortInput
}
AmlRiskLevel
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"UNKNOWN"
AmlRiskLevelOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AmlRiskLevel
|
|
neq - AmlRiskLevel
|
|
in - [AmlRiskLevel!]
|
|
nin - [AmlRiskLevel!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
AmlSourceNote
Description
AML source note
Fields
Field Name | Description |
---|---|
id - Int!
|
AML source note Id |
name - String
|
AML source name |
description - String
|
AML source description |
source - String
|
AML source |
listingStartedAt - DateTime
|
AML source started at |
listingEndedAt - DateTime
|
AML source listing ended at |
url - String
|
AML source URL |
types - [AmlType!]
|
AML types |
Example
{
"id": 987,
"name": "abc123",
"description": "abc123",
"source": "abc123",
"listingStartedAt": "2007-12-03T10:15:30Z",
"listingEndedAt": "2007-12-03T10:15:30Z",
"url": "abc123",
"types": ["SANCTION"]
}
AmlSourceNoteFilterInput
Fields
Input Field | Description |
---|---|
and - [AmlSourceNoteFilterInput!]
|
|
or - [AmlSourceNoteFilterInput!]
|
|
id - IntOperationFilterInput
|
|
matchId - IntOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
source - StringOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
listingStartedAt - portfolio_DateTimeOperationFilterInput
|
|
listingEndedAt - portfolio_DateTimeOperationFilterInput
|
|
types - ListAmlTypeOperationFilterInput
|
|
match - AmlMatchFilterInput
|
Example
{
"and": [AmlSourceNoteFilterInput],
"or": [AmlSourceNoteFilterInput],
"id": IntOperationFilterInput,
"matchId": IntOperationFilterInput,
"name": StringOperationFilterInput,
"description": StringOperationFilterInput,
"source": StringOperationFilterInput,
"url": StringOperationFilterInput,
"listingStartedAt": portfolio_DateTimeOperationFilterInput,
"listingEndedAt": portfolio_DateTimeOperationFilterInput,
"types": ListAmlTypeOperationFilterInput,
"match": AmlMatchFilterInput
}
AmlStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
AmlStatusOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AmlStatus
|
|
neq - AmlStatus
|
|
in - [AmlStatus!]
|
|
nin - [AmlStatus!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
AmlType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SANCTION"
AmlTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AmlType
|
|
neq - AmlType
|
|
in - [AmlType!]
|
|
nin - [AmlType!]
|
Example
{"eq": "SANCTION", "neq": "SANCTION", "in": ["SANCTION"], "nin": ["SANCTION"]}
ApiRequestFilterInput
Fields
Input Field | Description |
---|---|
and - [ApiRequestFilterInput!]
|
|
or - [ApiRequestFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkId - IntOperationFilterInput
|
|
rawResponse - StringOperationFilterInput
|
|
rawRequest - StringOperationFilterInput
|
|
check - CheckFilterInput
|
Example
{
"and": [ApiRequestFilterInput],
"or": [ApiRequestFilterInput],
"id": IntOperationFilterInput,
"checkId": IntOperationFilterInput,
"rawResponse": StringOperationFilterInput,
"rawRequest": StringOperationFilterInput,
"check": CheckFilterInput
}
AppointmentType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CURRENT_SECRETARY"
AppointmentTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - AppointmentType
|
|
neq - AppointmentType
|
|
in - [AppointmentType!]
|
|
nin - [AppointmentType!]
|
Example
{
"eq": "CURRENT_SECRETARY",
"neq": "CURRENT_SECRETARY",
"in": ["CURRENT_SECRETARY"],
"nin": ["CURRENT_SECRETARY"]
}
AuditorFilterInput
Fields
Input Field | Description |
---|---|
and - [AuditorFilterInput!]
|
|
or - [AuditorFilterInput!]
|
|
id - StringOperationFilterInput
|
|
name - StringOperationFilterInput
|
Example
{
"and": [AuditorFilterInput],
"or": [AuditorFilterInput],
"id": StringOperationFilterInput,
"name": StringOperationFilterInput
}
AuthenticationLink
Description
Authentication Link
Fields
Field Name | Description |
---|---|
authenticationUrl - String
|
Authentication URL |
Example
{"authenticationUrl": "abc123"}
AuthenticationLinkFilterInput
Fields
Input Field | Description |
---|---|
and - [AuthenticationLinkFilterInput!]
|
|
or - [AuthenticationLinkFilterInput!]
|
|
checkId - IntOperationFilterInput
|
|
authenticationUrl - StringOperationFilterInput
|
|
check - CheckFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
Example
{
"and": [AuthenticationLinkFilterInput],
"or": [AuthenticationLinkFilterInput],
"checkId": IntOperationFilterInput,
"authenticationUrl": StringOperationFilterInput,
"check": CheckFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput
}
AuthenticationLinkSortInput
Fields
Input Field | Description |
---|---|
checkId - SortEnumType
|
|
authenticationUrl - SortEnumType
|
|
check - CheckSortInput
|
|
createdDate - SortEnumType
|
Example
{
"checkId": "ASC",
"authenticationUrl": "ASC",
"check": CheckSortInput,
"createdDate": "ASC"
}
Balance_Sheet
Fields
Field Name | Description |
---|---|
balance_sheet_id - Long!
|
|
companies_company_id - Long
|
|
auditor_comments - String
|
|
account_date - DateTime
|
|
no_weeks - Long
|
|
currency - String
|
|
tangible_fixed_assets - Long
|
|
intangible_assets - Long
|
|
total_fixed_assets - Long
|
|
stocks - Long
|
|
trade_debtors - Long
|
|
trade_creditors - Float
|
|
cash - Long
|
|
misc_current_assets - Long
|
|
total_current_assets - Long
|
|
creditors_amounts_falling - Long
|
|
total_assets_less_liabilities - Long
|
|
total_long_term_liabilities - Long
|
|
total_liabilities - Long
|
|
share_capital_reserve - Long
|
|
pl_account_reserve - Long
|
|
revaluation_reserve - Long
|
|
shareholders_funds - Long
|
|
working_capital - Long
|
|
net_worth - Long
|
|
total_assets - Long
|
|
contingent_liabilities - Long
|
Example
{
"balance_sheet_id": {},
"companies_company_id": {},
"auditor_comments": "abc123",
"account_date": "2007-12-03T10:15:30Z",
"no_weeks": {},
"currency": "xyz789",
"tangible_fixed_assets": {},
"intangible_assets": {},
"total_fixed_assets": {},
"stocks": {},
"trade_debtors": {},
"trade_creditors": 987.65,
"cash": {},
"misc_current_assets": {},
"total_current_assets": {},
"creditors_amounts_falling": {},
"total_assets_less_liabilities": {},
"total_long_term_liabilities": {},
"total_liabilities": {},
"share_capital_reserve": {},
"pl_account_reserve": {},
"revaluation_reserve": {},
"shareholders_funds": {},
"working_capital": {},
"net_worth": {},
"total_assets": {},
"contingent_liabilities": {}
}
Balance_SheetFilterInput
Fields
Example
{
"and": [Balance_SheetFilterInput],
"or": [Balance_SheetFilterInput],
"balance_sheet_id": LongOperationFilterInput,
"companies_company_id": LongOperationFilterInput,
"auditor_comments": StringOperationFilterInput,
"account_date": DateTimeOperationFilterInput,
"no_weeks": LongOperationFilterInput,
"currency": StringOperationFilterInput,
"tangible_fixed_assets": LongOperationFilterInput,
"intangible_assets": LongOperationFilterInput,
"total_fixed_assets": LongOperationFilterInput,
"stocks": LongOperationFilterInput,
"trade_debtors": LongOperationFilterInput,
"trade_creditors": FloatOperationFilterInput,
"cash": LongOperationFilterInput,
"misc_current_assets": LongOperationFilterInput,
"total_current_assets": LongOperationFilterInput,
"creditors_amounts_falling": LongOperationFilterInput,
"total_assets_less_liabilities": LongOperationFilterInput,
"total_long_term_liabilities": LongOperationFilterInput,
"total_liabilities": LongOperationFilterInput,
"share_capital_reserve": LongOperationFilterInput,
"pl_account_reserve": LongOperationFilterInput,
"revaluation_reserve": LongOperationFilterInput,
"shareholders_funds": LongOperationFilterInput,
"working_capital": LongOperationFilterInput,
"net_worth": LongOperationFilterInput,
"total_assets": LongOperationFilterInput,
"contingent_liabilities": LongOperationFilterInput
}
BeneficialOwner
Example
{
"id": "abc123",
"name": "xyz789",
"type": "BUSINESS",
"seperation": 123,
"ownershipPercent": 987.65,
"isBeneficiary": true,
"parentId": "abc123"
}
BeneficialOwnerFilterInput
Fields
Input Field | Description |
---|---|
and - [BeneficialOwnerFilterInput!]
|
|
or - [BeneficialOwnerFilterInput!]
|
|
id - StringOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
type - CompanyBeneficiaryTypeOperationFilterInput
|
|
seperation - IntOperationFilterInput
|
|
ownershipPercent - FloatOperationFilterInput
|
|
isBeneficiary - BooleanOperationFilterInput
|
|
parentId - StringOperationFilterInput
|
Example
{
"and": [BeneficialOwnerFilterInput],
"or": [BeneficialOwnerFilterInput],
"id": StringOperationFilterInput,
"name": StringOperationFilterInput,
"type": CompanyBeneficiaryTypeOperationFilterInput,
"seperation": IntOperationFilterInput,
"ownershipPercent": FloatOperationFilterInput,
"isBeneficiary": BooleanOperationFilterInput,
"parentId": StringOperationFilterInput
}
BeneficialOwnerGraphFilterInput
Fields
Input Field | Description |
---|---|
and - [BeneficialOwnerGraphFilterInput!]
|
|
or - [BeneficialOwnerGraphFilterInput!]
|
|
id - StringOperationFilterInput
|
|
beneficiaries - ListFilterInputTypeOfCompanyBeneficiaryFilterInput
|
|
relationships - ListFilterInputTypeOfCompanyBeneficiaryRelationshipFilterInput
|
Example
{
"and": [BeneficialOwnerGraphFilterInput],
"or": [BeneficialOwnerGraphFilterInput],
"id": StringOperationFilterInput,
"beneficiaries": ListFilterInputTypeOfCompanyBeneficiaryFilterInput,
"relationships": ListFilterInputTypeOfCompanyBeneficiaryRelationshipFilterInput
}
BiometricCheckResultType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"CONSIDER"
BiometricCheckResultTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - BiometricCheckResultType
|
|
neq - BiometricCheckResultType
|
|
in - [BiometricCheckResultType!]
|
|
nin - [BiometricCheckResultType!]
|
Example
{"eq": "CONSIDER", "neq": "CONSIDER", "in": ["CONSIDER"], "nin": ["CONSIDER"]}
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
true
BooleanOperationFilterInput
CCJ
Fields
Field Name | Description |
---|---|
currency - String
|
|
companyId - Int!
|
|
address - String
|
|
amount - Int!
|
|
case_number - String
|
|
court_name - String
|
|
date_of_birth - DateTime
|
|
date_of_judgement - DateTime
|
|
entity_type - Int!
|
|
given_name - String
|
|
judgement_type - String
|
|
rtl_image_number - String
|
|
run_date - DateTime
|
|
record_type - String
|
|
satisfaction_date - DateTime
|
|
suffix - String
|
|
surname - String
|
|
title - String
|
|
trading_style - String
|
Example
{
"currency": "xyz789",
"companyId": 123,
"address": "abc123",
"amount": 987,
"case_number": "xyz789",
"court_name": "abc123",
"date_of_birth": "2007-12-03T10:15:30Z",
"date_of_judgement": "2007-12-03T10:15:30Z",
"entity_type": 987,
"given_name": "xyz789",
"judgement_type": "xyz789",
"rtl_image_number": "xyz789",
"run_date": "2007-12-03T10:15:30Z",
"record_type": "xyz789",
"satisfaction_date": "2007-12-03T10:15:30Z",
"suffix": "abc123",
"surname": "xyz789",
"title": "xyz789",
"trading_style": "xyz789"
}
CCJFilterInput
Fields
Input Field | Description |
---|---|
and - [CCJFilterInput!]
|
|
or - [CCJFilterInput!]
|
|
currency - StringOperationFilterInput
|
|
companyId - IntOperationFilterInput
|
|
address - StringOperationFilterInput
|
|
amount - IntOperationFilterInput
|
|
case_number - StringOperationFilterInput
|
|
court_name - StringOperationFilterInput
|
|
date_of_birth - DateTimeOperationFilterInput
|
|
date_of_judgement - DateTimeOperationFilterInput
|
|
entity_type - IntOperationFilterInput
|
|
given_name - StringOperationFilterInput
|
|
judgement_type - StringOperationFilterInput
|
|
rtl_image_number - StringOperationFilterInput
|
|
run_date - DateTimeOperationFilterInput
|
|
record_type - StringOperationFilterInput
|
|
satisfaction_date - DateTimeOperationFilterInput
|
|
suffix - StringOperationFilterInput
|
|
surname - StringOperationFilterInput
|
|
title - StringOperationFilterInput
|
|
trading_style - StringOperationFilterInput
|
Example
{
"and": [CCJFilterInput],
"or": [CCJFilterInput],
"currency": StringOperationFilterInput,
"companyId": IntOperationFilterInput,
"address": StringOperationFilterInput,
"amount": IntOperationFilterInput,
"case_number": StringOperationFilterInput,
"court_name": StringOperationFilterInput,
"date_of_birth": DateTimeOperationFilterInput,
"date_of_judgement": DateTimeOperationFilterInput,
"entity_type": IntOperationFilterInput,
"given_name": StringOperationFilterInput,
"judgement_type": StringOperationFilterInput,
"rtl_image_number": StringOperationFilterInput,
"run_date": DateTimeOperationFilterInput,
"record_type": StringOperationFilterInput,
"satisfaction_date": DateTimeOperationFilterInput,
"suffix": StringOperationFilterInput,
"surname": StringOperationFilterInput,
"title": StringOperationFilterInput,
"trading_style": StringOperationFilterInput
}
CashFlow
Example
{
"account_date": "2007-12-03T10:15:30Z",
"no_weeks": 987,
"consolidated": "abc123",
"currency": "xyz789",
"net_from_operating_activities": Decimal,
"net_from_return_investment_servicing": Decimal,
"net_before_financing": Decimal,
"net_from_financing": Decimal,
"increase_in_cash": Decimal
}
CashFlowFilterInput
Fields
Input Field | Description |
---|---|
and - [CashFlowFilterInput!]
|
|
or - [CashFlowFilterInput!]
|
|
account_date - DateTimeOperationFilterInput
|
|
no_weeks - IntOperationFilterInput
|
|
consolidated - StringOperationFilterInput
|
|
currency - StringOperationFilterInput
|
|
net_from_operating_activities - DecimalOperationFilterInput
|
|
net_from_return_investment_servicing - DecimalOperationFilterInput
|
|
net_before_financing - DecimalOperationFilterInput
|
|
net_from_financing - DecimalOperationFilterInput
|
|
increase_in_cash - DecimalOperationFilterInput
|
Example
{
"and": [CashFlowFilterInput],
"or": [CashFlowFilterInput],
"account_date": DateTimeOperationFilterInput,
"no_weeks": IntOperationFilterInput,
"consolidated": StringOperationFilterInput,
"currency": StringOperationFilterInput,
"net_from_operating_activities": DecimalOperationFilterInput,
"net_from_return_investment_servicing": DecimalOperationFilterInput,
"net_before_financing": DecimalOperationFilterInput,
"net_from_financing": DecimalOperationFilterInput,
"increase_in_cash": DecimalOperationFilterInput
}
Check
Description
Check
Fields
Field Name | Description |
---|---|
options - CheckOptions
|
|
id - Int!
|
Check Id |
detail - DigitalCheckDetail
|
Details about person being checked |
authenticationLink - AuthenticationLink
|
Authentication link |
checkStartUrl - String
|
Identification Check Start Link |
user - User
|
User who created the check |
reference - String
|
Unique of check |
bulkReference - String
|
Bulk Reference |
isBulk - Boolean!
|
Is Bulk |
isMonitored - Boolean!
|
Will monitored any PSAM searches performed as part of this check. |
createdDate - DateTime!
|
Date check was created |
result - CheckResult
|
Result of check |
statuses - [CheckStatus]
|
Statuses of check |
Arguments
|
|
verificationTypes - [Verification]
|
Verifications requested |
checkType - CheckTypeEnum
|
Type of check performed |
notifications - [CheckNotification]
|
Notifications against such as email devivery status |
Arguments
|
Example
{
"options": CheckOptions,
"id": 123,
"detail": DigitalCheckDetail,
"authenticationLink": AuthenticationLink,
"checkStartUrl": "xyz789",
"user": User,
"reference": "xyz789",
"bulkReference": "abc123",
"isBulk": true,
"isMonitored": true,
"createdDate": "2007-12-03T10:15:30Z",
"result": CheckResult,
"statuses": [CheckStatus],
"verificationTypes": [Verification],
"checkType": "KNOW_YOUR_CLIENT",
"notifications": [CheckNotification]
}
CheckBrandingFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckBrandingFilterInput!]
|
|
or - [CheckBrandingFilterInput!]
|
|
checkId - IntOperationFilterInput
|
|
companyLogoUrl - StringOperationFilterInput
|
|
primaryBrandColour - StringOperationFilterInput
|
|
emailSubject - StringOperationFilterInput
|
|
emailTemplate - StringOperationFilterInput
|
|
check - CheckFilterInput
|
Example
{
"and": [CheckBrandingFilterInput],
"or": [CheckBrandingFilterInput],
"checkId": IntOperationFilterInput,
"companyLogoUrl": StringOperationFilterInput,
"primaryBrandColour": StringOperationFilterInput,
"emailSubject": StringOperationFilterInput,
"emailTemplate": StringOperationFilterInput,
"check": CheckFilterInput
}
CheckBrandingInput
Description
Check Branding.
Fields
Input Field | Description |
---|---|
companyLogoUrl - String
|
Logo to use in email |
primaryBrandColour - String
|
Primary colour to use on email template |
emailSubject - String
|
Email subject to use if not defined at an account level |
emailTemplate - String
|
Email template to use if not defined at an account level. (https://github.com/Handlebars-Net/Handlebars.Net) |
Example
{
"companyLogoUrl": "https://www.redflagalert.com/hs-fs/hubfs/rfa-2023/Red-Flag-Logo_Light.png?width=320&height=57",
"primaryBrandColour": "#0000FF",
"emailSubject": "Please provide the information to complete your AML verification",
"emailTemplate": "<div> <div> <div style=\"background-color: {{ primaryColour }}\"> <img style=\"display:block; color:#000000; font-size:16px; max-width:60% !important; width:60%; height:auto !important;\" width=\"324\" alt=\"\" src=\"{{ CompanyLogoUrl }}\"> </div> <div>Dear {{firstName}} {{lastName}},</div> <div>REFERENCE: {{reference}}</div> <div> {{userName}} (({{ UserEmail }})) on behalf of {{ accountName }} has requested that you complete an Identity Check. This could be for an ID Verification, Anti-money Laundering check, or both. If you did not expect this request then please ignore. </div> <div> Please click the link below and follow the instructions: <p><a href=\"{{ verificationLink }}\">Click here</a></p> </div> <div> <p>Kind regards,</p> <p>The Red Flag Alert Team</p> </div> <div> Additional Information: {{message}} </div> </div> </div>"
}
CheckBrandingSortInput
Fields
Input Field | Description |
---|---|
checkId - SortEnumType
|
|
companyLogoUrl - SortEnumType
|
|
primaryBrandColour - SortEnumType
|
|
emailSubject - SortEnumType
|
|
emailTemplate - SortEnumType
|
|
check - CheckSortInput
|
Example
{
"checkId": "ASC",
"companyLogoUrl": "ASC",
"primaryBrandColour": "ASC",
"emailSubject": "ASC",
"emailTemplate": "ASC",
"check": CheckSortInput
}
CheckDescription
Fields
Field Name | Description |
---|---|
id - Int!
|
|
identificationProviderId - IdentificationProviderId!
|
|
identificationProvider - IdentificationProvider
|
|
description - String
|
|
organisation - String
|
|
group - String
|
Example
{
"id": 123,
"identificationProviderId": "AUTHENTEQ",
"identificationProvider": IdentificationProvider,
"description": "xyz789",
"organisation": "xyz789",
"group": "xyz789"
}
CheckDescriptionFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckDescriptionFilterInput!]
|
|
or - [CheckDescriptionFilterInput!]
|
|
id - IntOperationFilterInput
|
|
identificationProviderId - IdentificationProviderIdOperationFilterInput
|
|
identificationProvider - IdentificationProviderFilterInput
|
|
description - StringOperationFilterInput
|
|
organisation - StringOperationFilterInput
|
|
group - StringOperationFilterInput
|
Example
{
"and": [CheckDescriptionFilterInput],
"or": [CheckDescriptionFilterInput],
"id": IntOperationFilterInput,
"identificationProviderId": IdentificationProviderIdOperationFilterInput,
"identificationProvider": IdentificationProviderFilterInput,
"description": StringOperationFilterInput,
"organisation": StringOperationFilterInput,
"group": StringOperationFilterInput
}
CheckDetailAddress
Description
Address being checked
Fields
Field Name | Description |
---|---|
id - Int!
|
Mobile number user being checked |
addressLine1 - String
|
First line of address (house name or number). |
addressLine2 - String
|
Second line of address (street name). |
addressLine3 - String
|
Third line of address (locality or village). |
addressLine4 - String
|
Fourth line of address (town / city). |
postcode - String
|
Postcode. |
country - String
|
Country |
countryCode - account_CountryCode!
|
ISO Country Code |
firstResidenceDate - DateTime
|
First residence date |
lastResidenceDate - DateTime
|
Last residence date |
Example
{
"id": 987,
"addressLine1": "abc123",
"addressLine2": "abc123",
"addressLine3": "xyz789",
"addressLine4": "abc123",
"postcode": "xyz789",
"country": "xyz789",
"countryCode": "AFG",
"firstResidenceDate": "2007-12-03T10:15:30Z",
"lastResidenceDate": "2007-12-03T10:15:30Z"
}
CheckDetailAddressFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckDetailAddressFilterInput!]
|
|
or - [CheckDetailAddressFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkDetailId - IntOperationFilterInput
|
|
addressLine1 - StringOperationFilterInput
|
|
addressLine2 - StringOperationFilterInput
|
|
addressLine3 - StringOperationFilterInput
|
|
addressLine4 - StringOperationFilterInput
|
|
postcode - StringOperationFilterInput
|
|
country - StringOperationFilterInput
|
|
countryCode - CountryCodeOperationFilterInput
|
|
firstResidenceDate - portfolio_DateTimeOperationFilterInput
|
|
lastResidenceDate - portfolio_DateTimeOperationFilterInput
|
Example
{
"and": [CheckDetailAddressFilterInput],
"or": [CheckDetailAddressFilterInput],
"id": IntOperationFilterInput,
"checkDetailId": IntOperationFilterInput,
"addressLine1": StringOperationFilterInput,
"addressLine2": StringOperationFilterInput,
"addressLine3": StringOperationFilterInput,
"addressLine4": StringOperationFilterInput,
"postcode": StringOperationFilterInput,
"country": StringOperationFilterInput,
"countryCode": CountryCodeOperationFilterInput,
"firstResidenceDate": portfolio_DateTimeOperationFilterInput,
"lastResidenceDate": portfolio_DateTimeOperationFilterInput
}
CheckDetailAddressInputType
Description
Address of person being checked.
Fields
Input Field | Description |
---|---|
addressLine1 - String
|
First line of address (house name or number). |
addressLine2 - String
|
Second line of address (street name). |
addressLine3 - String
|
Third line of address (locality or village). |
addressLine4 - String
|
Fourth line of address (town / city). |
postcode - String
|
Postcode. |
country - String
|
Country. |
countryCode - account_CountryCode!
|
ISO Alpha-3 Country Code. Default = GBR |
firstResidenceDate - DateTime
|
First date of residence. |
lastResidenceDate - DateTime
|
Last date of residence. |
Example
{
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"addressLine3": "xyz789",
"addressLine4": "xyz789",
"postcode": "xyz789",
"country": "abc123",
"countryCode": "AFG",
"firstResidenceDate": "2007-12-03T10:15:30Z",
"lastResidenceDate": "2007-12-03T10:15:30Z"
}
CheckDetailFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckDetailFilterInput!]
|
|
or - [CheckDetailFilterInput!]
|
|
checkId - IntOperationFilterInput
|
|
sex - SexOperationFilterInput
|
|
title - TitleOperationFilterInput
|
|
firstName - StringOperationFilterInput
|
|
middleName - StringOperationFilterInput
|
|
lastName - StringOperationFilterInput
|
|
fromName - StringOperationFilterInput
|
|
dateOfBirth - portfolio_DateTimeOperationFilterInput
|
|
email - StringOperationFilterInput
|
|
landlineNumber - StringOperationFilterInput
|
|
mobileNumber - StringOperationFilterInput
|
|
message - StringOperationFilterInput
|
|
smSMessage - StringOperationFilterInput
|
|
countryOfResidence - CountryCodeOperationFilterInput
|
|
check - CheckFilterInput
|
|
identityDocuments - ListFilterInputTypeOfCheckDetailIdentityDocumentFilterInput
|
|
addresses - ListFilterInputTypeOfCheckDetailAddressFilterInput
|
Example
{
"and": [CheckDetailFilterInput],
"or": [CheckDetailFilterInput],
"checkId": IntOperationFilterInput,
"sex": SexOperationFilterInput,
"title": TitleOperationFilterInput,
"firstName": StringOperationFilterInput,
"middleName": StringOperationFilterInput,
"lastName": StringOperationFilterInput,
"fromName": StringOperationFilterInput,
"dateOfBirth": portfolio_DateTimeOperationFilterInput,
"email": StringOperationFilterInput,
"landlineNumber": StringOperationFilterInput,
"mobileNumber": StringOperationFilterInput,
"message": StringOperationFilterInput,
"smSMessage": StringOperationFilterInput,
"countryOfResidence": CountryCodeOperationFilterInput,
"check": CheckFilterInput,
"identityDocuments": ListFilterInputTypeOfCheckDetailIdentityDocumentFilterInput,
"addresses": ListFilterInputTypeOfCheckDetailAddressFilterInput
}
CheckDetailIdentityDocument
Description
Identity documents provided for user being checked
Fields
Field Name | Description |
---|---|
documentNumber - String
|
Document number |
countryOfOrigin - account_CountryCode!
|
Document country of origin |
expiryDate - DateTime
|
Document expiry date |
documentType - CheckDetailIdentityDocumentType!
|
Document type |
Example
{
"documentNumber": "xyz789",
"countryOfOrigin": "AFG",
"expiryDate": "2007-12-03T10:15:30Z",
"documentType": "PASSPORT"
}
CheckDetailIdentityDocumentFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckDetailIdentityDocumentFilterInput!]
|
|
or - [CheckDetailIdentityDocumentFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkDetailId - IntOperationFilterInput
|
|
documentNumber - StringOperationFilterInput
|
|
expiryDate - portfolio_DateTimeOperationFilterInput
|
|
countryOfOrigin - CountryCodeOperationFilterInput
|
|
documentType - CheckDetailIdentityDocumentTypeOperationFilterInput
|
Example
{
"and": [CheckDetailIdentityDocumentFilterInput],
"or": [CheckDetailIdentityDocumentFilterInput],
"id": IntOperationFilterInput,
"checkDetailId": IntOperationFilterInput,
"documentNumber": StringOperationFilterInput,
"expiryDate": portfolio_DateTimeOperationFilterInput,
"countryOfOrigin": CountryCodeOperationFilterInput,
"documentType": CheckDetailIdentityDocumentTypeOperationFilterInput
}
CheckDetailIdentityDocumentInput
Description
Identification document of person being checked.
Fields
Input Field | Description |
---|---|
documentNumber - String
|
Document number. |
expiryDate - DateTime
|
Expiry date of document. |
countryOfOrigin - account_CountryCode!
|
Document country of origin. Default = GBR |
documentType - CheckDetailIdentityDocumentType!
|
Type of document. |
Example
{
"documentNumber": "abc123",
"expiryDate": "2007-12-03T10:15:30Z",
"countryOfOrigin": "AFG",
"documentType": "PASSPORT"
}
CheckDetailIdentityDocumentType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"PASSPORT"
CheckDetailIdentityDocumentTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CheckDetailIdentityDocumentType
|
|
neq - CheckDetailIdentityDocumentType
|
|
in - [CheckDetailIdentityDocumentType!]
|
|
nin - [CheckDetailIdentityDocumentType!]
|
Example
{"eq": "PASSPORT", "neq": "PASSPORT", "in": ["PASSPORT"], "nin": ["PASSPORT"]}
CheckDetailInput
Description
Check request details.
Fields
Input Field | Description |
---|---|
email - String
|
Email of person being checked. |
title - Title!
|
Title of person being checked. Default = UNSPECIFIED |
sex - Sex!
|
Sex of person being checked. Default = UNSPECIFIED |
firstName - String
|
First name of person being checked. |
middleName - String
|
Middle name of person being checked. |
lastName - String
|
Last name of person being checked. |
dateOfBirth - DateTime
|
Date of birth of person being checked. |
landlineNumber - String
|
Landline number of person being checked. |
mobileNumber - String
|
Mobile phone number of person being checked. |
countryOfResidence - account_CountryCode!
|
Country of Residence. This is used to determine which profiles will be used for the parts of the check that are country specific such as address verification. Default = GBR |
fromName - String
|
Name of message sender to appear in email body. |
message - String
|
Message to person being checked. |
smSMessage - String
|
Message sent in SMS body with link. |
identityDocuments - [CheckDetailIdentityDocumentInput]
|
Identity documents of person being checked. |
addresses - [CheckDetailAddressInputType]
|
Addresses to person being checked. |
Example
{
"email": "bob@redflagalert.com",
"title": "Mr",
"sex": "Male",
"firstName": "Bob",
"middleName": "Matthew",
"lastName": "Smith",
"dateOfBirth": "1999-12-03",
"landlineNumber": "03304609877",
"mobileNumber": "03304609877",
"countryOfResidence": "GBR",
"fromName": "Red Flag Alert",
"message": "Hi Bob, please complete this check so we can ID you.",
"smSMessage": "Hi Bob, please complete this check so we can ID you.",
"identityDocuments": ["Passport"],
"addresses": ["49 Peter St, Manchester M2 3NG"]
}
CheckDetailSearchType
Fields
Field Name | Description |
---|---|
id - Int!
|
|
email - String
|
Email of user being checked |
firstName - String
|
First name of user being checked |
middleName - String
|
Middle name of user being checked |
lastName - String
|
Last name of user being checked |
dateOfBirth - DateTime
|
Last name of user being checked |
mobileNumber - String
|
Mobile number user being checked |
countryOfResidence - account_CountryCode!
|
ISO Alpha-3 Country of residence |
Example
{
"id": 123,
"email": "xyz789",
"firstName": "xyz789",
"middleName": "abc123",
"lastName": "abc123",
"dateOfBirth": "2007-12-03T10:15:30Z",
"mobileNumber": "xyz789",
"countryOfResidence": "AFG"
}
CheckDetailSortInput
Fields
Input Field | Description |
---|---|
checkId - SortEnumType
|
|
sex - SortEnumType
|
|
title - SortEnumType
|
|
firstName - SortEnumType
|
|
middleName - SortEnumType
|
|
lastName - SortEnumType
|
|
fromName - SortEnumType
|
|
dateOfBirth - SortEnumType
|
|
email - SortEnumType
|
|
landlineNumber - SortEnumType
|
|
mobileNumber - SortEnumType
|
|
message - SortEnumType
|
|
smSMessage - SortEnumType
|
|
countryOfResidence - SortEnumType
|
|
check - CheckSortInput
|
Example
{
"checkId": "ASC",
"sex": "ASC",
"title": "ASC",
"firstName": "ASC",
"middleName": "ASC",
"lastName": "ASC",
"fromName": "ASC",
"dateOfBirth": "ASC",
"email": "ASC",
"landlineNumber": "ASC",
"mobileNumber": "ASC",
"message": "ASC",
"smSMessage": "ASC",
"countryOfResidence": "ASC",
"check": CheckSortInput
}
CheckFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckFilterInput!]
|
|
or - [CheckFilterInput!]
|
|
id - IntOperationFilterInput
|
|
userEmail - StringOperationFilterInput
|
|
accountId - StringOperationFilterInput
|
|
reference - StringOperationFilterInput
|
|
bulkReference - StringOperationFilterInput
|
|
checkType - NullableOfCheckTypeEnumOperationFilterInput
|
|
isBulk - BooleanOperationFilterInput
|
|
isMonitored - BooleanOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
options - CheckOptionsFilterInput
|
|
checkBranding - CheckBrandingFilterInput
|
|
detail - CheckDetailFilterInput
|
|
user - UserFilterInput
|
|
result - CheckResultFilterInput
|
|
complyAdvantageSearch - ComplyAdvantageSearchFilterInput
|
|
statuses - ListFilterInputTypeOfCheckStatusFilterInput
|
|
notifications - ListFilterInputTypeOfCheckNotificationFilterInput
|
|
verificationTypes - ListFilterInputTypeOfVerificationFilterInput
|
|
apiRequests - ListFilterInputTypeOfApiRequestFilterInput
|
|
authenticationLink - AuthenticationLinkFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [CheckFilterInput],
"or": [CheckFilterInput],
"id": IntOperationFilterInput,
"userEmail": StringOperationFilterInput,
"accountId": StringOperationFilterInput,
"reference": StringOperationFilterInput,
"bulkReference": StringOperationFilterInput,
"checkType": NullableOfCheckTypeEnumOperationFilterInput,
"isBulk": BooleanOperationFilterInput,
"isMonitored": BooleanOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"options": CheckOptionsFilterInput,
"checkBranding": CheckBrandingFilterInput,
"detail": CheckDetailFilterInput,
"user": UserFilterInput,
"result": CheckResultFilterInput,
"complyAdvantageSearch": ComplyAdvantageSearchFilterInput,
"statuses": ListFilterInputTypeOfCheckStatusFilterInput,
"notifications": ListFilterInputTypeOfCheckNotificationFilterInput,
"verificationTypes": ListFilterInputTypeOfVerificationFilterInput,
"apiRequests": ListFilterInputTypeOfApiRequestFilterInput,
"authenticationLink": AuthenticationLinkFilterInput,
"account": AccountFilterInput
}
CheckHighlight
Description
Account statistics.
Fields
Field Name | Description |
---|---|
status - CheckStatusType
|
Status of check. |
result - CheckResultType
|
Result of check. |
createdDate - DateTime
|
Date check created |
completedDate - DateTime
|
Date check completed |
Example
{
"status": "CREATED",
"result": "AWAITING",
"createdDate": "2007-12-03T10:15:30Z",
"completedDate": "2007-12-03T10:15:30Z"
}
CheckNotification
Description
Check Notifications
Fields
Field Name | Description |
---|---|
id - Int!
|
Notification Id |
eventDate - DateTime!
|
Date of event |
createdDate - DateTime!
|
Date event recorded |
notificationEvent - NotificationEventEnum!
|
Event that occurred |
notificationType - NotificationTypeEnum!
|
Type of notification |
description - String
|
Description of notification |
Example
{
"id": 123,
"eventDate": "2007-12-03T10:15:30Z",
"createdDate": "2007-12-03T10:15:30Z",
"notificationEvent": "SPAM_REPORT",
"notificationType": "EMAIL",
"description": "xyz789"
}
CheckNotificationFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckNotificationFilterInput!]
|
|
or - [CheckNotificationFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkId - IntOperationFilterInput
|
|
notificationType - NotificationTypeEnumOperationFilterInput
|
|
notificationEvent - NotificationEventEnumOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
eventDate - portfolio_DateTimeOperationFilterInput
|
|
check - CheckFilterInput
|
Example
{
"and": [CheckNotificationFilterInput],
"or": [CheckNotificationFilterInput],
"id": IntOperationFilterInput,
"checkId": IntOperationFilterInput,
"notificationType": NotificationTypeEnumOperationFilterInput,
"notificationEvent": NotificationEventEnumOperationFilterInput,
"description": StringOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"eventDate": portfolio_DateTimeOperationFilterInput,
"check": CheckFilterInput
}
CheckNotificationSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
checkId - SortEnumType
|
|
notificationType - SortEnumType
|
|
notificationEvent - SortEnumType
|
|
description - SortEnumType
|
|
createdDate - SortEnumType
|
|
eventDate - SortEnumType
|
|
check - CheckSortInput
|
Example
{
"id": "ASC",
"checkId": "ASC",
"notificationType": "ASC",
"notificationEvent": "ASC",
"description": "ASC",
"createdDate": "ASC",
"eventDate": "ASC",
"check": CheckSortInput
}
CheckOptions
CheckOptionsFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckOptionsFilterInput!]
|
|
or - [CheckOptionsFilterInput!]
|
|
checkId - IntOperationFilterInput
|
|
psamFuzziness - DecimalOperationFilterInput
|
|
excludeAdverseMedia - BooleanOperationFilterInput
|
|
sendSmSNotification - BooleanOperationFilterInput
|
|
sendEmailNotification - BooleanOperationFilterInput
|
|
check - CheckFilterInput
|
Example
{
"and": [CheckOptionsFilterInput],
"or": [CheckOptionsFilterInput],
"checkId": IntOperationFilterInput,
"psamFuzziness": DecimalOperationFilterInput,
"excludeAdverseMedia": BooleanOperationFilterInput,
"sendSmSNotification": BooleanOperationFilterInput,
"sendEmailNotification": BooleanOperationFilterInput,
"check": CheckFilterInput
}
CheckOptionsInputType
Description
Check options.
Fields
Input Field | Description |
---|---|
psamFuzziness - Float!
|
Fuzziness of PSAM check between 0 and 1. A fuzziness of 1 will return more possible matches. 0 will perform an exact match. Default = 0.5 |
excludeAdverseMedia - Boolean!
|
When selected will perform a PSAM check without any adverse media. Default = false |
sendSmSNotification - Boolean!
|
If disabled then no SMS notification will be sent. Default = true |
sendEmailNotification - Boolean!
|
If disabled then no email notification will be sent. Default = true |
Example
{
"psamFuzziness": 987.65,
"excludeAdverseMedia": false,
"sendSmSNotification": false,
"sendEmailNotification": false
}
CheckOptionsSortInput
Fields
Input Field | Description |
---|---|
checkId - SortEnumType
|
|
psamFuzziness - SortEnumType
|
|
excludeAdverseMedia - SortEnumType
|
|
sendSmSNotification - SortEnumType
|
|
sendEmailNotification - SortEnumType
|
|
check - CheckSortInput
|
Example
{
"checkId": "ASC",
"psamFuzziness": "ASC",
"excludeAdverseMedia": "ASC",
"sendSmSNotification": "ASC",
"sendEmailNotification": "ASC",
"check": CheckSortInput
}
CheckRequestInput
Description
Check request information.
Fields
Input Field | Description |
---|---|
checkType - CheckTypeEnum
|
Type of check to perform. |
reference - String
|
Check reference. |
bulkReference - String
|
Bulk reference. |
options - CheckOptionsInputType
|
Check options. |
checkBranding - CheckBrandingInput
|
Check branding. |
detail - CheckDetailInput
|
Check details. |
accountId - String
|
Account Id for check being created. |
isMonitored - Boolean!
|
Checks with PSAM searches will update when results change. Default = false |
userEmail - String
|
Email of person creating check. |
verificationTypes - [VerificationInput]
|
[Deprecated - Use CheckType] Additional checks request. |
Example
{
"checkType": "KNOW_YOUR_CLIENT",
"reference": "RFA12345",
"bulkReference": "abc123",
"options": CheckOptionsInputType,
"checkBranding": CheckBrandingInput,
"detail": CheckDetailInput,
"accountId": "xyz789",
"isMonitored": false,
"userEmail": "abc123",
"verificationTypes": [VerificationInput]
}
CheckResult
Description
Check result
Fields
Field Name | Description |
---|---|
id - Int!
|
Check Result Id |
result - CheckResultType!
|
Type of result |
createdDate - DateTime!
|
Date result created |
reportUrl - String
|
Url for report |
identificationDocument - IdentificationDocument
|
Identification document details |
amlResult - AmlResult
|
AML Result Use AML Results instead |
amlResults - [AmlResult]
|
AML Results |
addressVerificationResult - AddressVerificationResult
|
Address verification result |
Example
{
"id": 987,
"result": "AWAITING",
"createdDate": "2007-12-03T10:15:30Z",
"reportUrl": "xyz789",
"identificationDocument": IdentificationDocument,
"amlResult": AmlResult,
"amlResults": [AmlResult],
"addressVerificationResult": AddressVerificationResult
}
CheckResultFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckResultFilterInput!]
|
|
or - [CheckResultFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkId - IntOperationFilterInput
|
|
reportUrl - StringOperationFilterInput
|
|
result - CheckResultTypeOperationFilterInput
|
|
check - CheckFilterInput
|
|
identificationDocument - IdentificationDocumentFilterInput
|
|
amlResult - AmlResultFilterInput
|
|
amlResults - ListFilterInputTypeOfAmlResultFilterInput
|
|
addressVerificationResult - AddressVerificationResultFilterInput
|
|
hasUpdates - BooleanOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
lastModifiedDate - portfolio_DateTimeOperationFilterInput
|
|
lastViewedDate - portfolio_DateTimeOperationFilterInput
|
Example
{
"and": [CheckResultFilterInput],
"or": [CheckResultFilterInput],
"id": IntOperationFilterInput,
"checkId": IntOperationFilterInput,
"reportUrl": StringOperationFilterInput,
"result": CheckResultTypeOperationFilterInput,
"check": CheckFilterInput,
"identificationDocument": IdentificationDocumentFilterInput,
"amlResult": AmlResultFilterInput,
"amlResults": ListFilterInputTypeOfAmlResultFilterInput,
"addressVerificationResult": AddressVerificationResultFilterInput,
"hasUpdates": BooleanOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"lastModifiedDate": portfolio_DateTimeOperationFilterInput,
"lastViewedDate": portfolio_DateTimeOperationFilterInput
}
CheckResultSearchType
Fields
Field Name | Description |
---|---|
hasUpdates - Boolean
|
Has the check had updates since last viewed |
id - Int!
|
Check Result Id |
result - CheckResultType!
|
Type of result |
reportUrl - String
|
Url for report |
createdDate - DateTime!
|
Date result created |
lastViewedDate - DateTime!
|
Date check last viewed in full |
lastModifiedDate - DateTime!
|
Date check last modified |
identificationDocument - IdentificationDocumentSearchType
|
Identification document details |
amlResults - [AmlResultSearchType]
|
AML Result details |
Arguments
|
Example
{
"hasUpdates": false,
"id": 123,
"result": "AWAITING",
"reportUrl": "xyz789",
"createdDate": "2007-12-03T10:15:30Z",
"lastViewedDate": "2007-12-03T10:15:30Z",
"lastModifiedDate": "2007-12-03T10:15:30Z",
"identificationDocument": IdentificationDocumentSearchType,
"amlResults": [AmlResultSearchType]
}
CheckResultSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
checkId - SortEnumType
|
|
reportUrl - SortEnumType
|
|
result - SortEnumType
|
|
check - CheckSortInput
|
|
identificationDocument - IdentificationDocumentSortInput
|
|
amlResult - AmlResultSortInput
|
|
addressVerificationResult - AddressVerificationResultSortInput
|
|
hasUpdates - SortEnumType
|
|
createdDate - SortEnumType
|
|
lastModifiedDate - SortEnumType
|
|
lastViewedDate - SortEnumType
|
Example
{
"id": "ASC",
"checkId": "ASC",
"reportUrl": "ASC",
"result": "ASC",
"check": CheckSortInput,
"identificationDocument": IdentificationDocumentSortInput,
"amlResult": AmlResultSortInput,
"addressVerificationResult": AddressVerificationResultSortInput,
"hasUpdates": "ASC",
"createdDate": "ASC",
"lastModifiedDate": "ASC",
"lastViewedDate": "ASC"
}
CheckResultType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"AWAITING"
CheckResultTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CheckResultType
|
|
neq - CheckResultType
|
|
in - [CheckResultType!]
|
|
nin - [CheckResultType!]
|
Example
{"eq": "AWAITING", "neq": "AWAITING", "in": ["AWAITING"], "nin": ["AWAITING"]}
CheckSearchType
Description
CheckSearch
Fields
Field Name | Description |
---|---|
options - CheckOptions
|
|
detail - CheckDetailSearchType
|
Details about person being checked |
user - UserSearchType
|
User who performed the check |
statuses - [CheckStatusSearchType]
|
Statuses of check |
Arguments
|
|
result - CheckResultSearchType
|
Result of check |
id - Int!
|
Check Id |
reference - String
|
Unique of check |
bulkReference - String
|
Bulk Reference |
isBulk - Boolean!
|
Is Bulk |
isMonitored - Boolean!
|
Will monitored any PSAM searches performed as part of this check. |
createdDate - DateTime!
|
Date check was created |
checkType - CheckTypeEnum
|
Type of check performed |
checkStartUrl - String
|
Identification Check Start Link |
notifications - [CheckNotification]
|
Notifications against such as email devivery status |
Arguments
|
Example
{
"options": CheckOptions,
"detail": CheckDetailSearchType,
"user": UserSearchType,
"statuses": [CheckStatusSearchType],
"result": CheckResultSearchType,
"id": 987,
"reference": "abc123",
"bulkReference": "xyz789",
"isBulk": true,
"isMonitored": false,
"createdDate": "2007-12-03T10:15:30Z",
"checkType": "KNOW_YOUR_CLIENT",
"checkStartUrl": "abc123",
"notifications": [CheckNotification]
}
CheckSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
userEmail - SortEnumType
|
|
accountId - SortEnumType
|
|
reference - SortEnumType
|
|
bulkReference - SortEnumType
|
|
checkType - SortEnumType
|
|
isBulk - SortEnumType
|
|
isMonitored - SortEnumType
|
|
createdDate - SortEnumType
|
|
options - CheckOptionsSortInput
|
|
checkBranding - CheckBrandingSortInput
|
|
detail - CheckDetailSortInput
|
|
user - UserSortInput
|
|
result - CheckResultSortInput
|
|
complyAdvantageSearch - ComplyAdvantageSearchSortInput
|
|
authenticationLink - AuthenticationLinkSortInput
|
|
account - AccountSortInput
|
Example
{
"id": "ASC",
"userEmail": "ASC",
"accountId": "ASC",
"reference": "ASC",
"bulkReference": "ASC",
"checkType": "ASC",
"isBulk": "ASC",
"isMonitored": "ASC",
"createdDate": "ASC",
"options": CheckOptionsSortInput,
"checkBranding": CheckBrandingSortInput,
"detail": CheckDetailSortInput,
"user": UserSortInput,
"result": CheckResultSortInput,
"complyAdvantageSearch": ComplyAdvantageSearchSortInput,
"authenticationLink": AuthenticationLinkSortInput,
"account": AccountSortInput
}
CheckStatus
Description
Check Status
Fields
Field Name | Description |
---|---|
id - Int!
|
Check Status Id |
status - CheckStatusType!
|
Check Status |
createdDate - DateTime!
|
Check Status Created DateTime |
Example
{
"id": 987,
"status": "CREATED",
"createdDate": "2007-12-03T10:15:30Z"
}
CheckStatusFilterInput
Fields
Input Field | Description |
---|---|
and - [CheckStatusFilterInput!]
|
|
or - [CheckStatusFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkId - IntOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
check - CheckFilterInput
|
|
status - CheckStatusTypeOperationFilterInput
|
Example
{
"and": [CheckStatusFilterInput],
"or": [CheckStatusFilterInput],
"id": IntOperationFilterInput,
"checkId": IntOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"check": CheckFilterInput,
"status": CheckStatusTypeOperationFilterInput
}
CheckStatusSearchType
Fields
Field Name | Description |
---|---|
id - Int!
|
Check Status Id |
status - CheckStatusType!
|
Check Status |
createdDate - DateTime!
|
Check Status Created DateTime |
Example
{
"id": 123,
"status": "CREATED",
"createdDate": "2007-12-03T10:15:30Z"
}
CheckStatusSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
checkId - SortEnumType
|
|
createdDate - SortEnumType
|
|
check - CheckSortInput
|
|
status - SortEnumType
|
Example
{
"id": "ASC",
"checkId": "ASC",
"createdDate": "ASC",
"check": CheckSortInput,
"status": "ASC"
}
CheckStatusType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"CREATED"
CheckStatusTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CheckStatusType
|
|
neq - CheckStatusType
|
|
in - [CheckStatusType!]
|
|
nin - [CheckStatusType!]
|
Example
{"eq": "CREATED", "neq": "CREATED", "in": ["CREATED"], "nin": ["CREATED"]}
CheckTypeEnum
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"KNOW_YOUR_CLIENT"
ChecksCollectionSegment
Description
A segment of a collection.
Fields
Field Name | Description |
---|---|
pageInfo - CollectionSegmentInfo!
|
Information to aid in pagination. |
items - [CheckSearchType]
|
A flattened list of the items. |
totalCount - Int!
|
Example
{
"pageInfo": CollectionSegmentInfo,
"items": [CheckSearchType],
"totalCount": 987
}
CollectionSegmentInfo
Description
Information about the offset pagination.
Example
{"hasNextPage": true, "hasPreviousPage": false}
CompanyAppointmentType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
CompanyAppointmentTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyAppointmentType
|
|
neq - CompanyAppointmentType
|
|
in - [CompanyAppointmentType!]
|
|
nin - [CompanyAppointmentType!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
CompanyArchive
Fields
Field Name | Description |
---|---|
id - UUID!
|
|
createdDate - DateTime!
|
|
expiryDate - DateTime!
|
|
userId - String
|
|
countryCode - CountryCode!
|
Example
{
"id": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"createdDate": "2007-12-03T10:15:30Z",
"expiryDate": "2007-12-03T10:15:30Z",
"userId": "abc123",
"countryCode": "AFG"
}
CompanyArchiveFilterInput
Fields
Input Field | Description |
---|---|
and - [CompanyArchiveFilterInput!]
|
|
or - [CompanyArchiveFilterInput!]
|
|
id - UuidOperationFilterInput
|
|
createdDate - DateTimeOperationFilterInput
|
|
expiryDate - DateTimeOperationFilterInput
|
|
userId - StringOperationFilterInput
|
|
countryCode - CountryCodeOperationFilterInput
|
Example
{
"and": [CompanyArchiveFilterInput],
"or": [CompanyArchiveFilterInput],
"id": UuidOperationFilterInput,
"createdDate": DateTimeOperationFilterInput,
"expiryDate": DateTimeOperationFilterInput,
"userId": StringOperationFilterInput,
"countryCode": CountryCodeOperationFilterInput
}
CompanyBeneficiaryFilterInput
Fields
Input Field | Description |
---|---|
and - [CompanyBeneficiaryFilterInput!]
|
|
or - [CompanyBeneficiaryFilterInput!]
|
|
address - AddressFilterInput
|
|
key - StringOperationFilterInput
|
|
type - CompanyBeneficiaryTypeOperationFilterInput
|
|
label - StringOperationFilterInput
|
|
ownership_percentage - FloatOperationFilterInput
|
|
separation - IntOperationFilterInput
|
|
is_beneficiary - BooleanOperationFilterInput
|
Example
{
"and": [CompanyBeneficiaryFilterInput],
"or": [CompanyBeneficiaryFilterInput],
"address": AddressFilterInput,
"key": StringOperationFilterInput,
"type": CompanyBeneficiaryTypeOperationFilterInput,
"label": StringOperationFilterInput,
"ownership_percentage": FloatOperationFilterInput,
"separation": IntOperationFilterInput,
"is_beneficiary": BooleanOperationFilterInput
}
CompanyBeneficiaryRelationshipFilterInput
Fields
Input Field | Description |
---|---|
and - [CompanyBeneficiaryRelationshipFilterInput!]
|
|
or - [CompanyBeneficiaryRelationshipFilterInput!]
|
|
in_key - StringOperationFilterInput
|
|
out_key - StringOperationFilterInput
|
|
label - StringOperationFilterInput
|
|
share_percentage - FloatOperationFilterInput
|
|
implied_share_percentage - FloatOperationFilterInput
|
|
relationship_type - CompanyBeneficiaryRelationshipTypeOperationFilterInput
|
Example
{
"and": [CompanyBeneficiaryRelationshipFilterInput],
"or": [CompanyBeneficiaryRelationshipFilterInput],
"in_key": StringOperationFilterInput,
"out_key": StringOperationFilterInput,
"label": StringOperationFilterInput,
"share_percentage": FloatOperationFilterInput,
"implied_share_percentage": FloatOperationFilterInput,
"relationship_type": CompanyBeneficiaryRelationshipTypeOperationFilterInput
}
CompanyBeneficiaryRelationshipType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"PERSONS_OF_SIGNIFICANT_CONTROL"
CompanyBeneficiaryRelationshipTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyBeneficiaryRelationshipType
|
|
neq - CompanyBeneficiaryRelationshipType
|
|
in - [CompanyBeneficiaryRelationshipType!]
|
|
nin - [CompanyBeneficiaryRelationshipType!]
|
Example
{
"eq": "PERSONS_OF_SIGNIFICANT_CONTROL",
"neq": "PERSONS_OF_SIGNIFICANT_CONTROL",
"in": ["PERSONS_OF_SIGNIFICANT_CONTROL"],
"nin": ["PERSONS_OF_SIGNIFICANT_CONTROL"]
}
CompanyBeneficiaryType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"BUSINESS"
CompanyBeneficiaryTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyBeneficiaryType
|
|
neq - CompanyBeneficiaryType
|
|
in - [CompanyBeneficiaryType!]
|
|
nin - [CompanyBeneficiaryType!]
|
Example
{"eq": "BUSINESS", "neq": "BUSINESS", "in": ["BUSINESS"], "nin": ["BUSINESS"]}
CompanyPortfolioFilterInput
Fields
Input Field | Description |
---|---|
and - [CompanyPortfolioFilterInput!]
|
|
or - [CompanyPortfolioFilterInput!]
|
|
id - IntOperationFilterInput
|
|
companyId - IntOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
notes - StringOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
|
createdTime - portfolio_DateTimeOperationFilterInput
|
|
accountEmail - StringOperationFilterInput
|
|
isActive - BooleanOperationFilterInput
|
|
portfolioEvents - ListFilterInputTypeOfPortfolioEventFilterInput
|
Example
{
"and": [CompanyPortfolioFilterInput],
"or": [CompanyPortfolioFilterInput],
"id": IntOperationFilterInput,
"companyId": IntOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"notes": StringOperationFilterInput,
"portfolio": PortfolioFilterInput,
"createdTime": portfolio_DateTimeOperationFilterInput,
"accountEmail": StringOperationFilterInput,
"isActive": BooleanOperationFilterInput,
"portfolioEvents": ListFilterInputTypeOfPortfolioEventFilterInput
}
CompanyPortfolioSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
companyId - SortEnumType
|
|
portfolioId - SortEnumType
|
|
notes - SortEnumType
|
|
portfolio - PortfolioSortInput
|
|
createdTime - SortEnumType
|
|
accountEmail - SortEnumType
|
|
isActive - SortEnumType
|
Example
{
"id": "ASC",
"companyId": "ASC",
"portfolioId": "ASC",
"notes": "ASC",
"portfolio": PortfolioSortInput,
"createdTime": "ASC",
"accountEmail": "ASC",
"isActive": "ASC"
}
CompanyRating
Values
Enum Value | Description |
---|---|
|
For any concern carrying three red flags no credit terms should be offered or trading undertaken and a full disclosure of the situation should be obtained. |
|
These businesses have a poor credit score or where serious detrimental information has been identified. Trading with these concerns is very high risk. It is advisable to review the full company report. |
|
These businesses will be higher credit risks due to their past trading history, lack of information or may have detrimental information against them. They could be slow in paying their suppliers and it is recommended that any trading undertaken be supervised carefully. All monitoring notices should be reviewed immediately and acted upon quickly. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"THREE_RED_FLAGS"
CompanyRatingOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyRating
|
|
neq - CompanyRating
|
|
in - [CompanyRating!]
|
|
nin - [CompanyRating!]
|
Example
{
"eq": "THREE_RED_FLAGS",
"neq": "THREE_RED_FLAGS",
"in": ["THREE_RED_FLAGS"],
"nin": ["THREE_RED_FLAGS"]
}
CompanyReportArchiveFilterInput
Fields
Input Field | Description |
---|---|
and - [CompanyReportArchiveFilterInput!]
|
|
or - [CompanyReportArchiveFilterInput!]
|
|
id - UuidOperationFilterInput
|
|
createdDate - DateTimeOperationFilterInput
|
|
expiryDate - DateTimeOperationFilterInput
|
|
companyName - StringOperationFilterInput
|
|
companyId - StringOperationFilterInput
|
|
companyNumber - StringOperationFilterInput
|
|
countryCode - CountryCodeOperationFilterInput
|
|
accountId - StringOperationFilterInput
|
|
userId - StringOperationFilterInput
|
|
addresses - ListFilterInputTypeOfAddressFilterInput
|
|
reasonCode - NullableOfCompanyReportReasonCodeOperationFilterInput
|
Example
{
"and": [CompanyReportArchiveFilterInput],
"or": [CompanyReportArchiveFilterInput],
"id": UuidOperationFilterInput,
"createdDate": DateTimeOperationFilterInput,
"expiryDate": DateTimeOperationFilterInput,
"companyName": StringOperationFilterInput,
"companyId": StringOperationFilterInput,
"companyNumber": StringOperationFilterInput,
"countryCode": CountryCodeOperationFilterInput,
"accountId": StringOperationFilterInput,
"userId": StringOperationFilterInput,
"addresses": ListFilterInputTypeOfAddressFilterInput,
"reasonCode": NullableOfCompanyReportReasonCodeOperationFilterInput
}
CompanyReportReasonCode
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CREDIT_DECISION"
CompanySearch
Fields
Field Name | Description |
---|---|
id - Int
|
|
company_id - String
|
|
posc_summary - PoscSummary
|
|
rfa_rating - CompanyRating
|
|
rating_history - Rating_historyCollectionSegment
|
Rating history |
corporate_structure - [CorporateEntity]
|
|
ultimate_parent - CorporateEntity
|
Corporate Hierarchy |
ordered_rfa_rating - OrderedCompanyRating
|
|
addresses - [Address]
|
|
active_directors - [Director]
|
|
people - [Person]
|
|
gazette_notices - [GazetteNotice]
|
|
company_number - String
|
|
mortgages - [Mortgage]
|
|
country_code - CountryCode
|
|
archive - [CompanyArchive]
|
|
estimated_turnover - Decimal
|
|
estimated_employees - Int
|
|
employees - Long
|
|
turnover - Decimal
|
|
growth_score - Float
|
|
rfa_rating_score - Float
|
|
raw_rating_score - Float
|
|
incorporation_date - DateTime
|
|
dissolution_date - DateTime
|
|
dissolution_status - String
|
|
total_assets - Long
|
|
last_filed_accounts - DateTime
|
|
accounts_next_due - DateTime
|
|
tps_registered - Boolean
|
|
gdpr_registered - Boolean
|
|
marketing_preference - String
|
|
website - String
|
|
primary_sic07_code - String
|
|
revenue_increase - Long
|
|
creditor_days - Long
|
|
credit_score - Decimal
|
|
credit_limit - Decimal
|
|
sic92_sections - [String]
|
|
sic92_codes - [String]
|
|
sic92_descriptions - [String]
|
|
primary_sic92_code - String
|
|
sic07 - [SIC07]
|
|
sic07_codes - [String]
|
|
sic07_descriptions - [String]
|
|
sic07_sections - [String]
|
|
sic07_section_descriptions - [String]
|
|
sic07_divisions - [String]
|
|
sic07_division_descriptions - [String]
|
|
sic07_groups - [String]
|
|
sic07_group_descriptions - [String]
|
|
sic07_classes - [String]
|
|
sic07_class_descriptions - [String]
|
|
sic07_sub_classes - [String]
|
|
sic07_sub_class_descriptions - [String]
|
|
directors - [DirectorPartial]
|
|
director_summary - DirectorSummary
|
|
credit_limits - [CreditLimit]
|
|
oldest_director - Director
|
|
has_directorships - Boolean
|
|
has_financials - Boolean
|
|
is_limited - Boolean
|
|
is_trading - Boolean
|
|
company_name - String
|
|
legal_status - String
|
|
auditor - String
|
|
latest_action - Latest_Action
|
|
company_type - String
|
|
history - [History]
|
|
ccjs - [CCJ]
|
|
possible_ccjs - [CCJ]
|
|
processed_at - DateTime
|
|
last_updated - DateTime
|
|
parent_company - String
|
|
group_id - String
|
|
telephone_number - String
|
|
email - String
|
|
has_contact - Boolean
|
|
has_phone_contact - Boolean
|
|
has_email_contact - Boolean
|
|
generated_rfa_rating - RfaRating
|
|
previous_rfa_rating - RfaRating
|
|
rating_changed_date - DateTime
|
|
previous_rating_changed_date - DateTime
|
|
failure_probability - Decimal
|
|
current_directors - [Current_Directors]
|
|
profit_loss - [Profit_Loss]
|
|
balance_sheet - [Balance_Sheet]
|
|
creditors - [Creditor]
|
|
debtors - [Debtor]
|
|
detrimental_data - [DetrimentalData]
|
|
shareholders - [Shareholder]
|
|
poscs - [POSC]
|
|
former_names - [FormerName]
|
|
cashflow - [CashFlow]
|
|
ratio_analysis - [RatioAnalysis]
|
|
contacts - [Contact]
|
|
functional_currency - CurrencyCode
|
|
vat_number - String
|
|
beneficial_owners - [BeneficialOwner]
|
Example
{
"id": 987,
"company_id": "abc123",
"posc_summary": PoscSummary,
"rfa_rating": "THREE_RED_FLAGS",
"rating_history": Rating_historyCollectionSegment,
"corporate_structure": [CorporateEntity],
"ultimate_parent": CorporateEntity,
"ordered_rfa_rating": "BUSINESS_DISCONTINUED",
"addresses": [Address],
"active_directors": [Director],
"people": [Person],
"gazette_notices": [GazetteNotice],
"company_number": "xyz789",
"mortgages": [Mortgage],
"country_code": "AFG",
"archive": [CompanyArchive],
"estimated_turnover": Decimal,
"estimated_employees": 123,
"employees": {},
"turnover": Decimal,
"growth_score": 123.45,
"rfa_rating_score": 123.45,
"raw_rating_score": 987.65,
"incorporation_date": "2007-12-03T10:15:30Z",
"dissolution_date": "2007-12-03T10:15:30Z",
"dissolution_status": "xyz789",
"total_assets": {},
"last_filed_accounts": "2007-12-03T10:15:30Z",
"accounts_next_due": "2007-12-03T10:15:30Z",
"tps_registered": true,
"gdpr_registered": false,
"marketing_preference": "abc123",
"website": "xyz789",
"primary_sic07_code": "xyz789",
"revenue_increase": {},
"creditor_days": {},
"credit_score": Decimal,
"credit_limit": Decimal,
"sic92_sections": ["abc123"],
"sic92_codes": ["abc123"],
"sic92_descriptions": ["abc123"],
"primary_sic92_code": "abc123",
"sic07": [SIC07],
"sic07_codes": ["abc123"],
"sic07_descriptions": ["abc123"],
"sic07_sections": ["abc123"],
"sic07_section_descriptions": ["xyz789"],
"sic07_divisions": ["abc123"],
"sic07_division_descriptions": ["xyz789"],
"sic07_groups": ["xyz789"],
"sic07_group_descriptions": ["xyz789"],
"sic07_classes": ["xyz789"],
"sic07_class_descriptions": ["abc123"],
"sic07_sub_classes": ["abc123"],
"sic07_sub_class_descriptions": [
"abc123"
],
"directors": [DirectorPartial],
"director_summary": DirectorSummary,
"credit_limits": [CreditLimit],
"oldest_director": Director,
"has_directorships": true,
"has_financials": true,
"is_limited": true,
"is_trading": false,
"company_name": "abc123",
"legal_status": "xyz789",
"auditor": "xyz789",
"latest_action": Latest_Action,
"company_type": "xyz789",
"history": [History],
"ccjs": [CCJ],
"possible_ccjs": [CCJ],
"processed_at": "2007-12-03T10:15:30Z",
"last_updated": "2007-12-03T10:15:30Z",
"parent_company": "xyz789",
"group_id": "abc123",
"telephone_number": "xyz789",
"email": "abc123",
"has_contact": false,
"has_phone_contact": false,
"has_email_contact": true,
"generated_rfa_rating": "THREE_RED_FLAGS",
"previous_rfa_rating": "THREE_RED_FLAGS",
"rating_changed_date": "2007-12-03T10:15:30Z",
"previous_rating_changed_date": "2007-12-03T10:15:30Z",
"failure_probability": Decimal,
"current_directors": [Current_Directors],
"profit_loss": [Profit_Loss],
"balance_sheet": [Balance_Sheet],
"creditors": [Creditor],
"debtors": [Debtor],
"detrimental_data": [DetrimentalData],
"shareholders": [Shareholder],
"poscs": [POSC],
"former_names": [FormerName],
"cashflow": [CashFlow],
"ratio_analysis": [RatioAnalysis],
"contacts": [Contact],
"functional_currency": "AED",
"vat_number": "abc123",
"beneficial_owners": [BeneficialOwner]
}
CompanySearchFilterInput
Fields
Example
{
"and": [CompanySearchFilterInput],
"or": [CompanySearchFilterInput],
"country_code": NullableOfCountryCodeOperationFilterInput,
"archive_id": StringOperationFilterInput,
"archive": ListFilterInputTypeOfCompanyArchiveFilterInput,
"report_source": SourceKeyOperationFilterInput,
"id": IntOperationFilterInput,
"relevance": FloatOperationFilterInput,
"company_id": StringOperationFilterInput,
"estimated_turnover": DecimalOperationFilterInput,
"estimated_employees": IntOperationFilterInput,
"employees": LongOperationFilterInput,
"turnover": DecimalOperationFilterInput,
"growth_score": FloatOperationFilterInput,
"rfa_rating_summary": StringOperationFilterInput,
"rfa_rating_score": FloatOperationFilterInput,
"raw_rating_score": FloatOperationFilterInput,
"company_number": StringOperationFilterInput,
"incorporation_date": DateTimeOperationFilterInput,
"dissolution_date": DateTimeOperationFilterInput,
"dissolution_status": StringOperationFilterInput,
"total_assets": LongOperationFilterInput,
"last_filed_accounts": DateTimeOperationFilterInput,
"accounts_next_due": DateTimeOperationFilterInput,
"tps_registered": BooleanOperationFilterInput,
"gdpr_registered": BooleanOperationFilterInput,
"marketing_preference": StringOperationFilterInput,
"website": StringOperationFilterInput,
"primary_sic07_code": StringOperationFilterInput,
"revenue_increase": LongOperationFilterInput,
"creditor_days": LongOperationFilterInput,
"credit_score": DecimalOperationFilterInput,
"credit_limit": DecimalOperationFilterInput,
"sic92_sections": ListStringOperationFilterInput,
"sic92_codes": ListStringOperationFilterInput,
"sic92_descriptions": ListStringOperationFilterInput,
"primary_sic92_code": StringOperationFilterInput,
"sic07": ListFilterInputTypeOfSIC07FilterInput,
"sic07_codes": ListStringOperationFilterInput,
"sic07_descriptions": ListStringOperationFilterInput,
"sic07_sections": ListStringOperationFilterInput,
"sic07_section_descriptions": ListStringOperationFilterInput,
"sic07_divisions": ListStringOperationFilterInput,
"sic07_division_descriptions": ListStringOperationFilterInput,
"sic07_groups": ListStringOperationFilterInput,
"sic07_group_descriptions": ListStringOperationFilterInput,
"sic07_classes": ListStringOperationFilterInput,
"sic07_class_descriptions": ListStringOperationFilterInput,
"sic07_sub_classes": ListStringOperationFilterInput,
"sic07_sub_class_descriptions": ListStringOperationFilterInput,
"people": ListFilterInputTypeOfPersonFilterInput,
"active_directors": ListFilterInputTypeOfDirectorFilterInput,
"directors": ListFilterInputTypeOfDirectorPartialFilterInput,
"director_summary": DirectorSummaryFilterInput,
"credit_limits": ListFilterInputTypeOfCreditLimitFilterInput,
"oldest_director": DirectorFilterInput,
"has_directorships": BooleanOperationFilterInput,
"has_financials": BooleanOperationFilterInput,
"is_limited": BooleanOperationFilterInput,
"is_trading": BooleanOperationFilterInput,
"addresses": ListFilterInputTypeOfAddressFilterInput,
"company_name": StringOperationFilterInput,
"legal_status": StringOperationFilterInput,
"auditor": StringOperationFilterInput,
"duns_number": StringOperationFilterInput,
"latest_action": Latest_ActionFilterInput,
"company_type": StringOperationFilterInput,
"mortgages": ListFilterInputTypeOfMortgageFilterInput,
"history": ListFilterInputTypeOfHistoryFilterInput,
"gazette_notices": ListFilterInputTypeOfGazetteNoticeFilterInput,
"ccjs": ListFilterInputTypeOfCCJFilterInput,
"possible_ccjs": ListFilterInputTypeOfCCJFilterInput,
"processed_at": DateTimeOperationFilterInput,
"last_updated": DateTimeOperationFilterInput,
"parent_company": StringOperationFilterInput,
"group_id": StringOperationFilterInput,
"telephone_number": StringOperationFilterInput,
"email": StringOperationFilterInput,
"has_contact": BooleanOperationFilterInput,
"has_phone_contact": BooleanOperationFilterInput,
"has_email_contact": BooleanOperationFilterInput,
"rfa_rating": NullableOfCompanyRatingOperationFilterInput,
"generated_rfa_rating": NullableOfRfaRatingOperationFilterInput,
"previous_rfa_rating": NullableOfRfaRatingOperationFilterInput,
"rating_changed_date": DateTimeOperationFilterInput,
"previous_rating_changed_date": DateTimeOperationFilterInput,
"failure_probability": DecimalOperationFilterInput,
"ordered_rfa_rating": NullableOfOrderedCompanyRatingOperationFilterInput,
"current_directors": ListFilterInputTypeOfCurrent_DirectorsFilterInput,
"profit_loss": ListFilterInputTypeOfProfit_LossFilterInput,
"balance_sheet": ListFilterInputTypeOfBalance_SheetFilterInput,
"corporate_structure": ListFilterInputTypeOfCorporateEntityFilterInput,
"creditors": ListFilterInputTypeOfCreditorFilterInput,
"debtors": ListFilterInputTypeOfDebtorFilterInput,
"detrimental_data": ListFilterInputTypeOfDetrimentalDataFilterInput,
"shareholders": ListFilterInputTypeOfShareholderFilterInput,
"poscs": ListFilterInputTypeOfPOSCFilterInput,
"former_names": ListFilterInputTypeOfFormerNameFilterInput,
"cashflow": ListFilterInputTypeOfCashFlowFilterInput,
"ratio_analysis": ListFilterInputTypeOfRatioAnalysisFilterInput,
"contacts": ListFilterInputTypeOfContactFilterInput,
"functional_currency": NullableOfCurrencyCodeOperationFilterInput,
"vat_number": StringOperationFilterInput,
"beneficial_owner_graph": BeneficialOwnerGraphFilterInput,
"beneficial_owners": ListFilterInputTypeOfBeneficialOwnerFilterInput
}
ComplyAdvantageSearchFilterInput
Fields
Input Field | Description |
---|---|
and - [ComplyAdvantageSearchFilterInput!]
|
|
or - [ComplyAdvantageSearchFilterInput!]
|
|
checkId - IntOperationFilterInput
|
|
searchId - IntOperationFilterInput
|
|
isMonitored - BooleanOperationFilterInput
|
|
check - CheckFilterInput
|
Example
{
"and": [ComplyAdvantageSearchFilterInput],
"or": [ComplyAdvantageSearchFilterInput],
"checkId": IntOperationFilterInput,
"searchId": IntOperationFilterInput,
"isMonitored": BooleanOperationFilterInput,
"check": CheckFilterInput
}
ComplyAdvantageSearchSortInput
Fields
Input Field | Description |
---|---|
checkId - SortEnumType
|
|
searchId - SortEnumType
|
|
isMonitored - SortEnumType
|
|
check - CheckSortInput
|
Example
{
"checkId": "ASC",
"searchId": "ASC",
"isMonitored": "ASC",
"check": CheckSortInput
}
Contact
ContactFilterInput
Fields
Input Field | Description |
---|---|
and - [ContactFilterInput!]
|
|
or - [ContactFilterInput!]
|
|
email_address - StringOperationFilterInput
|
|
telephone_number - StringOperationFilterInput
|
Example
{
"and": [ContactFilterInput],
"or": [ContactFilterInput],
"email_address": StringOperationFilterInput,
"telephone_number": StringOperationFilterInput
}
CorporateEntity
Example
{
"id": "abc123",
"company_id": {},
"company_number": "xyz789",
"company_name": "abc123",
"level": 987,
"parent": "xyz789",
"ultimate_parent": "abc123",
"country": "xyz789",
"company": CompanySearch
}
CorporateEntityFilterInput
Fields
Input Field | Description |
---|---|
and - [CorporateEntityFilterInput!]
|
|
or - [CorporateEntityFilterInput!]
|
|
id - StringOperationFilterInput
|
|
company_id - LongOperationFilterInput
|
|
company_number - StringOperationFilterInput
|
|
company_name - StringOperationFilterInput
|
|
level - IntOperationFilterInput
|
|
parent - StringOperationFilterInput
|
|
ultimate_parent - StringOperationFilterInput
|
|
country - StringOperationFilterInput
|
Example
{
"and": [CorporateEntityFilterInput],
"or": [CorporateEntityFilterInput],
"id": StringOperationFilterInput,
"company_id": LongOperationFilterInput,
"company_number": StringOperationFilterInput,
"company_name": StringOperationFilterInput,
"level": IntOperationFilterInput,
"parent": StringOperationFilterInput,
"ultimate_parent": StringOperationFilterInput,
"country": StringOperationFilterInput
}
CountryCode
Description
Country codes.
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFG"
CountryCodeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - account_CountryCode
|
|
neq - account_CountryCode
|
|
in - [account_CountryCode!]
|
|
nin - [account_CountryCode!]
|
Example
{"eq": "AFG", "neq": "AFG", "in": ["AFG"], "nin": ["AFG"]}
CreditLimit
CreditLimitFilterInput
Fields
Input Field | Description |
---|---|
and - [CreditLimitFilterInput!]
|
|
or - [CreditLimitFilterInput!]
|
|
companyId - IntOperationFilterInput
|
|
credit_limit - DecimalOperationFilterInput
|
|
currency - StringOperationFilterInput
|
|
published_date - DateTimeOperationFilterInput
|
Example
{
"and": [CreditLimitFilterInput],
"or": [CreditLimitFilterInput],
"companyId": IntOperationFilterInput,
"credit_limit": DecimalOperationFilterInput,
"currency": StringOperationFilterInput,
"published_date": DateTimeOperationFilterInput
}
Creditor
Example
{
"status": "abc123",
"amount": Decimal,
"address": "abc123",
"company_name": "xyz789",
"company_number": "abc123",
"statement_date": "2007-12-03T10:15:30Z",
"insolvency_practitioners": ["abc123"],
"upload_date": "2007-12-03T10:15:30Z",
"company_id": 987
}
CreditorFilterInput
Fields
Input Field | Description |
---|---|
and - [CreditorFilterInput!]
|
|
or - [CreditorFilterInput!]
|
|
status - StringOperationFilterInput
|
|
amount - DecimalOperationFilterInput
|
|
address - StringOperationFilterInput
|
|
company_name - StringOperationFilterInput
|
|
company_number - StringOperationFilterInput
|
|
statement_date - DateTimeOperationFilterInput
|
|
insolvency_practitioners - ListStringOperationFilterInput
|
|
upload_date - DateTimeOperationFilterInput
|
|
company_id - IntOperationFilterInput
|
Example
{
"and": [CreditorFilterInput],
"or": [CreditorFilterInput],
"status": StringOperationFilterInput,
"amount": DecimalOperationFilterInput,
"address": StringOperationFilterInput,
"company_name": StringOperationFilterInput,
"company_number": StringOperationFilterInput,
"statement_date": DateTimeOperationFilterInput,
"insolvency_practitioners": ListStringOperationFilterInput,
"upload_date": DateTimeOperationFilterInput,
"company_id": IntOperationFilterInput
}
CurrencyCode
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AED"
Current_Directors
Fields
Field Name | Description |
---|---|
birthdate - DateTime
|
Example
{"birthdate": "2007-12-03T10:15:30Z"}
Current_DirectorsFilterInput
Fields
Input Field | Description |
---|---|
and - [Current_DirectorsFilterInput!]
|
|
or - [Current_DirectorsFilterInput!]
|
|
birthdate - DateTimeOperationFilterInput
|
Example
{
"and": [Current_DirectorsFilterInput],
"or": [Current_DirectorsFilterInput],
"birthdate": DateTimeOperationFilterInput
}
Date
Description
The Date
scalar represents an ISO-8601 compliant date type.
Example
"2007-12-03"
DateTime
Description
The DateTime
scalar represents an ISO-8601 compliant date time type.
Example
"2007-12-03T10:15:30Z"
DateTimeAfterInput
DateTimeBeforeInput
DateTimeOperationFilterInput
Fields
Input Field | Description |
---|---|
after - DateTimeAfterInput
|
|
before - DateTimeBeforeInput
|
|
eq - DateTime
|
|
neq - DateTime
|
|
in - [DateTime]
|
|
nin - [DateTime]
|
|
gt - DateTime
|
|
ngt - DateTime
|
|
gte - DateTime
|
|
ngte - DateTime
|
|
lt - DateTime
|
|
nlt - DateTime
|
|
lte - DateTime
|
|
nlte - DateTime
|
Example
{
"after": DateTimeAfterInput,
"before": DateTimeBeforeInput,
"eq": "2007-12-03T10:15:30Z",
"neq": "2007-12-03T10:15:30Z",
"in": ["2007-12-03T10:15:30Z"],
"nin": ["2007-12-03T10:15:30Z"],
"gt": "2007-12-03T10:15:30Z",
"ngt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"ngte": "2007-12-03T10:15:30Z",
"lt": "2007-12-03T10:15:30Z",
"nlt": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z",
"nlte": "2007-12-03T10:15:30Z"
}
Debtor
Example
{
"status": "abc123",
"amount": Decimal,
"address": "xyz789",
"company_name": "xyz789",
"company_number": "xyz789",
"statement_date": "2007-12-03T10:15:30Z",
"insolvency_practitioners": ["abc123"],
"upload_date": "2007-12-03T10:15:30Z",
"company_id": 123
}
DebtorFilterInput
Fields
Input Field | Description |
---|---|
and - [DebtorFilterInput!]
|
|
or - [DebtorFilterInput!]
|
|
status - StringOperationFilterInput
|
|
amount - DecimalOperationFilterInput
|
|
address - StringOperationFilterInput
|
|
company_name - StringOperationFilterInput
|
|
company_number - StringOperationFilterInput
|
|
statement_date - DateTimeOperationFilterInput
|
|
insolvency_practitioners - ListStringOperationFilterInput
|
|
upload_date - DateTimeOperationFilterInput
|
|
company_id - IntOperationFilterInput
|
Example
{
"and": [DebtorFilterInput],
"or": [DebtorFilterInput],
"status": StringOperationFilterInput,
"amount": DecimalOperationFilterInput,
"address": StringOperationFilterInput,
"company_name": StringOperationFilterInput,
"company_number": StringOperationFilterInput,
"statement_date": DateTimeOperationFilterInput,
"insolvency_practitioners": ListStringOperationFilterInput,
"upload_date": DateTimeOperationFilterInput,
"company_id": IntOperationFilterInput
}
Decimal
Description
The built-in Decimal
scalar type.
Example
Decimal
DecimalOperationFilterInput
Example
{
"eq": Decimal,
"neq": Decimal,
"in": [Decimal],
"nin": [Decimal],
"gt": Decimal,
"ngt": Decimal,
"gte": Decimal,
"ngte": Decimal,
"lt": Decimal,
"nlt": Decimal,
"lte": Decimal,
"nlte": Decimal
}
DetrimentalData
DetrimentalDataFilterInput
Fields
Input Field | Description |
---|---|
and - [DetrimentalDataFilterInput!]
|
|
or - [DetrimentalDataFilterInput!]
|
|
event_date - DateTimeOperationFilterInput
|
|
type_short - StringOperationFilterInput
|
|
type_long - StringOperationFilterInput
|
|
event_text - StringOperationFilterInput
|
Example
{
"and": [DetrimentalDataFilterInput],
"or": [DetrimentalDataFilterInput],
"event_date": DateTimeOperationFilterInput,
"type_short": StringOperationFilterInput,
"type_long": StringOperationFilterInput,
"event_text": StringOperationFilterInput
}
DigitalCheckDetail
Description
Detail about user being checked
Fields
Field Name | Description |
---|---|
checkId - Int!
|
AML Check Unique ID |
id - String
|
Check detail Id |
email - String
|
Email of user being checked |
firstName - String
|
First name of user being checked |
middleName - String
|
Middle name of user being checked |
lastName - String
|
Last name of user being checked |
dateOfBirth - DateTime
|
Last name of user being checked |
mobileNumber - String
|
Mobile number user being checked |
countryOfResidence - account_CountryCode!
|
ISO Alpha-3 Country of Residence |
identityDocuments - [CheckDetailIdentityDocument]
|
Identity documents provided (passport, driving license, national insurance) |
addresses - [CheckDetailAddress]
|
Addresses provided to check |
Example
{
"checkId": 123,
"id": "abc123",
"email": "xyz789",
"firstName": "xyz789",
"middleName": "xyz789",
"lastName": "xyz789",
"dateOfBirth": "2007-12-03T10:15:30Z",
"mobileNumber": "xyz789",
"countryOfResidence": "AFG",
"identityDocuments": [CheckDetailIdentityDocument],
"addresses": [CheckDetailAddress]
}
Director
Fields
Field Name | Description |
---|---|
id - String
|
|
person_id - String
|
|
appointments - [Director]
|
|
source - SourceKey!
|
|
is_current - Boolean!
|
|
appointment - CompanyAppointmentType!
|
|
company_name - String
|
|
rfa_rating - CompanyRating!
|
|
first_name - String
|
|
surname - String
|
|
nationality - String
|
|
town - String
|
|
county - String
|
|
postcode - String
|
|
occupation - String
|
|
locality - String
|
|
address - String
|
|
title - String
|
|
appointment_type - String
|
|
birthdate - DateTime
|
|
date_appointed - DateTime
|
|
date_resigned - DateTime
|
|
other_appointments - String
|
|
company - String
|
|
companyId - Long!
|
|
company_id - Long!
|
Example
{
"id": "xyz789",
"person_id": "abc123",
"appointments": [Director],
"source": "RFA",
"is_current": true,
"appointment": "UNKNOWN",
"company_name": "xyz789",
"rfa_rating": "THREE_RED_FLAGS",
"first_name": "xyz789",
"surname": "xyz789",
"nationality": "xyz789",
"town": "xyz789",
"county": "abc123",
"postcode": "abc123",
"occupation": "xyz789",
"locality": "xyz789",
"address": "xyz789",
"title": "abc123",
"appointment_type": "xyz789",
"birthdate": "2007-12-03T10:15:30Z",
"date_appointed": "2007-12-03T10:15:30Z",
"date_resigned": "2007-12-03T10:15:30Z",
"other_appointments": "abc123",
"company": "xyz789",
"companyId": {},
"company_id": {}
}
DirectorFilterInput
Fields
Example
{
"and": [DirectorFilterInput],
"or": [DirectorFilterInput],
"source": SourceKeyOperationFilterInput,
"is_current": BooleanOperationFilterInput,
"appointment": CompanyAppointmentTypeOperationFilterInput,
"company_name": StringOperationFilterInput,
"rfa_rating": CompanyRatingOperationFilterInput,
"first_name": StringOperationFilterInput,
"surname": StringOperationFilterInput,
"nationality": StringOperationFilterInput,
"town": StringOperationFilterInput,
"county": StringOperationFilterInput,
"postcode": StringOperationFilterInput,
"occupation": StringOperationFilterInput,
"locality": StringOperationFilterInput,
"address": StringOperationFilterInput,
"title": StringOperationFilterInput,
"appointment_type": StringOperationFilterInput,
"birthdate": DateTimeOperationFilterInput,
"date_appointed": DateTimeOperationFilterInput,
"date_resigned": DateTimeOperationFilterInput,
"other_appointments": StringOperationFilterInput,
"person_id": StringOperationFilterInput,
"company": StringOperationFilterInput,
"companyId": LongOperationFilterInput,
"company_id": LongOperationFilterInput,
"id": StringOperationFilterInput
}
DirectorPartial
Example
{
"age_years": 987,
"appointment_duration_years": 123,
"title": "UNKNOWN",
"occupation": "xyz789",
"nationalities": ["abc123"],
"nationalities_iso3": ["abc123"]
}
DirectorPartialFilterInput
Fields
Input Field | Description |
---|---|
and - [DirectorPartialFilterInput!]
|
|
or - [DirectorPartialFilterInput!]
|
|
age_years - IntOperationFilterInput
|
|
appointment_duration_years - IntOperationFilterInput
|
|
title - HonorificOperationFilterInput
|
|
occupation - StringOperationFilterInput
|
|
nationalities - ListStringOperationFilterInput
|
|
nationalities_iso3 - ListStringOperationFilterInput
|
Example
{
"and": [DirectorPartialFilterInput],
"or": [DirectorPartialFilterInput],
"age_years": IntOperationFilterInput,
"appointment_duration_years": IntOperationFilterInput,
"title": HonorificOperationFilterInput,
"occupation": StringOperationFilterInput,
"nationalities": ListStringOperationFilterInput,
"nationalities_iso3": ListStringOperationFilterInput
}
DirectorPerson
Fields
Field Name | Description |
---|---|
company_number - String
|
|
appointment_type - AppointmentType
|
|
person_id - String
|
|
is_corporate - Boolean
|
|
appointment_date - Date
|
|
resignation_date - Date
|
|
company - CompanySearch
|
Example
{
"company_number": "xyz789",
"appointment_type": "CURRENT_SECRETARY",
"person_id": "abc123",
"is_corporate": true,
"appointment_date": "2007-12-03",
"resignation_date": "2007-12-03",
"company": CompanySearch
}
DirectorPersonFilterInput
Fields
Input Field | Description |
---|---|
and - [DirectorPersonFilterInput!]
|
|
or - [DirectorPersonFilterInput!]
|
|
company_number - StringOperationFilterInput
|
|
appointment_type - AppointmentTypeOperationFilterInput
|
|
person_id - StringOperationFilterInput
|
|
is_corporate - BooleanOperationFilterInput
|
|
appointment_date - DateTimeOperationFilterInput
|
|
resignation_date - DateTimeOperationFilterInput
|
Example
{
"and": [DirectorPersonFilterInput],
"or": [DirectorPersonFilterInput],
"company_number": StringOperationFilterInput,
"appointment_type": AppointmentTypeOperationFilterInput,
"person_id": StringOperationFilterInput,
"is_corporate": BooleanOperationFilterInput,
"appointment_date": DateTimeOperationFilterInput,
"resignation_date": DateTimeOperationFilterInput
}
DirectorSummary
DirectorSummaryFilterInput
Fields
Input Field | Description |
---|---|
and - [DirectorSummaryFilterInput!]
|
|
or - [DirectorSummaryFilterInput!]
|
|
total_current - IntOperationFilterInput
|
|
total_previous - IntOperationFilterInput
|
Example
{
"and": [DirectorSummaryFilterInput],
"or": [DirectorSummaryFilterInput],
"total_current": IntOperationFilterInput,
"total_previous": IntOperationFilterInput
}
DocumentField
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIRST_NAME"
DocumentFieldOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - DocumentField
|
|
neq - DocumentField
|
|
in - [DocumentField!]
|
|
nin - [DocumentField!]
|
Example
{
"eq": "FIRST_NAME",
"neq": "FIRST_NAME",
"in": ["FIRST_NAME"],
"nin": ["FIRST_NAME"]
}
EmailConfigurationFilterInput
Fields
Input Field | Description |
---|---|
and - [EmailConfigurationFilterInput!]
|
|
or - [EmailConfigurationFilterInput!]
|
|
accountId - StringOperationFilterInput
|
|
subject - StringOperationFilterInput
|
|
template - StringOperationFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [EmailConfigurationFilterInput],
"or": [EmailConfigurationFilterInput],
"accountId": StringOperationFilterInput,
"subject": StringOperationFilterInput,
"template": StringOperationFilterInput,
"account": AccountFilterInput
}
EmailConfigurationSortInput
Fields
Input Field | Description |
---|---|
accountId - SortEnumType
|
|
subject - SortEnumType
|
|
template - SortEnumType
|
|
account - AccountSortInput
|
Example
{
"accountId": "ASC",
"subject": "ASC",
"template": "ASC",
"account": AccountSortInput
}
Event
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUSINESS_ADDRESS_AMENDED"
EventOperationFilterInput
EventType
EventTypeFilterInput
Fields
Input Field | Description |
---|---|
and - [EventTypeFilterInput!]
|
|
or - [EventTypeFilterInput!]
|
|
id - EventOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
supportedPortfolioType - PortfolioTypeOperationFilterInput
|
|
triggerEvent - ListFilterInputTypeOfTriggerEventFilterInput
|
|
portfolioEvent - ListFilterInputTypeOfPortfolioEventFilterInput
|
Example
{
"and": [EventTypeFilterInput],
"or": [EventTypeFilterInput],
"id": EventOperationFilterInput,
"name": StringOperationFilterInput,
"description": StringOperationFilterInput,
"supportedPortfolioType": PortfolioTypeOperationFilterInput,
"triggerEvent": ListFilterInputTypeOfTriggerEventFilterInput,
"portfolioEvent": ListFilterInputTypeOfPortfolioEventFilterInput
}
EventTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - company_EventType
|
|
neq - company_EventType
|
|
in - [company_EventType!]
|
|
nin - [company_EventType!]
|
Example
{"eq": "NA", "neq": "NA", "in": ["NA"], "nin": ["NA"]}
EventTypeSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
name - SortEnumType
|
|
description - SortEnumType
|
|
supportedPortfolioType - SortEnumType
|
Example
{
"id": "ASC",
"name": "ASC",
"description": "ASC",
"supportedPortfolioType": "ASC"
}
FileExportFilterInput
Fields
Example
{
"and": [FileExportFilterInput],
"or": [FileExportFilterInput],
"id": StringOperationFilterInput,
"legacyId": StringOperationFilterInput,
"apiQuery": StringOperationFilterInput,
"variables": StringOperationFilterInput,
"accountId": StringOperationFilterInput,
"userEmail": StringOperationFilterInput,
"fileLocation": StringOperationFilterInput,
"columnMappings": StringOperationFilterInput,
"rowCount": IntOperationFilterInput,
"etaSeconds": IntOperationFilterInput,
"totalResults": IntOperationFilterInput,
"columnSelection": NullableOfFileExportSelectionTypeOperationFilterInput,
"resultSelection": NullableOfFileExportSelectionTypeOperationFilterInput,
"status": FileExportStatusOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"completedDate": portfolio_DateTimeOperationFilterInput,
"timestamp": portfolio_DateTimeOperationFilterInput,
"acknowledged": BooleanOperationFilterInput,
"csvExportLimit": IntOperationFilterInput,
"queryName": StringOperationFilterInput,
"fieldType": StringOperationFilterInput,
"exportType": FileExportRequestTypeOperationFilterInput,
"description": StringOperationFilterInput,
"relativePath": StringOperationFilterInput,
"isCancelled": BooleanOperationFilterInput,
"isScheduledExport": BooleanOperationFilterInput,
"exportReference": StringOperationFilterInput,
"meta": FileExportMetaFilterInput
}
FileExportMetaFilterInput
Fields
Input Field | Description |
---|---|
and - [FileExportMetaFilterInput!]
|
|
or - [FileExportMetaFilterInput!]
|
|
pdf - PDFMetaFilterInput
|
Example
{
"and": [FileExportMetaFilterInput],
"or": [FileExportMetaFilterInput],
"pdf": PDFMetaFilterInput
}
FileExportRequestType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"CSV"
FileExportRequestTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - FileExportRequestType
|
|
neq - FileExportRequestType
|
|
in - [FileExportRequestType!]
|
|
nin - [FileExportRequestType!]
|
Example
{"eq": "CSV", "neq": "CSV", "in": ["CSV"], "nin": ["CSV"]}
FileExportSelectionType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"ALL_COLUMNS"
FileExportStatus
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"REQUESTED"
FileExportStatusOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - FileExportStatus
|
|
neq - FileExportStatus
|
|
in - [FileExportStatus!]
|
|
nin - [FileExportStatus!]
|
Example
{
"eq": "REQUESTED",
"neq": "REQUESTED",
"in": ["REQUESTED"],
"nin": ["REQUESTED"]
}
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
987.65
FloatOperationFilterInput
Example
{
"eq": 987.65,
"neq": 123.45,
"in": [123.45],
"nin": [987.65],
"gt": 987.65,
"ngt": 123.45,
"gte": 123.45,
"ngte": 123.45,
"lt": 987.65,
"nlt": 123.45,
"lte": 123.45,
"nlte": 987.65
}
FormerName
FormerNameFilterInput
Fields
Input Field | Description |
---|---|
and - [FormerNameFilterInput!]
|
|
or - [FormerNameFilterInput!]
|
|
name - StringOperationFilterInput
|
|
date_from - DateTimeOperationFilterInput
|
|
date_to - DateTimeOperationFilterInput
|
Example
{
"and": [FormerNameFilterInput],
"or": [FormerNameFilterInput],
"name": StringOperationFilterInput,
"date_from": DateTimeOperationFilterInput,
"date_to": DateTimeOperationFilterInput
}
GazetteNotice
Description
Company Gazette notice
Fields
Field Name | Description |
---|---|
published_date - DateTime!
|
Date notice was published. |
created_date - DateTime!
|
Date notice created in RFA system |
notice_code_value - String
|
Notice code value. For more information: https://www.thegazette.co.uk/noticecodes |
notice_code_name - NoticeCodeType!
|
Description of notice code. For more information: https://www.thegazette.co.uk/noticecodes |
notice_id - String
|
Description of notice code. For more information: https://www.thegazette.co.uk/noticecodes |
uri - String
|
Uri for the notice. All notices: https://www.thegazette.co.uk/all-notices/notice |
Example
{
"published_date": "2007-12-03T10:15:30Z",
"created_date": "2007-12-03T10:15:30Z",
"notice_code_value": "abc123",
"notice_code_name": "UNKNOWN",
"notice_id": "abc123",
"uri": "abc123"
}
GazetteNoticeFilterInput
Fields
Input Field | Description |
---|---|
and - [GazetteNoticeFilterInput!]
|
|
or - [GazetteNoticeFilterInput!]
|
|
companyId - IntOperationFilterInput
|
|
published_date - DateTimeOperationFilterInput
|
|
created_date - DateTimeOperationFilterInput
|
|
notice_code_value - StringOperationFilterInput
|
|
notice_code_name - NoticeCodeTypeOperationFilterInput
|
|
uri - StringOperationFilterInput
|
|
notice_id - StringOperationFilterInput
|
|
source - StringOperationFilterInput
|
Example
{
"and": [GazetteNoticeFilterInput],
"or": [GazetteNoticeFilterInput],
"companyId": IntOperationFilterInput,
"published_date": DateTimeOperationFilterInput,
"created_date": DateTimeOperationFilterInput,
"notice_code_value": StringOperationFilterInput,
"notice_code_name": NoticeCodeTypeOperationFilterInput,
"uri": StringOperationFilterInput,
"notice_id": StringOperationFilterInput,
"source": StringOperationFilterInput
}
GbGConfiguration
Example
{
"username": "xyz789",
"password": "abc123",
"dataProtectionNumber": "xyz789",
"enabled": true,
"profileConfigurations": [GbgProfileConfiguration],
"accountId": "xyz789",
"account": Account
}
GbGConfigurationFilterInput
Fields
Input Field | Description |
---|---|
and - [GbGConfigurationFilterInput!]
|
|
or - [GbGConfigurationFilterInput!]
|
|
accountId - StringOperationFilterInput
|
|
username - StringOperationFilterInput
|
|
password - StringOperationFilterInput
|
|
dataProtectionNumber - StringOperationFilterInput
|
|
enabled - BooleanOperationFilterInput
|
|
profileConfigurations - ListFilterInputTypeOfGbgProfileConfigurationFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [GbGConfigurationFilterInput],
"or": [GbGConfigurationFilterInput],
"accountId": StringOperationFilterInput,
"username": StringOperationFilterInput,
"password": StringOperationFilterInput,
"dataProtectionNumber": StringOperationFilterInput,
"enabled": BooleanOperationFilterInput,
"profileConfigurations": ListFilterInputTypeOfGbgProfileConfigurationFilterInput,
"account": AccountFilterInput
}
GbGConfigurationSortInput
Fields
Input Field | Description |
---|---|
accountId - SortEnumType
|
|
username - SortEnumType
|
|
password - SortEnumType
|
|
dataProtectionNumber - SortEnumType
|
|
enabled - SortEnumType
|
|
account - AccountSortInput
|
Example
{
"accountId": "ASC",
"username": "ASC",
"password": "ASC",
"dataProtectionNumber": "ASC",
"enabled": "ASC",
"account": AccountSortInput
}
GbgProfileConfiguration
Fields
Field Name | Description |
---|---|
countryCode - account_CountryCode!
|
|
profileId - String
|
|
profileType - GbgProfileType!
|
|
accountId - String
|
|
gbgConfiguration - GbGConfiguration
|
Example
{
"countryCode": "AFG",
"profileId": "abc123",
"profileType": "AML",
"accountId": "abc123",
"gbgConfiguration": GbGConfiguration
}
GbgProfileConfigurationFilterInput
Fields
Input Field | Description |
---|---|
and - [GbgProfileConfigurationFilterInput!]
|
|
or - [GbgProfileConfigurationFilterInput!]
|
|
accountId - StringOperationFilterInput
|
|
profileId - StringOperationFilterInput
|
|
profileType - GbgProfileTypeOperationFilterInput
|
|
countryCode - CountryCodeOperationFilterInput
|
|
gbgConfiguration - GbGConfigurationFilterInput
|
Example
{
"and": [GbgProfileConfigurationFilterInput],
"or": [GbgProfileConfigurationFilterInput],
"accountId": StringOperationFilterInput,
"profileId": StringOperationFilterInput,
"profileType": GbgProfileTypeOperationFilterInput,
"countryCode": CountryCodeOperationFilterInput,
"gbgConfiguration": GbGConfigurationFilterInput
}
GbgProfileType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"AML"
GbgProfileTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - GbgProfileType
|
|
neq - GbgProfileType
|
|
in - [GbgProfileType!]
|
|
nin - [GbgProfileType!]
|
Example
{"eq": "AML", "neq": "AML", "in": ["AML"], "nin": ["AML"]}
History
Description
Company History notice
Fields
Field Name | Description |
---|---|
event_type - company_EventType!
|
|
company_id - Int!
|
|
description - String
|
|
published_date - DateTime!
|
|
id - String!
|
|
rating - CompanyRating
|
|
score - Float
|
|
case_number - String
|
|
case_title_company_name - String
|
|
case_type - String
|
|
source - String
|
|
filed_date - DateTime
|
|
company - CompanySearch
|
Example
{
"event_type": "NA",
"company_id": 987,
"description": "xyz789",
"published_date": "2007-12-03T10:15:30Z",
"id": "abc123",
"rating": "THREE_RED_FLAGS",
"score": 123.45,
"case_number": "xyz789",
"case_title_company_name": "xyz789",
"case_type": "abc123",
"source": "xyz789",
"filed_date": "2007-12-03T10:15:30Z",
"company": CompanySearch
}
HistoryFilterInput
Fields
Input Field | Description |
---|---|
and - [HistoryFilterInput!]
|
|
or - [HistoryFilterInput!]
|
|
id - StringOperationFilterInput
|
|
rating - NullableOfCompanyRatingOperationFilterInput
|
|
company_id - IntOperationFilterInput
|
|
event_type - EventTypeOperationFilterInput
|
|
published_date - DateTimeOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
score - FloatOperationFilterInput
|
|
delete_event - BooleanOperationFilterInput
|
|
case_number - StringOperationFilterInput
|
|
case_title_company_name - StringOperationFilterInput
|
|
case_type - StringOperationFilterInput
|
|
source - StringOperationFilterInput
|
|
filed_date - DateTimeOperationFilterInput
|
Example
{
"and": [HistoryFilterInput],
"or": [HistoryFilterInput],
"id": StringOperationFilterInput,
"rating": NullableOfCompanyRatingOperationFilterInput,
"company_id": IntOperationFilterInput,
"event_type": EventTypeOperationFilterInput,
"published_date": DateTimeOperationFilterInput,
"description": StringOperationFilterInput,
"score": FloatOperationFilterInput,
"delete_event": BooleanOperationFilterInput,
"case_number": StringOperationFilterInput,
"case_title_company_name": StringOperationFilterInput,
"case_type": StringOperationFilterInput,
"source": StringOperationFilterInput,
"filed_date": DateTimeOperationFilterInput
}
Honorific
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
HonorificOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - Honorific
|
|
neq - Honorific
|
|
in - [Honorific!]
|
|
nin - [Honorific!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
IdKitConfiguration
IdKitConfigurationFilterInput
Fields
Input Field | Description |
---|---|
and - [IdKitConfigurationFilterInput!]
|
|
or - [IdKitConfigurationFilterInput!]
|
|
accountId - StringOperationFilterInput
|
|
apiKey - StringOperationFilterInput
|
|
authUrl - StringOperationFilterInput
|
|
apiUrl - StringOperationFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [IdKitConfigurationFilterInput],
"or": [IdKitConfigurationFilterInput],
"accountId": StringOperationFilterInput,
"apiKey": StringOperationFilterInput,
"authUrl": StringOperationFilterInput,
"apiUrl": StringOperationFilterInput,
"account": AccountFilterInput
}
IdKitConfigurationSortInput
Fields
Input Field | Description |
---|---|
accountId - SortEnumType
|
|
apiKey - SortEnumType
|
|
authUrl - SortEnumType
|
|
apiUrl - SortEnumType
|
|
account - AccountSortInput
|
Example
{
"accountId": "ASC",
"apiKey": "ASC",
"authUrl": "ASC",
"apiUrl": "ASC",
"account": AccountSortInput
}
IdentificationDeviceDetails
Description
Details of the device used to perform identity check
Example
{
"ipAddress": "abc123",
"deviceModel": "abc123",
"vpnUsed": true,
"ipLocation": "abc123",
"geoLocation": "xyz789"
}
IdentificationDeviceDetailsFilterInput
Fields
Input Field | Description |
---|---|
and - [IdentificationDeviceDetailsFilterInput!]
|
|
or - [IdentificationDeviceDetailsFilterInput!]
|
|
id - IntOperationFilterInput
|
|
identificationDocument - IdentificationDocumentFilterInput
|
|
identificationDocumentId - IntOperationFilterInput
|
|
ipAddress - StringOperationFilterInput
|
|
deviceModel - StringOperationFilterInput
|
|
vpnUsed - BooleanOperationFilterInput
|
|
ipLocation - StringOperationFilterInput
|
|
geoLocation - StringOperationFilterInput
|
Example
{
"and": [IdentificationDeviceDetailsFilterInput],
"or": [IdentificationDeviceDetailsFilterInput],
"id": IntOperationFilterInput,
"identificationDocument": IdentificationDocumentFilterInput,
"identificationDocumentId": IntOperationFilterInput,
"ipAddress": StringOperationFilterInput,
"deviceModel": StringOperationFilterInput,
"vpnUsed": BooleanOperationFilterInput,
"ipLocation": StringOperationFilterInput,
"geoLocation": StringOperationFilterInput
}
IdentificationDeviceDetailsSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
identificationDocument - IdentificationDocumentSortInput
|
|
identificationDocumentId - SortEnumType
|
|
ipAddress - SortEnumType
|
|
deviceModel - SortEnumType
|
|
vpnUsed - SortEnumType
|
|
ipLocation - SortEnumType
|
|
geoLocation - SortEnumType
|
Example
{
"id": "ASC",
"identificationDocument": IdentificationDocumentSortInput,
"identificationDocumentId": "ASC",
"ipAddress": "ASC",
"deviceModel": "ASC",
"vpnUsed": "ASC",
"ipLocation": "ASC",
"geoLocation": "ASC"
}
IdentificationDocument
Description
Identification document result
Fields
Field Name | Description |
---|---|
checkResultId - Int!
|
AML Check Result Unique ID |
fuzzyNameScore - Int!
|
Fuzzy name score against the name specified |
result - CheckResultType!
|
Result based on name scoring |
id - String
|
Identification document Id |
dateOfBirth - DateTime
|
Date of birth |
dateOfExpiry - DateTime
|
Date of expiry |
dateOfIssue - DateTime
|
Date of issue |
documentType - IdentificationDocumentType!
|
Type of document |
documentNumber - String
|
Document number |
firstName - String
|
First name on document |
lastName - String
|
Last name on document |
licenseClass - String
|
License class |
nationality - String
|
Nationality on document |
sex - IdentificationDocumentSexType!
|
Person's sex |
givenNames - String
|
Given names |
surnameAndGivenNames - String
|
Surname and given names |
issuingCountry - String
|
Issueing country |
isSuccess - Boolean!
|
Result of identification check |
images - [IdentificationDocumentImage]
|
Images associated with document |
edits - [IdentificationDocumentEdit]
|
Images associated with document |
integrityCheckResult - IdentificationDocumentIntegrity!
|
Document integrity check results |
biometrics - IdentificationDocumentBiometrics
|
Liveliness biometric check results |
deviceDetails - IdentificationDeviceDetails
|
Details of the device used for check |
Example
{
"checkResultId": 987,
"fuzzyNameScore": 987,
"result": "AWAITING",
"id": "xyz789",
"dateOfBirth": "2007-12-03T10:15:30Z",
"dateOfExpiry": "2007-12-03T10:15:30Z",
"dateOfIssue": "2007-12-03T10:15:30Z",
"documentType": "DRIVING_LICENSE",
"documentNumber": "xyz789",
"firstName": "abc123",
"lastName": "xyz789",
"licenseClass": "abc123",
"nationality": "xyz789",
"sex": "FEMALE",
"givenNames": "abc123",
"surnameAndGivenNames": "abc123",
"issuingCountry": "abc123",
"isSuccess": false,
"images": [IdentificationDocumentImage],
"edits": [IdentificationDocumentEdit],
"integrityCheckResult": "CONSIDER",
"biometrics": IdentificationDocumentBiometrics,
"deviceDetails": IdentificationDeviceDetails
}
IdentificationDocumentBiometrics
Description
Identification document biometrics
Fields
Field Name | Description |
---|---|
faceMatch - BiometricCheckResultType!
|
Document and liveness face match check result |
liveness - BiometricCheckResultType!
|
Liveness check result |
breakdown - [LivenessBreakdownItem]
|
Breakdown of biometric checks performed |
Example
{
"faceMatch": "CONSIDER",
"liveness": "CONSIDER",
"breakdown": [LivenessBreakdownItem]
}
IdentificationDocumentBiometricsFilterInput
Fields
Input Field | Description |
---|---|
and - [IdentificationDocumentBiometricsFilterInput!]
|
|
or - [IdentificationDocumentBiometricsFilterInput!]
|
|
id - IntOperationFilterInput
|
|
identificationDocument - IdentificationDocumentFilterInput
|
|
identificationDocumentId - IntOperationFilterInput
|
|
faceMatch - BiometricCheckResultTypeOperationFilterInput
|
|
liveness - BiometricCheckResultTypeOperationFilterInput
|
|
breakdown - ListFilterInputTypeOfLivenessBreakdownItemFilterInput
|
Example
{
"and": [IdentificationDocumentBiometricsFilterInput],
"or": [IdentificationDocumentBiometricsFilterInput],
"id": IntOperationFilterInput,
"identificationDocument": IdentificationDocumentFilterInput,
"identificationDocumentId": IntOperationFilterInput,
"faceMatch": BiometricCheckResultTypeOperationFilterInput,
"liveness": BiometricCheckResultTypeOperationFilterInput,
"breakdown": ListFilterInputTypeOfLivenessBreakdownItemFilterInput
}
IdentificationDocumentBiometricsSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
identificationDocument - IdentificationDocumentSortInput
|
|
identificationDocumentId - SortEnumType
|
|
faceMatch - SortEnumType
|
|
liveness - SortEnumType
|
Example
{
"id": "ASC",
"identificationDocument": IdentificationDocumentSortInput,
"identificationDocumentId": "ASC",
"faceMatch": "ASC",
"liveness": "ASC"
}
IdentificationDocumentEdit
Description
Identification document edit
Fields
Field Name | Description |
---|---|
id - Int!
|
Id of edit |
field - DocumentField!
|
Field changed |
submittedValue - String
|
Submitted Value |
Example
{
"id": 123,
"field": "FIRST_NAME",
"submittedValue": "xyz789"
}
IdentificationDocumentEditFilterInput
Fields
Input Field | Description |
---|---|
and - [IdentificationDocumentEditFilterInput!]
|
|
or - [IdentificationDocumentEditFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
field - DocumentFieldOperationFilterInput
|
|
submittedValue - StringOperationFilterInput
|
|
identificationDocument - IdentificationDocumentFilterInput
|
Example
{
"and": [IdentificationDocumentEditFilterInput],
"or": [IdentificationDocumentEditFilterInput],
"id": IntOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"field": DocumentFieldOperationFilterInput,
"submittedValue": StringOperationFilterInput,
"identificationDocument": IdentificationDocumentFilterInput
}
IdentificationDocumentFilterInput
Fields
Example
{
"and": [IdentificationDocumentFilterInput],
"or": [IdentificationDocumentFilterInput],
"checkResultId": IntOperationFilterInput,
"documentType": IdentificationDocumentTypeOperationFilterInput,
"documentNumber": StringOperationFilterInput,
"issuingCountry": StringOperationFilterInput,
"firstName": StringOperationFilterInput,
"lastName": StringOperationFilterInput,
"givenNames": StringOperationFilterInput,
"surnameAndGivenNames": StringOperationFilterInput,
"nationality": StringOperationFilterInput,
"dateOfBirth": portfolio_DateTimeOperationFilterInput,
"dateOfExpiry": portfolio_DateTimeOperationFilterInput,
"dateOfIssue": portfolio_DateTimeOperationFilterInput,
"licenseClass": StringOperationFilterInput,
"sex": IdentificationDocumentSexTypeOperationFilterInput,
"checkResult": CheckResultFilterInput,
"images": ListFilterInputTypeOfIdentificationDocumentImageFilterInput,
"edits": ListFilterInputTypeOfIdentificationDocumentEditFilterInput,
"biometrics": IdentificationDocumentBiometricsFilterInput,
"deviceDetails": IdentificationDeviceDetailsFilterInput,
"isSuccess": BooleanOperationFilterInput,
"fuzzyNameScore": IntOperationFilterInput,
"result": CheckResultTypeOperationFilterInput,
"verificationId": StringOperationFilterInput,
"mrz": StringOperationFilterInput,
"integrityCheckResult": IdentificationDocumentIntegrityOperationFilterInput
}
IdentificationDocumentImage
Description
Identification document image
Fields
Field Name | Description |
---|---|
imageType - IdentificationDocumentImageType!
|
Type of image |
content - String
|
Encoded image |
contentType - String
|
Content type of image (jpeg, png, etc) |
Example
{
"imageType": "CROPPED_FRONT_IMAGE",
"content": "xyz789",
"contentType": "abc123"
}
IdentificationDocumentImageFilterInput
Fields
Input Field | Description |
---|---|
and - [IdentificationDocumentImageFilterInput!]
|
|
or - [IdentificationDocumentImageFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkResultId - IntOperationFilterInput
|
|
imageType - IdentificationDocumentImageTypeOperationFilterInput
|
|
identificationDocument - IdentificationDocumentFilterInput
|
|
contentType - StringOperationFilterInput
|
|
content - StringOperationFilterInput
|
Example
{
"and": [IdentificationDocumentImageFilterInput],
"or": [IdentificationDocumentImageFilterInput],
"id": IntOperationFilterInput,
"checkResultId": IntOperationFilterInput,
"imageType": IdentificationDocumentImageTypeOperationFilterInput,
"identificationDocument": IdentificationDocumentFilterInput,
"contentType": StringOperationFilterInput,
"content": StringOperationFilterInput
}
IdentificationDocumentImageType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"CROPPED_FRONT_IMAGE"
IdentificationDocumentImageTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentificationDocumentImageType
|
|
neq - IdentificationDocumentImageType
|
|
in - [IdentificationDocumentImageType!]
|
|
nin - [IdentificationDocumentImageType!]
|
Example
{
"eq": "CROPPED_FRONT_IMAGE",
"neq": "CROPPED_FRONT_IMAGE",
"in": ["CROPPED_FRONT_IMAGE"],
"nin": ["CROPPED_FRONT_IMAGE"]
}
IdentificationDocumentIntegrity
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"CONSIDER"
IdentificationDocumentIntegrityOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentificationDocumentIntegrity
|
|
neq - IdentificationDocumentIntegrity
|
|
in - [IdentificationDocumentIntegrity!]
|
|
nin - [IdentificationDocumentIntegrity!]
|
Example
{"eq": "CONSIDER", "neq": "CONSIDER", "in": ["CONSIDER"], "nin": ["CONSIDER"]}
IdentificationDocumentSearchType
Fields
Field Name | Description |
---|---|
id - Int!
|
AML Check Result Unique ID |
fuzzyNameScore - Int!
|
Fuzzy name score against the name specified |
result - CheckResultType!
|
Result based on name scoring |
isSuccess - Boolean!
|
Result of identification check |
Example
{"id": 987, "fuzzyNameScore": 123, "result": "AWAITING", "isSuccess": true}
IdentificationDocumentSexType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"FEMALE"
IdentificationDocumentSexTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentificationDocumentSexType
|
|
neq - IdentificationDocumentSexType
|
|
in - [IdentificationDocumentSexType!]
|
|
nin - [IdentificationDocumentSexType!]
|
Example
{"eq": "FEMALE", "neq": "FEMALE", "in": ["FEMALE"], "nin": ["FEMALE"]}
IdentificationDocumentSortInput
Fields
Input Field | Description |
---|---|
checkResultId - SortEnumType
|
|
documentType - SortEnumType
|
|
documentNumber - SortEnumType
|
|
issuingCountry - SortEnumType
|
|
firstName - SortEnumType
|
|
lastName - SortEnumType
|
|
givenNames - SortEnumType
|
|
surnameAndGivenNames - SortEnumType
|
|
nationality - SortEnumType
|
|
dateOfBirth - SortEnumType
|
|
dateOfExpiry - SortEnumType
|
|
dateOfIssue - SortEnumType
|
|
licenseClass - SortEnumType
|
|
sex - SortEnumType
|
|
checkResult - CheckResultSortInput
|
|
biometrics - IdentificationDocumentBiometricsSortInput
|
|
deviceDetails - IdentificationDeviceDetailsSortInput
|
|
isSuccess - SortEnumType
|
|
fuzzyNameScore - SortEnumType
|
|
result - SortEnumType
|
|
verificationId - SortEnumType
|
|
mrz - SortEnumType
|
|
integrityCheckResult - SortEnumType
|
Example
{
"checkResultId": "ASC",
"documentType": "ASC",
"documentNumber": "ASC",
"issuingCountry": "ASC",
"firstName": "ASC",
"lastName": "ASC",
"givenNames": "ASC",
"surnameAndGivenNames": "ASC",
"nationality": "ASC",
"dateOfBirth": "ASC",
"dateOfExpiry": "ASC",
"dateOfIssue": "ASC",
"licenseClass": "ASC",
"sex": "ASC",
"checkResult": CheckResultSortInput,
"biometrics": IdentificationDocumentBiometricsSortInput,
"deviceDetails": IdentificationDeviceDetailsSortInput,
"isSuccess": "ASC",
"fuzzyNameScore": "ASC",
"result": "ASC",
"verificationId": "ASC",
"mrz": "ASC",
"integrityCheckResult": "ASC"
}
IdentificationDocumentType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"DRIVING_LICENSE"
IdentificationDocumentTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentificationDocumentType
|
|
neq - IdentificationDocumentType
|
|
in - [IdentificationDocumentType!]
|
|
nin - [IdentificationDocumentType!]
|
Example
{
"eq": "DRIVING_LICENSE",
"neq": "DRIVING_LICENSE",
"in": ["DRIVING_LICENSE"],
"nin": ["DRIVING_LICENSE"]
}
IdentificationProvider
Fields
Field Name | Description |
---|---|
id - IdentificationProviderId!
|
Provider Id |
providerName - String
|
|
amlResults - [AmlResult]
|
|
checkDescriptions - [CheckDescription]
|
Example
{
"id": "AUTHENTEQ",
"providerName": "abc123",
"amlResults": [AmlResult],
"checkDescriptions": [CheckDescription]
}
IdentificationProviderFilterInput
Fields
Input Field | Description |
---|---|
and - [IdentificationProviderFilterInput!]
|
|
or - [IdentificationProviderFilterInput!]
|
|
providerId - IdentificationProviderIdOperationFilterInput
|
|
providerName - StringOperationFilterInput
|
|
amlResults - ListFilterInputTypeOfAmlResultFilterInput
|
|
checkDescriptions - ListFilterInputTypeOfCheckDescriptionFilterInput
|
Example
{
"and": [IdentificationProviderFilterInput],
"or": [IdentificationProviderFilterInput],
"providerId": IdentificationProviderIdOperationFilterInput,
"providerName": StringOperationFilterInput,
"amlResults": ListFilterInputTypeOfAmlResultFilterInput,
"checkDescriptions": ListFilterInputTypeOfCheckDescriptionFilterInput
}
IdentificationProviderId
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"AUTHENTEQ"
IdentificationProviderIdOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - IdentificationProviderId
|
|
neq - IdentificationProviderId
|
|
in - [IdentificationProviderId!]
|
|
nin - [IdentificationProviderId!]
|
Example
{
"eq": "AUTHENTEQ",
"neq": "AUTHENTEQ",
"in": ["AUTHENTEQ"],
"nin": ["AUTHENTEQ"]
}
IdentificationProviderSortInput
Fields
Input Field | Description |
---|---|
providerId - SortEnumType
|
|
providerName - SortEnumType
|
Example
{"providerId": "ASC", "providerName": "ASC"}
InsolvencyPerson
Example
{
"url": "xyz789",
"court": "xyz789",
"type": "abc123",
"caseno": "abc123",
"number": "xyz789",
"start_date": "2007-12-03",
"initial_letter": "abc123"
}
InsolvencyPersonFilterInput
Fields
Input Field | Description |
---|---|
and - [InsolvencyPersonFilterInput!]
|
|
or - [InsolvencyPersonFilterInput!]
|
|
initial_letter - StringOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
court - StringOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
caseno - StringOperationFilterInput
|
|
number - StringOperationFilterInput
|
|
start_date - DateTimeOperationFilterInput
|
Example
{
"and": [InsolvencyPersonFilterInput],
"or": [InsolvencyPersonFilterInput],
"initial_letter": StringOperationFilterInput,
"url": StringOperationFilterInput,
"court": StringOperationFilterInput,
"type": StringOperationFilterInput,
"caseno": StringOperationFilterInput,
"number": StringOperationFilterInput,
"start_date": DateTimeOperationFilterInput
}
Int
Description
The Int
scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
123
IntOperationFilterInput
Example
{
"eq": 123,
"neq": 123,
"in": [987],
"nin": [987],
"gt": 123,
"ngt": 987,
"gte": 123,
"ngte": 123,
"lt": 123,
"nlt": 123,
"lte": 987,
"nlte": 123
}
Latest_Action
Latest_ActionFilterInput
Fields
Input Field | Description |
---|---|
and - [Latest_ActionFilterInput!]
|
|
or - [Latest_ActionFilterInput!]
|
|
action - StringOperationFilterInput
|
|
date - DateTimeOperationFilterInput
|
Example
{
"and": [Latest_ActionFilterInput],
"or": [Latest_ActionFilterInput],
"action": StringOperationFilterInput,
"date": DateTimeOperationFilterInput
}
ListAmlMatchTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
all - AmlMatchTypeOperationFilterInput
|
|
none - AmlMatchTypeOperationFilterInput
|
|
some - AmlMatchTypeOperationFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlMatchTypeOperationFilterInput,
"none": AmlMatchTypeOperationFilterInput,
"some": AmlMatchTypeOperationFilterInput,
"any": true
}
ListAmlTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
all - AmlTypeOperationFilterInput
|
|
none - AmlTypeOperationFilterInput
|
|
some - AmlTypeOperationFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlTypeOperationFilterInput,
"none": AmlTypeOperationFilterInput,
"some": AmlTypeOperationFilterInput,
"any": true
}
ListFilterInputTypeOfAccountFilterInput
Fields
Input Field | Description |
---|---|
all - AccountFilterInput
|
|
none - AccountFilterInput
|
|
some - AccountFilterInput
|
|
any - Boolean
|
Example
{
"all": AccountFilterInput,
"none": AccountFilterInput,
"some": AccountFilterInput,
"any": true
}
ListFilterInputTypeOfAccountTypeWebHookFilterInput
Fields
Input Field | Description |
---|---|
all - AccountTypeWebHookFilterInput
|
|
none - AccountTypeWebHookFilterInput
|
|
some - AccountTypeWebHookFilterInput
|
|
any - Boolean
|
Example
{
"all": AccountTypeWebHookFilterInput,
"none": AccountTypeWebHookFilterInput,
"some": AccountTypeWebHookFilterInput,
"any": true
}
ListFilterInputTypeOfAddressFilterInput
Fields
Input Field | Description |
---|---|
all - AddressFilterInput
|
|
none - AddressFilterInput
|
|
some - AddressFilterInput
|
|
any - Boolean
|
Example
{
"all": AddressFilterInput,
"none": AddressFilterInput,
"some": AddressFilterInput,
"any": false
}
ListFilterInputTypeOfAddressVerificationDetailFilterInput
Fields
Input Field | Description |
---|---|
all - AddressVerificationDetailFilterInput
|
|
none - AddressVerificationDetailFilterInput
|
|
some - AddressVerificationDetailFilterInput
|
|
any - Boolean
|
Example
{
"all": AddressVerificationDetailFilterInput,
"none": AddressVerificationDetailFilterInput,
"some": AddressVerificationDetailFilterInput,
"any": false
}
ListFilterInputTypeOfAddressVerificationItemFilterInput
Fields
Input Field | Description |
---|---|
all - AddressVerificationItemFilterInput
|
|
none - AddressVerificationItemFilterInput
|
|
some - AddressVerificationItemFilterInput
|
|
any - Boolean
|
Example
{
"all": AddressVerificationItemFilterInput,
"none": AddressVerificationItemFilterInput,
"some": AddressVerificationItemFilterInput,
"any": false
}
ListFilterInputTypeOfAmlAddressFilterInput
Fields
Input Field | Description |
---|---|
all - AmlAddressFilterInput
|
|
none - AmlAddressFilterInput
|
|
some - AmlAddressFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlAddressFilterInput,
"none": AmlAddressFilterInput,
"some": AmlAddressFilterInput,
"any": true
}
ListFilterInputTypeOfAmlEntityAssetFilterInput
Fields
Input Field | Description |
---|---|
all - AmlEntityAssetFilterInput
|
|
none - AmlEntityAssetFilterInput
|
|
some - AmlEntityAssetFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlEntityAssetFilterInput,
"none": AmlEntityAssetFilterInput,
"some": AmlEntityAssetFilterInput,
"any": false
}
ListFilterInputTypeOfAmlEntityAssociateFilterInput
Fields
Input Field | Description |
---|---|
all - AmlEntityAssociateFilterInput
|
|
none - AmlEntityAssociateFilterInput
|
|
some - AmlEntityAssociateFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlEntityAssociateFilterInput,
"none": AmlEntityAssociateFilterInput,
"some": AmlEntityAssociateFilterInput,
"any": true
}
ListFilterInputTypeOfAmlEntityMediaFilterInput
Fields
Input Field | Description |
---|---|
all - AmlEntityMediaFilterInput
|
|
none - AmlEntityMediaFilterInput
|
|
some - AmlEntityMediaFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlEntityMediaFilterInput,
"none": AmlEntityMediaFilterInput,
"some": AmlEntityMediaFilterInput,
"any": true
}
ListFilterInputTypeOfAmlMatchFilterInput
Fields
Input Field | Description |
---|---|
all - AmlMatchFilterInput
|
|
none - AmlMatchFilterInput
|
|
some - AmlMatchFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlMatchFilterInput,
"none": AmlMatchFilterInput,
"some": AmlMatchFilterInput,
"any": true
}
ListFilterInputTypeOfAmlMatchTypeDetailFilterInput
Fields
Input Field | Description |
---|---|
all - AmlMatchTypeDetailFilterInput
|
|
none - AmlMatchTypeDetailFilterInput
|
|
some - AmlMatchTypeDetailFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlMatchTypeDetailFilterInput,
"none": AmlMatchTypeDetailFilterInput,
"some": AmlMatchTypeDetailFilterInput,
"any": false
}
ListFilterInputTypeOfAmlPositionFilterInput
Fields
Input Field | Description |
---|---|
all - AmlPositionFilterInput
|
|
none - AmlPositionFilterInput
|
|
some - AmlPositionFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlPositionFilterInput,
"none": AmlPositionFilterInput,
"some": AmlPositionFilterInput,
"any": true
}
ListFilterInputTypeOfAmlResultFilterInput
Fields
Input Field | Description |
---|---|
all - AmlResultFilterInput
|
|
none - AmlResultFilterInput
|
|
some - AmlResultFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlResultFilterInput,
"none": AmlResultFilterInput,
"some": AmlResultFilterInput,
"any": false
}
ListFilterInputTypeOfAmlSourceNoteFilterInput
Fields
Input Field | Description |
---|---|
all - AmlSourceNoteFilterInput
|
|
none - AmlSourceNoteFilterInput
|
|
some - AmlSourceNoteFilterInput
|
|
any - Boolean
|
Example
{
"all": AmlSourceNoteFilterInput,
"none": AmlSourceNoteFilterInput,
"some": AmlSourceNoteFilterInput,
"any": false
}
ListFilterInputTypeOfApiRequestFilterInput
Fields
Input Field | Description |
---|---|
all - ApiRequestFilterInput
|
|
none - ApiRequestFilterInput
|
|
some - ApiRequestFilterInput
|
|
any - Boolean
|
Example
{
"all": ApiRequestFilterInput,
"none": ApiRequestFilterInput,
"some": ApiRequestFilterInput,
"any": false
}
ListFilterInputTypeOfBalance_SheetFilterInput
Fields
Input Field | Description |
---|---|
all - Balance_SheetFilterInput
|
|
none - Balance_SheetFilterInput
|
|
some - Balance_SheetFilterInput
|
|
any - Boolean
|
Example
{
"all": Balance_SheetFilterInput,
"none": Balance_SheetFilterInput,
"some": Balance_SheetFilterInput,
"any": true
}
ListFilterInputTypeOfBeneficialOwnerFilterInput
Fields
Input Field | Description |
---|---|
all - BeneficialOwnerFilterInput
|
|
none - BeneficialOwnerFilterInput
|
|
some - BeneficialOwnerFilterInput
|
|
any - Boolean
|
Example
{
"all": BeneficialOwnerFilterInput,
"none": BeneficialOwnerFilterInput,
"some": BeneficialOwnerFilterInput,
"any": false
}
ListFilterInputTypeOfCCJFilterInput
Fields
Input Field | Description |
---|---|
all - CCJFilterInput
|
|
none - CCJFilterInput
|
|
some - CCJFilterInput
|
|
any - Boolean
|
Example
{
"all": CCJFilterInput,
"none": CCJFilterInput,
"some": CCJFilterInput,
"any": true
}
ListFilterInputTypeOfCashFlowFilterInput
Fields
Input Field | Description |
---|---|
all - CashFlowFilterInput
|
|
none - CashFlowFilterInput
|
|
some - CashFlowFilterInput
|
|
any - Boolean
|
Example
{
"all": CashFlowFilterInput,
"none": CashFlowFilterInput,
"some": CashFlowFilterInput,
"any": true
}
ListFilterInputTypeOfCheckDescriptionFilterInput
Fields
Input Field | Description |
---|---|
all - CheckDescriptionFilterInput
|
|
none - CheckDescriptionFilterInput
|
|
some - CheckDescriptionFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckDescriptionFilterInput,
"none": CheckDescriptionFilterInput,
"some": CheckDescriptionFilterInput,
"any": true
}
ListFilterInputTypeOfCheckDetailAddressFilterInput
Fields
Input Field | Description |
---|---|
all - CheckDetailAddressFilterInput
|
|
none - CheckDetailAddressFilterInput
|
|
some - CheckDetailAddressFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckDetailAddressFilterInput,
"none": CheckDetailAddressFilterInput,
"some": CheckDetailAddressFilterInput,
"any": false
}
ListFilterInputTypeOfCheckDetailIdentityDocumentFilterInput
Fields
Input Field | Description |
---|---|
all - CheckDetailIdentityDocumentFilterInput
|
|
none - CheckDetailIdentityDocumentFilterInput
|
|
some - CheckDetailIdentityDocumentFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckDetailIdentityDocumentFilterInput,
"none": CheckDetailIdentityDocumentFilterInput,
"some": CheckDetailIdentityDocumentFilterInput,
"any": true
}
ListFilterInputTypeOfCheckFilterInput
Fields
Input Field | Description |
---|---|
all - CheckFilterInput
|
|
none - CheckFilterInput
|
|
some - CheckFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckFilterInput,
"none": CheckFilterInput,
"some": CheckFilterInput,
"any": true
}
ListFilterInputTypeOfCheckNotificationFilterInput
Fields
Input Field | Description |
---|---|
all - CheckNotificationFilterInput
|
|
none - CheckNotificationFilterInput
|
|
some - CheckNotificationFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckNotificationFilterInput,
"none": CheckNotificationFilterInput,
"some": CheckNotificationFilterInput,
"any": false
}
ListFilterInputTypeOfCheckStatusFilterInput
Fields
Input Field | Description |
---|---|
all - CheckStatusFilterInput
|
|
none - CheckStatusFilterInput
|
|
some - CheckStatusFilterInput
|
|
any - Boolean
|
Example
{
"all": CheckStatusFilterInput,
"none": CheckStatusFilterInput,
"some": CheckStatusFilterInput,
"any": false
}
ListFilterInputTypeOfCompanyArchiveFilterInput
Fields
Input Field | Description |
---|---|
all - CompanyArchiveFilterInput
|
|
none - CompanyArchiveFilterInput
|
|
some - CompanyArchiveFilterInput
|
|
any - Boolean
|
Example
{
"all": CompanyArchiveFilterInput,
"none": CompanyArchiveFilterInput,
"some": CompanyArchiveFilterInput,
"any": false
}
ListFilterInputTypeOfCompanyBeneficiaryFilterInput
Fields
Input Field | Description |
---|---|
all - CompanyBeneficiaryFilterInput
|
|
none - CompanyBeneficiaryFilterInput
|
|
some - CompanyBeneficiaryFilterInput
|
|
any - Boolean
|
Example
{
"all": CompanyBeneficiaryFilterInput,
"none": CompanyBeneficiaryFilterInput,
"some": CompanyBeneficiaryFilterInput,
"any": true
}
ListFilterInputTypeOfCompanyBeneficiaryRelationshipFilterInput
Fields
Input Field | Description |
---|---|
all - CompanyBeneficiaryRelationshipFilterInput
|
|
none - CompanyBeneficiaryRelationshipFilterInput
|
|
some - CompanyBeneficiaryRelationshipFilterInput
|
|
any - Boolean
|
Example
{
"all": CompanyBeneficiaryRelationshipFilterInput,
"none": CompanyBeneficiaryRelationshipFilterInput,
"some": CompanyBeneficiaryRelationshipFilterInput,
"any": false
}
ListFilterInputTypeOfCompanyPortfolioFilterInput
Fields
Input Field | Description |
---|---|
all - CompanyPortfolioFilterInput
|
|
none - CompanyPortfolioFilterInput
|
|
some - CompanyPortfolioFilterInput
|
|
any - Boolean
|
Example
{
"all": CompanyPortfolioFilterInput,
"none": CompanyPortfolioFilterInput,
"some": CompanyPortfolioFilterInput,
"any": false
}
ListFilterInputTypeOfContactFilterInput
Fields
Input Field | Description |
---|---|
all - ContactFilterInput
|
|
none - ContactFilterInput
|
|
some - ContactFilterInput
|
|
any - Boolean
|
Example
{
"all": ContactFilterInput,
"none": ContactFilterInput,
"some": ContactFilterInput,
"any": false
}
ListFilterInputTypeOfCorporateEntityFilterInput
Fields
Input Field | Description |
---|---|
all - CorporateEntityFilterInput
|
|
none - CorporateEntityFilterInput
|
|
some - CorporateEntityFilterInput
|
|
any - Boolean
|
Example
{
"all": CorporateEntityFilterInput,
"none": CorporateEntityFilterInput,
"some": CorporateEntityFilterInput,
"any": false
}
ListFilterInputTypeOfCreditLimitFilterInput
Fields
Input Field | Description |
---|---|
all - CreditLimitFilterInput
|
|
none - CreditLimitFilterInput
|
|
some - CreditLimitFilterInput
|
|
any - Boolean
|
Example
{
"all": CreditLimitFilterInput,
"none": CreditLimitFilterInput,
"some": CreditLimitFilterInput,
"any": true
}
ListFilterInputTypeOfCreditorFilterInput
Fields
Input Field | Description |
---|---|
all - CreditorFilterInput
|
|
none - CreditorFilterInput
|
|
some - CreditorFilterInput
|
|
any - Boolean
|
Example
{
"all": CreditorFilterInput,
"none": CreditorFilterInput,
"some": CreditorFilterInput,
"any": false
}
ListFilterInputTypeOfCurrent_DirectorsFilterInput
Fields
Input Field | Description |
---|---|
all - Current_DirectorsFilterInput
|
|
none - Current_DirectorsFilterInput
|
|
some - Current_DirectorsFilterInput
|
|
any - Boolean
|
Example
{
"all": Current_DirectorsFilterInput,
"none": Current_DirectorsFilterInput,
"some": Current_DirectorsFilterInput,
"any": true
}
ListFilterInputTypeOfDebtorFilterInput
Fields
Input Field | Description |
---|---|
all - DebtorFilterInput
|
|
none - DebtorFilterInput
|
|
some - DebtorFilterInput
|
|
any - Boolean
|
Example
{
"all": DebtorFilterInput,
"none": DebtorFilterInput,
"some": DebtorFilterInput,
"any": true
}
ListFilterInputTypeOfDetrimentalDataFilterInput
Fields
Input Field | Description |
---|---|
all - DetrimentalDataFilterInput
|
|
none - DetrimentalDataFilterInput
|
|
some - DetrimentalDataFilterInput
|
|
any - Boolean
|
Example
{
"all": DetrimentalDataFilterInput,
"none": DetrimentalDataFilterInput,
"some": DetrimentalDataFilterInput,
"any": false
}
ListFilterInputTypeOfDirectorFilterInput
Fields
Input Field | Description |
---|---|
all - DirectorFilterInput
|
|
none - DirectorFilterInput
|
|
some - DirectorFilterInput
|
|
any - Boolean
|
Example
{
"all": DirectorFilterInput,
"none": DirectorFilterInput,
"some": DirectorFilterInput,
"any": false
}
ListFilterInputTypeOfDirectorPartialFilterInput
Fields
Input Field | Description |
---|---|
all - DirectorPartialFilterInput
|
|
none - DirectorPartialFilterInput
|
|
some - DirectorPartialFilterInput
|
|
any - Boolean
|
Example
{
"all": DirectorPartialFilterInput,
"none": DirectorPartialFilterInput,
"some": DirectorPartialFilterInput,
"any": true
}
ListFilterInputTypeOfFormerNameFilterInput
Fields
Input Field | Description |
---|---|
all - FormerNameFilterInput
|
|
none - FormerNameFilterInput
|
|
some - FormerNameFilterInput
|
|
any - Boolean
|
Example
{
"all": FormerNameFilterInput,
"none": FormerNameFilterInput,
"some": FormerNameFilterInput,
"any": true
}
ListFilterInputTypeOfGazetteNoticeFilterInput
Fields
Input Field | Description |
---|---|
all - GazetteNoticeFilterInput
|
|
none - GazetteNoticeFilterInput
|
|
some - GazetteNoticeFilterInput
|
|
any - Boolean
|
Example
{
"all": GazetteNoticeFilterInput,
"none": GazetteNoticeFilterInput,
"some": GazetteNoticeFilterInput,
"any": true
}
ListFilterInputTypeOfGbgProfileConfigurationFilterInput
Fields
Input Field | Description |
---|---|
all - GbgProfileConfigurationFilterInput
|
|
none - GbgProfileConfigurationFilterInput
|
|
some - GbgProfileConfigurationFilterInput
|
|
any - Boolean
|
Example
{
"all": GbgProfileConfigurationFilterInput,
"none": GbgProfileConfigurationFilterInput,
"some": GbgProfileConfigurationFilterInput,
"any": false
}
ListFilterInputTypeOfHistoryFilterInput
Fields
Input Field | Description |
---|---|
all - HistoryFilterInput
|
|
none - HistoryFilterInput
|
|
some - HistoryFilterInput
|
|
any - Boolean
|
Example
{
"all": HistoryFilterInput,
"none": HistoryFilterInput,
"some": HistoryFilterInput,
"any": false
}
ListFilterInputTypeOfIdentificationDocumentEditFilterInput
Fields
Input Field | Description |
---|---|
all - IdentificationDocumentEditFilterInput
|
|
none - IdentificationDocumentEditFilterInput
|
|
some - IdentificationDocumentEditFilterInput
|
|
any - Boolean
|
Example
{
"all": IdentificationDocumentEditFilterInput,
"none": IdentificationDocumentEditFilterInput,
"some": IdentificationDocumentEditFilterInput,
"any": true
}
ListFilterInputTypeOfIdentificationDocumentImageFilterInput
Fields
Input Field | Description |
---|---|
all - IdentificationDocumentImageFilterInput
|
|
none - IdentificationDocumentImageFilterInput
|
|
some - IdentificationDocumentImageFilterInput
|
|
any - Boolean
|
Example
{
"all": IdentificationDocumentImageFilterInput,
"none": IdentificationDocumentImageFilterInput,
"some": IdentificationDocumentImageFilterInput,
"any": true
}
ListFilterInputTypeOfLivenessBreakdownItemFilterInput
Fields
Input Field | Description |
---|---|
all - LivenessBreakdownItemFilterInput
|
|
none - LivenessBreakdownItemFilterInput
|
|
some - LivenessBreakdownItemFilterInput
|
|
any - Boolean
|
Example
{
"all": LivenessBreakdownItemFilterInput,
"none": LivenessBreakdownItemFilterInput,
"some": LivenessBreakdownItemFilterInput,
"any": false
}
ListFilterInputTypeOfMortgageFilterInput
Fields
Input Field | Description |
---|---|
all - MortgageFilterInput
|
|
none - MortgageFilterInput
|
|
some - MortgageFilterInput
|
|
any - Boolean
|
Example
{
"all": MortgageFilterInput,
"none": MortgageFilterInput,
"some": MortgageFilterInput,
"any": false
}
ListFilterInputTypeOfNotificationFilterInput
Fields
Input Field | Description |
---|---|
all - NotificationFilterInput
|
|
none - NotificationFilterInput
|
|
some - NotificationFilterInput
|
|
any - Boolean
|
Example
{
"all": NotificationFilterInput,
"none": NotificationFilterInput,
"some": NotificationFilterInput,
"any": false
}
ListFilterInputTypeOfNotificationHistoryFilterInput
Fields
Input Field | Description |
---|---|
all - NotificationHistoryFilterInput
|
|
none - NotificationHistoryFilterInput
|
|
some - NotificationHistoryFilterInput
|
|
any - Boolean
|
Example
{
"all": NotificationHistoryFilterInput,
"none": NotificationHistoryFilterInput,
"some": NotificationHistoryFilterInput,
"any": true
}
ListFilterInputTypeOfPOSCFilterInput
Fields
Input Field | Description |
---|---|
all - POSCFilterInput
|
|
none - POSCFilterInput
|
|
some - POSCFilterInput
|
|
any - Boolean
|
Example
{
"all": POSCFilterInput,
"none": POSCFilterInput,
"some": POSCFilterInput,
"any": true
}
ListFilterInputTypeOfPersonFilterInput
Fields
Input Field | Description |
---|---|
all - PersonFilterInput
|
|
none - PersonFilterInput
|
|
some - PersonFilterInput
|
|
any - Boolean
|
Example
{
"all": PersonFilterInput,
"none": PersonFilterInput,
"some": PersonFilterInput,
"any": false
}
ListFilterInputTypeOfPortfolioEventFilterInput
Fields
Input Field | Description |
---|---|
all - PortfolioEventFilterInput
|
|
none - PortfolioEventFilterInput
|
|
some - PortfolioEventFilterInput
|
|
any - Boolean
|
Example
{
"all": PortfolioEventFilterInput,
"none": PortfolioEventFilterInput,
"some": PortfolioEventFilterInput,
"any": true
}
ListFilterInputTypeOfPortfolioRecipientsFilterInput
Fields
Input Field | Description |
---|---|
all - PortfolioRecipientsFilterInput
|
|
none - PortfolioRecipientsFilterInput
|
|
some - PortfolioRecipientsFilterInput
|
|
any - Boolean
|
Example
{
"all": PortfolioRecipientsFilterInput,
"none": PortfolioRecipientsFilterInput,
"some": PortfolioRecipientsFilterInput,
"any": true
}
ListFilterInputTypeOfProfit_LossFilterInput
Fields
Input Field | Description |
---|---|
all - Profit_LossFilterInput
|
|
none - Profit_LossFilterInput
|
|
some - Profit_LossFilterInput
|
|
any - Boolean
|
Example
{
"all": Profit_LossFilterInput,
"none": Profit_LossFilterInput,
"some": Profit_LossFilterInput,
"any": false
}
ListFilterInputTypeOfRatioAnalysisFilterInput
Fields
Input Field | Description |
---|---|
all - RatioAnalysisFilterInput
|
|
none - RatioAnalysisFilterInput
|
|
some - RatioAnalysisFilterInput
|
|
any - Boolean
|
Example
{
"all": RatioAnalysisFilterInput,
"none": RatioAnalysisFilterInput,
"some": RatioAnalysisFilterInput,
"any": false
}
ListFilterInputTypeOfSIC07FilterInput
Fields
Input Field | Description |
---|---|
all - SIC07FilterInput
|
|
none - SIC07FilterInput
|
|
some - SIC07FilterInput
|
|
any - Boolean
|
Example
{
"all": SIC07FilterInput,
"none": SIC07FilterInput,
"some": SIC07FilterInput,
"any": false
}
ListFilterInputTypeOfTriggerEventFilterInput
Fields
Input Field | Description |
---|---|
all - TriggerEventFilterInput
|
|
none - TriggerEventFilterInput
|
|
some - TriggerEventFilterInput
|
|
any - Boolean
|
Example
{
"all": TriggerEventFilterInput,
"none": TriggerEventFilterInput,
"some": TriggerEventFilterInput,
"any": true
}
ListFilterInputTypeOfUserFilterInput
Fields
Input Field | Description |
---|---|
all - UserFilterInput
|
|
none - UserFilterInput
|
|
some - UserFilterInput
|
|
any - Boolean
|
Example
{
"all": UserFilterInput,
"none": UserFilterInput,
"some": UserFilterInput,
"any": false
}
ListFilterInputTypeOfUserRoleFilterInput
Fields
Input Field | Description |
---|---|
all - UserRoleFilterInput
|
|
none - UserRoleFilterInput
|
|
some - UserRoleFilterInput
|
|
any - Boolean
|
Example
{
"all": UserRoleFilterInput,
"none": UserRoleFilterInput,
"some": UserRoleFilterInput,
"any": false
}
ListFilterInputTypeOfVerificationFilterInput
Fields
Input Field | Description |
---|---|
all - VerificationFilterInput
|
|
none - VerificationFilterInput
|
|
some - VerificationFilterInput
|
|
any - Boolean
|
Example
{
"all": VerificationFilterInput,
"none": VerificationFilterInput,
"some": VerificationFilterInput,
"any": false
}
ListFilterInputTypeOfWebHookFilterInput
Fields
Input Field | Description |
---|---|
all - WebHookFilterInput
|
|
none - WebHookFilterInput
|
|
some - WebHookFilterInput
|
|
any - Boolean
|
Example
{
"all": WebHookFilterInput,
"none": WebHookFilterInput,
"some": WebHookFilterInput,
"any": true
}
ListStringOperationFilterInput
Fields
Input Field | Description |
---|---|
all - StringOperationFilterInput
|
|
none - StringOperationFilterInput
|
|
some - StringOperationFilterInput
|
|
any - Boolean
|
Example
{
"all": StringOperationFilterInput,
"none": StringOperationFilterInput,
"some": StringOperationFilterInput,
"any": true
}
LivenessBreakdownItem
Description
Biometric checks breakdown item
Fields
Field Name | Description |
---|---|
field - String
|
Biometric check |
value - BiometricCheckResultType!
|
Outcome of biometric check |
Example
{"field": "abc123", "value": "CONSIDER"}
LivenessBreakdownItemFilterInput
Fields
Input Field | Description |
---|---|
and - [LivenessBreakdownItemFilterInput!]
|
|
or - [LivenessBreakdownItemFilterInput!]
|
|
id - IntOperationFilterInput
|
|
identificationDocumentBiometrics - IdentificationDocumentBiometricsFilterInput
|
|
identificationDocumentBiomertricsId - IntOperationFilterInput
|
|
field - StringOperationFilterInput
|
|
value - BiometricCheckResultTypeOperationFilterInput
|
Example
{
"and": [LivenessBreakdownItemFilterInput],
"or": [LivenessBreakdownItemFilterInput],
"id": IntOperationFilterInput,
"identificationDocumentBiometrics": IdentificationDocumentBiometricsFilterInput,
"identificationDocumentBiomertricsId": IntOperationFilterInput,
"field": StringOperationFilterInput,
"value": BiometricCheckResultTypeOperationFilterInput
}
Location
LocationFilterInput
Fields
Input Field | Description |
---|---|
and - [LocationFilterInput!]
|
|
or - [LocationFilterInput!]
|
|
within - LocationInput
|
Example
{
"and": [LocationFilterInput],
"or": [LocationFilterInput],
"within": LocationInput
}
LocationInput
Long
Description
The Long
scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.
Example
{}
LongOperationFilterInput
Example
{
"eq": {},
"neq": {},
"in": [{}],
"nin": [{}],
"gt": {},
"ngt": {},
"gte": {},
"ngte": {},
"lt": {},
"nlt": {},
"lte": {},
"nlte": {}
}
Mortgage
Description
Mortgage / debenture data
Example
{
"date_created": "2007-12-03T10:15:30Z",
"type": "abc123",
"holder": "abc123",
"secured_on": "abc123",
"form_no": "xyz789",
"satisfied": "abc123",
"details": "abc123",
"mortgage_id": {},
"mortgage_no": 123,
"companies_company_id": 123,
"satisfied_date": "2007-12-03T10:15:30Z"
}
MortgageFilterInput
Fields
Input Field | Description |
---|---|
and - [MortgageFilterInput!]
|
|
or - [MortgageFilterInput!]
|
|
date_created - DateTimeOperationFilterInput
|
|
type - StringOperationFilterInput
|
|
holder - StringOperationFilterInput
|
|
secured_on - StringOperationFilterInput
|
|
form_no - StringOperationFilterInput
|
|
satisfied - StringOperationFilterInput
|
|
details - StringOperationFilterInput
|
|
mortgage_id - LongOperationFilterInput
|
|
mortgage_no - IntOperationFilterInput
|
|
companies_company_id - IntOperationFilterInput
|
|
satisfied_date - DateTimeOperationFilterInput
|
Example
{
"and": [MortgageFilterInput],
"or": [MortgageFilterInput],
"date_created": DateTimeOperationFilterInput,
"type": StringOperationFilterInput,
"holder": StringOperationFilterInput,
"secured_on": StringOperationFilterInput,
"form_no": StringOperationFilterInput,
"satisfied": StringOperationFilterInput,
"details": StringOperationFilterInput,
"mortgage_id": LongOperationFilterInput,
"mortgage_no": IntOperationFilterInput,
"companies_company_id": IntOperationFilterInput,
"satisfied_date": DateTimeOperationFilterInput
}
NoticeCodeType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
NoticeCodeTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - NoticeCodeType
|
|
neq - NoticeCodeType
|
|
in - [NoticeCodeType!]
|
|
nin - [NoticeCodeType!]
|
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
Notification
NotificationEventEnum
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"SPAM_REPORT"
NotificationEventEnumOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - NotificationEventEnum
|
|
neq - NotificationEventEnum
|
|
in - [NotificationEventEnum!]
|
|
nin - [NotificationEventEnum!]
|
Example
{
"eq": "SPAM_REPORT",
"neq": "SPAM_REPORT",
"in": ["SPAM_REPORT"],
"nin": ["SPAM_REPORT"]
}
NotificationFilterInput
Fields
Input Field | Description |
---|---|
and - [NotificationFilterInput!]
|
|
or - [NotificationFilterInput!]
|
|
id - IntOperationFilterInput
|
|
notificationType - IntOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
Example
{
"and": [NotificationFilterInput],
"or": [NotificationFilterInput],
"id": IntOperationFilterInput,
"notificationType": IntOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"portfolio": PortfolioFilterInput
}
NotificationHistory
NotificationHistoryFilterInput
Fields
Input Field | Description |
---|---|
and - [NotificationHistoryFilterInput!]
|
|
or - [NotificationHistoryFilterInput!]
|
|
portfolioEventId - IntOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
Example
{
"and": [NotificationHistoryFilterInput],
"or": [NotificationHistoryFilterInput],
"portfolioEventId": IntOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"portfolio": PortfolioFilterInput
}
NotificationTypeEnum
Values
Enum Value | Description |
---|---|
|
|
|
Example
"EMAIL"
NotificationTypeEnumOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - NotificationTypeEnum
|
|
neq - NotificationTypeEnum
|
|
in - [NotificationTypeEnum!]
|
|
nin - [NotificationTypeEnum!]
|
Example
{"eq": "EMAIL", "neq": "EMAIL", "in": ["EMAIL"], "nin": ["EMAIL"]}
NullableOfCheckTypeEnumOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CheckTypeEnum
|
|
neq - CheckTypeEnum
|
|
in - [CheckTypeEnum]
|
|
nin - [CheckTypeEnum]
|
Example
{
"eq": "KNOW_YOUR_CLIENT",
"neq": "KNOW_YOUR_CLIENT",
"in": ["KNOW_YOUR_CLIENT"],
"nin": ["KNOW_YOUR_CLIENT"]
}
NullableOfCompanyRatingOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyRating
|
|
neq - CompanyRating
|
|
in - [CompanyRating]
|
|
nin - [CompanyRating]
|
Example
{
"eq": "THREE_RED_FLAGS",
"neq": "THREE_RED_FLAGS",
"in": ["THREE_RED_FLAGS"],
"nin": ["THREE_RED_FLAGS"]
}
NullableOfCompanyReportReasonCodeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CompanyReportReasonCode
|
|
neq - CompanyReportReasonCode
|
|
in - [CompanyReportReasonCode]
|
|
nin - [CompanyReportReasonCode]
|
Example
{
"eq": "CREDIT_DECISION",
"neq": "CREDIT_DECISION",
"in": ["CREDIT_DECISION"],
"nin": ["CREDIT_DECISION"]
}
NullableOfCountryCodeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CountryCode
|
|
neq - CountryCode
|
|
in - [CountryCode]
|
|
nin - [CountryCode]
|
Example
{"eq": "AFG", "neq": "AFG", "in": ["AFG"], "nin": ["AFG"]}
NullableOfCurrencyCodeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - CurrencyCode
|
|
neq - CurrencyCode
|
|
in - [CurrencyCode]
|
|
nin - [CurrencyCode]
|
Example
{"eq": "AED", "neq": "AED", "in": ["AED"], "nin": ["AED"]}
NullableOfEventOperationFilterInput
NullableOfFileExportSelectionTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - FileExportSelectionType
|
|
neq - FileExportSelectionType
|
|
in - [FileExportSelectionType]
|
|
nin - [FileExportSelectionType]
|
Example
{
"eq": "ALL_COLUMNS",
"neq": "ALL_COLUMNS",
"in": ["ALL_COLUMNS"],
"nin": ["ALL_COLUMNS"]
}
NullableOfOrderedCompanyRatingOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - OrderedCompanyRating
|
|
neq - OrderedCompanyRating
|
|
in - [OrderedCompanyRating]
|
|
nin - [OrderedCompanyRating]
|
Example
{
"eq": "BUSINESS_DISCONTINUED",
"neq": "BUSINESS_DISCONTINUED",
"in": ["BUSINESS_DISCONTINUED"],
"nin": ["BUSINESS_DISCONTINUED"]
}
NullableOfRfaRatingOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - RfaRating
|
|
neq - RfaRating
|
|
in - [RfaRating]
|
|
nin - [RfaRating]
|
Example
{
"eq": "THREE_RED_FLAGS",
"neq": "THREE_RED_FLAGS",
"in": ["THREE_RED_FLAGS"],
"nin": ["THREE_RED_FLAGS"]
}
OrderedCompanyRating
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BUSINESS_DISCONTINUED"
PDFMetaFilterInput
Fields
Input Field | Description |
---|---|
and - [PDFMetaFilterInput!]
|
|
or - [PDFMetaFilterInput!]
|
|
companyName - StringOperationFilterInput
|
|
companyNumber - StringOperationFilterInput
|
|
countryCode - CountryCodeOperationFilterInput
|
Example
{
"and": [PDFMetaFilterInput],
"or": [PDFMetaFilterInput],
"companyName": StringOperationFilterInput,
"companyNumber": StringOperationFilterInput,
"countryCode": CountryCodeOperationFilterInput
}
POSC
Fields
Field Name | Description |
---|---|
id - Int!
|
|
companyno - String
|
|
address - String
|
|
principal_office_address - String
|
|
postcode - String
|
|
name - String
|
|
birthdate - String
|
|
nationality - String
|
|
country_of_residence - String
|
|
kind - String
|
|
natures_of_control - String
|
|
notified_on - String
|
|
ceased_on - String
|
|
is_sanctioned - Boolean!
|
|
statement - String
|
|
identification_country_registered - String
|
|
identification_legal_authority - String
|
|
identification_legal_form - String
|
|
identification_place_registered - String
|
|
identification_registeration_number - String
|
|
timestamp - Int!
|
Example
{
"id": 987,
"companyno": "abc123",
"address": "xyz789",
"principal_office_address": "xyz789",
"postcode": "xyz789",
"name": "abc123",
"birthdate": "abc123",
"nationality": "xyz789",
"country_of_residence": "xyz789",
"kind": "xyz789",
"natures_of_control": "xyz789",
"notified_on": "abc123",
"ceased_on": "xyz789",
"is_sanctioned": false,
"statement": "xyz789",
"identification_country_registered": "xyz789",
"identification_legal_authority": "abc123",
"identification_legal_form": "abc123",
"identification_place_registered": "xyz789",
"identification_registeration_number": "abc123",
"timestamp": 987
}
POSCFilterInput
Fields
Example
{
"and": [POSCFilterInput],
"or": [POSCFilterInput],
"id": IntOperationFilterInput,
"companyno": StringOperationFilterInput,
"address": StringOperationFilterInput,
"principal_office_address": StringOperationFilterInput,
"postcode": StringOperationFilterInput,
"name": StringOperationFilterInput,
"birthdate": StringOperationFilterInput,
"nationality": StringOperationFilterInput,
"country_of_residence": StringOperationFilterInput,
"kind": StringOperationFilterInput,
"natures_of_control": StringOperationFilterInput,
"notified_on": StringOperationFilterInput,
"ceased_on": StringOperationFilterInput,
"is_sanctioned": BooleanOperationFilterInput,
"statement": StringOperationFilterInput,
"identification_country_registered": StringOperationFilterInput,
"identification_legal_authority": StringOperationFilterInput,
"identification_legal_form": StringOperationFilterInput,
"identification_place_registered": StringOperationFilterInput,
"identification_registeration_number": StringOperationFilterInput,
"timestamp": IntOperationFilterInput
}
Person
Fields
Field Name | Description |
---|---|
id - String
|
|
premises - String
|
|
type - PersonRecordType!
|
|
source - String
|
|
title - String
|
|
forenames - String
|
|
surname - String
|
|
full_name - String
|
|
honours - String
|
|
careof - String
|
|
pobox - String
|
|
address_line_1 - String
|
|
address_line_2 - String
|
|
locality - String
|
|
county - String
|
|
country - String
|
|
occupation - String
|
|
nationality - String
|
|
country_of_residence - String
|
|
postcode - String
|
|
dob - DateTime
|
|
dob_partial - Boolean
|
|
company_id - Int!
|
|
director - DirectorPerson
|
|
insolvency - InsolvencyPerson
|
|
posc - PoscPerson
|
|
timestamp - Int!
|
|
relevance - Float
|
Example
{
"id": "xyz789",
"premises": "abc123",
"type": "DIRECTOR",
"source": "abc123",
"title": "xyz789",
"forenames": "xyz789",
"surname": "abc123",
"full_name": "xyz789",
"honours": "abc123",
"careof": "xyz789",
"pobox": "abc123",
"address_line_1": "xyz789",
"address_line_2": "abc123",
"locality": "xyz789",
"county": "abc123",
"country": "abc123",
"occupation": "abc123",
"nationality": "abc123",
"country_of_residence": "abc123",
"postcode": "abc123",
"dob": "2007-12-03T10:15:30Z",
"dob_partial": true,
"company_id": 987,
"director": DirectorPerson,
"insolvency": InsolvencyPerson,
"posc": PoscPerson,
"timestamp": 123,
"relevance": 123.45
}
PersonFilterInput
Fields
Example
{
"and": [PersonFilterInput],
"or": [PersonFilterInput],
"id": StringOperationFilterInput,
"premises": StringOperationFilterInput,
"type": PersonRecordTypeOperationFilterInput,
"source": StringOperationFilterInput,
"title": StringOperationFilterInput,
"forenames": StringOperationFilterInput,
"surname": StringOperationFilterInput,
"full_name": StringOperationFilterInput,
"honours": StringOperationFilterInput,
"careof": StringOperationFilterInput,
"pobox": StringOperationFilterInput,
"address_line_1": StringOperationFilterInput,
"address_line_2": StringOperationFilterInput,
"locality": StringOperationFilterInput,
"county": StringOperationFilterInput,
"country": StringOperationFilterInput,
"occupation": StringOperationFilterInput,
"nationality": StringOperationFilterInput,
"country_of_residence": StringOperationFilterInput,
"postcode": StringOperationFilterInput,
"dob": DateTimeOperationFilterInput,
"dob_partial": BooleanOperationFilterInput,
"company_id": IntOperationFilterInput,
"director": DirectorPersonFilterInput,
"insolvency": InsolvencyPersonFilterInput,
"posc": PoscPersonFilterInput,
"timestamp": IntOperationFilterInput,
"relevance": FloatOperationFilterInput
}
PersonRecordType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
Example
"DIRECTOR"
PersonRecordTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - PersonRecordType
|
|
neq - PersonRecordType
|
|
in - [PersonRecordType!]
|
|
nin - [PersonRecordType!]
|
Example
{"eq": "DIRECTOR", "neq": "DIRECTOR", "in": ["DIRECTOR"], "nin": ["DIRECTOR"]}
PersonSearchFilterInput
Fields
Example
{
"and": [PersonSearchFilterInput],
"or": [PersonSearchFilterInput],
"id": StringOperationFilterInput,
"premises": StringOperationFilterInput,
"type": PersonRecordTypeOperationFilterInput,
"source": StringOperationFilterInput,
"title": StringOperationFilterInput,
"forenames": StringOperationFilterInput,
"surname": StringOperationFilterInput,
"full_name": StringOperationFilterInput,
"honours": StringOperationFilterInput,
"careof": StringOperationFilterInput,
"pobox": StringOperationFilterInput,
"address_line_1": StringOperationFilterInput,
"address_line_2": StringOperationFilterInput,
"locality": StringOperationFilterInput,
"county": StringOperationFilterInput,
"country": StringOperationFilterInput,
"occupation": StringOperationFilterInput,
"nationality": StringOperationFilterInput,
"country_of_residence": StringOperationFilterInput,
"postcode": StringOperationFilterInput,
"dob": DateTimeOperationFilterInput,
"dob_partial": BooleanOperationFilterInput,
"company_id": IntOperationFilterInput,
"director": DirectorPersonFilterInput,
"insolvency": InsolvencyPersonFilterInput,
"posc": PoscPersonFilterInput,
"timestamp": IntOperationFilterInput,
"relevance": FloatOperationFilterInput
}
Portfolio
Fields
Field Name | Description |
---|---|
description - String
|
Description |
name - String
|
Name |
isPrivate - Boolean!
|
IsPrivate |
accountId - String
|
AccountId |
accountEmail - String
|
AccountEmail |
portfolioType - PortfolioType!
|
Type of portfolio |
id - Int!
|
Id |
notifications - [Notification]
|
Notification |
notificationHistory - [NotificationHistory]
|
NotificationHistory |
triggerEvents - [TriggerEvent]
|
TriggerEvents |
portfolioEvents - [PortfolioEvent]
|
PortfolioEvents |
Arguments
|
|
lastEventTime - DateTime
|
LastEventTime |
lastEventType - Event
|
LastEventType |
lastCompanyId - Int
|
LastCompanyId |
lastNotifiedEvent - Int!
|
LastNotifiedEvent |
portfolioRecipients - [PortfolioRecipients]
|
PortfolioRecipients |
totalCompaniesCount - Int
|
Total number of companies in portfolio |
Example
{
"description": "abc123",
"name": "abc123",
"isPrivate": false,
"accountId": "xyz789",
"accountEmail": "abc123",
"portfolioType": "NONE",
"id": 123,
"notifications": [Notification],
"notificationHistory": [NotificationHistory],
"triggerEvents": [TriggerEvent],
"portfolioEvents": [PortfolioEvent],
"lastEventTime": "2007-12-03T10:15:30Z",
"lastEventType": "BUSINESS_ADDRESS_AMENDED",
"lastCompanyId": 987,
"lastNotifiedEvent": 987,
"portfolioRecipients": [PortfolioRecipients],
"totalCompaniesCount": 123
}
PortfolioCompanyCountFilterInput
Fields
Input Field | Description |
---|---|
and - [PortfolioCompanyCountFilterInput!]
|
|
or - [PortfolioCompanyCountFilterInput!]
|
|
portfolioId - IntOperationFilterInput
|
|
count - LongOperationFilterInput
|
Example
{
"and": [PortfolioCompanyCountFilterInput],
"or": [PortfolioCompanyCountFilterInput],
"portfolioId": IntOperationFilterInput,
"count": LongOperationFilterInput
}
PortfolioCompanyCountSortInput
Fields
Input Field | Description |
---|---|
portfolioId - SortEnumType
|
|
count - SortEnumType
|
Example
{"portfolioId": "ASC", "count": "ASC"}
PortfolioEvent
Example
{
"eventId": "BUSINESS_ADDRESS_AMENDED",
"id": 123,
"companyId": 987,
"portfolio": Portfolio,
"eventDate": "2007-12-03T10:15:30Z",
"notes": "xyz789",
"company": CompanySearch
}
PortfolioEventCountFilterInput
Fields
Input Field | Description |
---|---|
and - [PortfolioEventCountFilterInput!]
|
|
or - [PortfolioEventCountFilterInput!]
|
|
portfolioId - IntOperationFilterInput
|
|
count - LongOperationFilterInput
|
Example
{
"and": [PortfolioEventCountFilterInput],
"or": [PortfolioEventCountFilterInput],
"portfolioId": IntOperationFilterInput,
"count": LongOperationFilterInput
}
PortfolioEventFilterInput
Fields
Input Field | Description |
---|---|
and - [PortfolioEventFilterInput!]
|
|
or - [PortfolioEventFilterInput!]
|
|
id - IntOperationFilterInput
|
|
companyId - IntOperationFilterInput
|
|
eventId - EventOperationFilterInput
|
|
notes - StringOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
eventDate - portfolio_DateTimeOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
|
eventType - EventTypeFilterInput
|
|
companyPortfolio - CompanyPortfolioFilterInput
|
Example
{
"and": [PortfolioEventFilterInput],
"or": [PortfolioEventFilterInput],
"id": IntOperationFilterInput,
"companyId": IntOperationFilterInput,
"eventId": EventOperationFilterInput,
"notes": StringOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"eventDate": portfolio_DateTimeOperationFilterInput,
"portfolio": PortfolioFilterInput,
"eventType": EventTypeFilterInput,
"companyPortfolio": CompanyPortfolioFilterInput
}
PortfolioEventSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
companyId - SortEnumType
|
|
eventId - SortEnumType
|
|
notes - SortEnumType
|
|
portfolioId - SortEnumType
|
|
eventDate - SortEnumType
|
|
portfolio - PortfolioSortInput
|
|
eventType - EventTypeSortInput
|
|
companyPortfolio - CompanyPortfolioSortInput
|
Example
{
"id": "ASC",
"companyId": "ASC",
"eventId": "ASC",
"notes": "ASC",
"portfolioId": "ASC",
"eventDate": "ASC",
"portfolio": PortfolioSortInput,
"eventType": EventTypeSortInput,
"companyPortfolio": CompanyPortfolioSortInput
}
PortfolioFilterInput
Fields
Example
{
"and": [PortfolioFilterInput],
"or": [PortfolioFilterInput],
"id": IntOperationFilterInput,
"userId": StringOperationFilterInput,
"name": StringOperationFilterInput,
"accountId": StringOperationFilterInput,
"accountEmail": StringOperationFilterInput,
"description": StringOperationFilterInput,
"createDate": portfolio_DateTimeOperationFilterInput,
"isPrivate": BooleanOperationFilterInput,
"reportScheduleTime": StringOperationFilterInput,
"isActive": BooleanOperationFilterInput,
"lastEventTime": portfolio_DateTimeOperationFilterInput,
"lastEventType": NullableOfEventOperationFilterInput,
"lastCompanyId": IntOperationFilterInput,
"lastNotifiedEvent": IntOperationFilterInput,
"portfolioType": PortfolioTypeOperationFilterInput,
"companyCount": PortfolioCompanyCountFilterInput,
"companyPortfolios": ListFilterInputTypeOfCompanyPortfolioFilterInput,
"notifications": ListFilterInputTypeOfNotificationFilterInput,
"notificationHistory": ListFilterInputTypeOfNotificationHistoryFilterInput,
"triggerEvents": ListFilterInputTypeOfTriggerEventFilterInput,
"portfolioEvents": ListFilterInputTypeOfPortfolioEventFilterInput,
"portfolioRecipients": ListFilterInputTypeOfPortfolioRecipientsFilterInput
}
PortfolioRecipients
PortfolioRecipientsFilterInput
Fields
Input Field | Description |
---|---|
and - [PortfolioRecipientsFilterInput!]
|
|
or - [PortfolioRecipientsFilterInput!]
|
|
id - IntOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
recipientEmail - StringOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
Example
{
"and": [PortfolioRecipientsFilterInput],
"or": [PortfolioRecipientsFilterInput],
"id": IntOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"recipientEmail": StringOperationFilterInput,
"portfolio": PortfolioFilterInput
}
PortfolioSortInput
Fields
Input Field | Description |
---|---|
id - SortEnumType
|
|
userId - SortEnumType
|
|
name - SortEnumType
|
|
accountId - SortEnumType
|
|
accountEmail - SortEnumType
|
|
description - SortEnumType
|
|
createDate - SortEnumType
|
|
isPrivate - SortEnumType
|
|
reportScheduleTime - SortEnumType
|
|
isActive - SortEnumType
|
|
lastEventTime - SortEnumType
|
|
lastEventType - SortEnumType
|
|
lastCompanyId - SortEnumType
|
|
lastNotifiedEvent - SortEnumType
|
|
portfolioType - SortEnumType
|
|
companyCount - PortfolioCompanyCountSortInput
|
Example
{
"id": "ASC",
"userId": "ASC",
"name": "ASC",
"accountId": "ASC",
"accountEmail": "ASC",
"description": "ASC",
"createDate": "ASC",
"isPrivate": "ASC",
"reportScheduleTime": "ASC",
"isActive": "ASC",
"lastEventTime": "ASC",
"lastEventType": "ASC",
"lastCompanyId": "ASC",
"lastNotifiedEvent": "ASC",
"portfolioType": "ASC",
"companyCount": PortfolioCompanyCountSortInput
}
PortfolioType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"NONE"
PortfolioTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - PortfolioType
|
|
neq - PortfolioType
|
|
in - [PortfolioType!]
|
|
nin - [PortfolioType!]
|
Example
{"eq": "NONE", "neq": "NONE", "in": ["NONE"], "nin": ["NONE"]}
PoscPerson
Fields
Field Name | Description |
---|---|
company_number - String
|
|
is_sanctioned - Boolean
|
|
kind - String
|
|
natures_of_control - String
|
|
identification_country_registered - String
|
|
identification_legal_authority - String
|
|
identification_legal_form - String
|
|
identification_place_registered - String
|
|
identification_registration_number - String
|
|
notified_on - DateTime
|
|
ceased_on - DateTime
|
|
company - CompanySearch
|
Example
{
"company_number": "abc123",
"is_sanctioned": false,
"kind": "abc123",
"natures_of_control": "xyz789",
"identification_country_registered": "abc123",
"identification_legal_authority": "abc123",
"identification_legal_form": "abc123",
"identification_place_registered": "abc123",
"identification_registration_number": "xyz789",
"notified_on": "2007-12-03T10:15:30Z",
"ceased_on": "2007-12-03T10:15:30Z",
"company": CompanySearch
}
PoscPersonFilterInput
Fields
Input Field | Description |
---|---|
and - [PoscPersonFilterInput!]
|
|
or - [PoscPersonFilterInput!]
|
|
company_number - StringOperationFilterInput
|
|
is_sanctioned - BooleanOperationFilterInput
|
|
kind - StringOperationFilterInput
|
|
natures_of_control - StringOperationFilterInput
|
|
identification_country_registered - StringOperationFilterInput
|
|
identification_legal_authority - StringOperationFilterInput
|
|
identification_legal_form - StringOperationFilterInput
|
|
identification_place_registered - StringOperationFilterInput
|
|
identification_registration_number - StringOperationFilterInput
|
|
notified_on - DateTimeOperationFilterInput
|
|
ceased_on - DateTimeOperationFilterInput
|
Example
{
"and": [PoscPersonFilterInput],
"or": [PoscPersonFilterInput],
"company_number": StringOperationFilterInput,
"is_sanctioned": BooleanOperationFilterInput,
"kind": StringOperationFilterInput,
"natures_of_control": StringOperationFilterInput,
"identification_country_registered": StringOperationFilterInput,
"identification_legal_authority": StringOperationFilterInput,
"identification_legal_form": StringOperationFilterInput,
"identification_place_registered": StringOperationFilterInput,
"identification_registration_number": StringOperationFilterInput,
"notified_on": DateTimeOperationFilterInput,
"ceased_on": DateTimeOperationFilterInput
}
PoscSummary
Profit_Loss
Fields
Field Name | Description |
---|---|
profit_loss_id - Long!
|
|
account_date - DateTime
|
|
no_weeks - Long
|
|
consolidated - String
|
|
currency - String
|
|
turnover - Long
|
|
cost_of_sales - Long
|
|
gross_profit - Long
|
|
operating_profit - Long
|
|
non_trading_income - Long
|
|
interest_payable - Long
|
|
pre_tax_profit - Long
|
|
taxation - Long
|
|
post_tax_profit - Long
|
|
dividends - Long
|
|
retained_profit - Long
|
|
value_added - Long
|
|
audit_fee - Long
|
|
director_renum - Long
|
|
non_audit_fee - Long
|
|
employees - Long
|
|
companies_company_id - Int!
|
|
ebitda - Long
|
Example
{
"profit_loss_id": {},
"account_date": "2007-12-03T10:15:30Z",
"no_weeks": {},
"consolidated": "xyz789",
"currency": "abc123",
"turnover": {},
"cost_of_sales": {},
"gross_profit": {},
"operating_profit": {},
"non_trading_income": {},
"interest_payable": {},
"pre_tax_profit": {},
"taxation": {},
"post_tax_profit": {},
"dividends": {},
"retained_profit": {},
"value_added": {},
"audit_fee": {},
"director_renum": {},
"non_audit_fee": {},
"employees": {},
"companies_company_id": 123,
"ebitda": {}
}
Profit_LossFilterInput
Fields
Example
{
"and": [Profit_LossFilterInput],
"or": [Profit_LossFilterInput],
"profit_loss_id": LongOperationFilterInput,
"account_date": DateTimeOperationFilterInput,
"no_weeks": LongOperationFilterInput,
"consolidated": StringOperationFilterInput,
"currency": StringOperationFilterInput,
"turnover": LongOperationFilterInput,
"cost_of_sales": LongOperationFilterInput,
"gross_profit": LongOperationFilterInput,
"operating_profit": LongOperationFilterInput,
"non_trading_income": LongOperationFilterInput,
"interest_payable": LongOperationFilterInput,
"pre_tax_profit": LongOperationFilterInput,
"taxation": LongOperationFilterInput,
"post_tax_profit": LongOperationFilterInput,
"dividends": LongOperationFilterInput,
"retained_profit": LongOperationFilterInput,
"value_added": LongOperationFilterInput,
"audit_fee": LongOperationFilterInput,
"director_renum": LongOperationFilterInput,
"non_audit_fee": LongOperationFilterInput,
"employees": LongOperationFilterInput,
"companies_company_id": IntOperationFilterInput,
"ebitda": LongOperationFilterInput
}
Rating_historyCollectionSegment
Description
A segment of a collection.
Fields
Field Name | Description |
---|---|
pageInfo - CollectionSegmentInfo!
|
Information to aid in pagination. |
items - [History]
|
A flattened list of the items. |
totalCount - Int!
|
Example
{
"pageInfo": CollectionSegmentInfo,
"items": [History],
"totalCount": 123
}
RatioAnalysis
Fields
Field Name | Description |
---|---|
liquidity_ratio - Decimal
|
|
profit_capital_employed - Decimal
|
|
current_ratio - Decimal
|
|
profit_sales - Decimal
|
|
interest_pre_interest_profit - Decimal
|
|
profit_total_assets - Decimal
|
|
profit_shareholder_funds - Decimal
|
|
turnover_total_assets - Decimal
|
|
turnover_fixed_assets - Decimal
|
|
working_capital_turnover - Decimal
|
|
total_debt_net_worth - Decimal
|
|
shareholders_funds_total_assets - Decimal
|
|
long_term_debt_net_worth - Decimal
|
|
total_debt_working_capital - Decimal
|
|
average_employee_remuneration - Decimal
|
|
wages_sales - Decimal
|
|
profit_per_employee - Decimal
|
|
sales_per_employee - Decimal
|
|
capital_employed_per_employee - Decimal
|
|
total_fixed_assets_per_employee - Decimal
|
|
total_assets_per_employee - Decimal
|
|
creditors_debtors - Decimal
|
|
debtors_total_assets - Decimal
|
|
current_liabilities_stocks - Decimal
|
|
export_sales - Decimal
|
|
sales_audit_fees - Decimal
|
|
total_assets_audit_fees - Decimal
|
|
account_date - DateTime
|
Example
{
"liquidity_ratio": Decimal,
"profit_capital_employed": Decimal,
"current_ratio": Decimal,
"profit_sales": Decimal,
"interest_pre_interest_profit": Decimal,
"profit_total_assets": Decimal,
"profit_shareholder_funds": Decimal,
"turnover_total_assets": Decimal,
"turnover_fixed_assets": Decimal,
"working_capital_turnover": Decimal,
"total_debt_net_worth": Decimal,
"shareholders_funds_total_assets": Decimal,
"long_term_debt_net_worth": Decimal,
"total_debt_working_capital": Decimal,
"average_employee_remuneration": Decimal,
"wages_sales": Decimal,
"profit_per_employee": Decimal,
"sales_per_employee": Decimal,
"capital_employed_per_employee": Decimal,
"total_fixed_assets_per_employee": Decimal,
"total_assets_per_employee": Decimal,
"creditors_debtors": Decimal,
"debtors_total_assets": Decimal,
"current_liabilities_stocks": Decimal,
"export_sales": Decimal,
"sales_audit_fees": Decimal,
"total_assets_audit_fees": Decimal,
"account_date": "2007-12-03T10:15:30Z"
}
RatioAnalysisFilterInput
Fields
Example
{
"and": [RatioAnalysisFilterInput],
"or": [RatioAnalysisFilterInput],
"liquidity_ratio": DecimalOperationFilterInput,
"profit_capital_employed": DecimalOperationFilterInput,
"current_ratio": DecimalOperationFilterInput,
"profit_sales": DecimalOperationFilterInput,
"interest_pre_interest_profit": DecimalOperationFilterInput,
"profit_total_assets": DecimalOperationFilterInput,
"profit_shareholder_funds": DecimalOperationFilterInput,
"turnover_total_assets": DecimalOperationFilterInput,
"turnover_fixed_assets": DecimalOperationFilterInput,
"working_capital_turnover": DecimalOperationFilterInput,
"total_debt_net_worth": DecimalOperationFilterInput,
"shareholders_funds_total_assets": DecimalOperationFilterInput,
"long_term_debt_net_worth": DecimalOperationFilterInput,
"total_debt_working_capital": DecimalOperationFilterInput,
"average_employee_remuneration": DecimalOperationFilterInput,
"wages_sales": DecimalOperationFilterInput,
"profit_per_employee": DecimalOperationFilterInput,
"sales_per_employee": DecimalOperationFilterInput,
"capital_employed_per_employee": DecimalOperationFilterInput,
"total_fixed_assets_per_employee": DecimalOperationFilterInput,
"total_assets_per_employee": DecimalOperationFilterInput,
"creditors_debtors": DecimalOperationFilterInput,
"debtors_total_assets": DecimalOperationFilterInput,
"current_liabilities_stocks": DecimalOperationFilterInput,
"export_sales": DecimalOperationFilterInput,
"sales_audit_fees": DecimalOperationFilterInput,
"total_assets_audit_fees": DecimalOperationFilterInput,
"account_date": DateTimeOperationFilterInput
}
RefreshCredentialsInput
Description
Refresh details
Fields
Input Field | Description |
---|---|
refreshToken - String
|
Refresh token |
Example
{"refreshToken": "xyz789"}
RfaRating
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"THREE_RED_FLAGS"
SIC07
Example
{
"code": "xyz789",
"description": "abc123",
"division": "xyz789",
"division_description": "abc123",
"priority": "abc123",
"section": "xyz789",
"section_description": "abc123",
"sic_class": "abc123",
"sic_class_description": "abc123",
"source": "abc123",
"sub_class": "abc123",
"sub_class_description": "abc123"
}
SIC07FilterInput
Fields
Input Field | Description |
---|---|
and - [SIC07FilterInput!]
|
|
or - [SIC07FilterInput!]
|
|
code - StringOperationFilterInput
|
|
description - StringOperationFilterInput
|
|
division - StringOperationFilterInput
|
|
division_description - StringOperationFilterInput
|
|
priority - StringOperationFilterInput
|
|
section - StringOperationFilterInput
|
|
section_description - StringOperationFilterInput
|
|
sic_class - StringOperationFilterInput
|
|
sic_class_description - StringOperationFilterInput
|
|
source - StringOperationFilterInput
|
|
sub_class - StringOperationFilterInput
|
|
sub_class_description - StringOperationFilterInput
|
Example
{
"and": [SIC07FilterInput],
"or": [SIC07FilterInput],
"code": StringOperationFilterInput,
"description": StringOperationFilterInput,
"division": StringOperationFilterInput,
"division_description": StringOperationFilterInput,
"priority": StringOperationFilterInput,
"section": StringOperationFilterInput,
"section_description": StringOperationFilterInput,
"sic_class": StringOperationFilterInput,
"sic_class_description": StringOperationFilterInput,
"source": StringOperationFilterInput,
"sub_class": StringOperationFilterInput,
"sub_class_description": StringOperationFilterInput
}
Sex
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"UNSPECIFIED"
SexOperationFilterInput
SignInCredentialsInput
SignInResponse
SmsConfiguration
SmsConfigurationFilterInput
Fields
Input Field | Description |
---|---|
and - [SmsConfigurationFilterInput!]
|
|
or - [SmsConfigurationFilterInput!]
|
|
accountId - StringOperationFilterInput
|
|
alphaNumericSenderId - StringOperationFilterInput
|
|
messagingServiceId - StringOperationFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [SmsConfigurationFilterInput],
"or": [SmsConfigurationFilterInput],
"accountId": StringOperationFilterInput,
"alphaNumericSenderId": StringOperationFilterInput,
"messagingServiceId": StringOperationFilterInput,
"account": AccountFilterInput
}
SmsConfigurationSortInput
Fields
Input Field | Description |
---|---|
accountId - SortEnumType
|
|
alphaNumericSenderId - SortEnumType
|
|
messagingServiceId - SortEnumType
|
|
account - AccountSortInput
|
Example
{
"accountId": "ASC",
"alphaNumericSenderId": "ASC",
"messagingServiceId": "ASC",
"account": AccountSortInput
}
SortEnumType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"ASC"
SourceKey
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
Example
"RFA"
SourceKeyOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - SourceKey
|
|
neq - SourceKey
|
|
in - [SourceKey!]
|
|
nin - [SourceKey!]
|
Example
{"eq": "RFA", "neq": "RFA", "in": ["RFA"], "nin": ["RFA"]}
StatType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
Example
"TOTAL_CHECKS"
StatisticDetail
String
Description
The String
scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StringOperationFilterInput
Example
{
"and": [StringOperationFilterInput],
"or": [StringOperationFilterInput],
"eq": "abc123",
"neq": "abc123",
"contains": "xyz789",
"ncontains": "xyz789",
"in": ["abc123"],
"nin": ["abc123"],
"startsWith": "abc123",
"nstartsWith": "xyz789",
"endsWith": "abc123",
"nendsWith": "xyz789"
}
Title
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSPECIFIED"
TitleOperationFilterInput
TriggerEvent
TriggerEventFilterInput
Fields
Input Field | Description |
---|---|
and - [TriggerEventFilterInput!]
|
|
or - [TriggerEventFilterInput!]
|
|
id - IntOperationFilterInput
|
|
eventId - EventOperationFilterInput
|
|
isImmediate - BooleanOperationFilterInput
|
|
portfolioId - IntOperationFilterInput
|
|
portfolio - PortfolioFilterInput
|
|
eventType - EventTypeFilterInput
|
Example
{
"and": [TriggerEventFilterInput],
"or": [TriggerEventFilterInput],
"id": IntOperationFilterInput,
"eventId": EventOperationFilterInput,
"isImmediate": BooleanOperationFilterInput,
"portfolioId": IntOperationFilterInput,
"portfolio": PortfolioFilterInput,
"eventType": EventTypeFilterInput
}
UUID
Example
"f541c7a1-b5fc-47db-a629-ece43a164ee3"
User
Description
User
Example
{
"id": "abc123",
"email": "abc123",
"name": "xyz789",
"givenNames": "abc123",
"surname": "abc123",
"activeAccount": Account,
"roles": [UserRole]
}
UserFilterInput
Fields
Input Field | Description |
---|---|
and - [UserFilterInput!]
|
|
or - [UserFilterInput!]
|
|
email - StringOperationFilterInput
|
|
name - StringOperationFilterInput
|
|
givenNames - StringOperationFilterInput
|
|
surname - StringOperationFilterInput
|
|
activeAccountId - StringOperationFilterInput
|
|
activeAccount - AccountFilterInput
|
|
accounts - ListFilterInputTypeOfAccountFilterInput
|
|
checks - ListFilterInputTypeOfCheckFilterInput
|
|
roles - ListFilterInputTypeOfUserRoleFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
Example
{
"and": [UserFilterInput],
"or": [UserFilterInput],
"email": StringOperationFilterInput,
"name": StringOperationFilterInput,
"givenNames": StringOperationFilterInput,
"surname": StringOperationFilterInput,
"activeAccountId": StringOperationFilterInput,
"activeAccount": AccountFilterInput,
"accounts": ListFilterInputTypeOfAccountFilterInput,
"checks": ListFilterInputTypeOfCheckFilterInput,
"roles": ListFilterInputTypeOfUserRoleFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput
}
UserQueryFilterInput
Fields
Input Field | Description |
---|---|
and - [UserQueryFilterInput!]
|
|
or - [UserQueryFilterInput!]
|
|
id - UuidOperationFilterInput
|
|
queryName - StringOperationFilterInput
|
|
queryValue - StringOperationFilterInput
|
|
variables - StringOperationFilterInput
|
|
createdDate - portfolio_DateTimeOperationFilterInput
|
|
rowsExported - IntOperationFilterInput
|
Example
{
"and": [UserQueryFilterInput],
"or": [UserQueryFilterInput],
"id": UuidOperationFilterInput,
"queryName": StringOperationFilterInput,
"queryValue": StringOperationFilterInput,
"variables": StringOperationFilterInput,
"createdDate": portfolio_DateTimeOperationFilterInput,
"rowsExported": IntOperationFilterInput
}
UserRole
Description
User Role
Fields
Field Name | Description |
---|---|
type - UserRoleType!
|
Role type |
Example
{"type": "ADMINISTRATOR"}
UserRoleFilterInput
Fields
Input Field | Description |
---|---|
and - [UserRoleFilterInput!]
|
|
or - [UserRoleFilterInput!]
|
|
userEmail - StringOperationFilterInput
|
|
type - UserRoleTypeOperationFilterInput
|
|
user - UserFilterInput
|
|
account - AccountFilterInput
|
|
accountId - StringOperationFilterInput
|
Example
{
"and": [UserRoleFilterInput],
"or": [UserRoleFilterInput],
"userEmail": StringOperationFilterInput,
"type": UserRoleTypeOperationFilterInput,
"user": UserFilterInput,
"account": AccountFilterInput,
"accountId": StringOperationFilterInput
}
UserRoleType
Values
Enum Value | Description |
---|---|
|
|
|
Example
"ADMINISTRATOR"
UserRoleTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - UserRoleType
|
|
neq - UserRoleType
|
|
in - [UserRoleType!]
|
|
nin - [UserRoleType!]
|
Example
{
"eq": "ADMINISTRATOR",
"neq": "ADMINISTRATOR",
"in": ["ADMINISTRATOR"],
"nin": ["ADMINISTRATOR"]
}
UserSearchType
UserSortInput
Fields
Input Field | Description |
---|---|
email - SortEnumType
|
|
name - SortEnumType
|
|
givenNames - SortEnumType
|
|
surname - SortEnumType
|
|
activeAccountId - SortEnumType
|
|
activeAccount - AccountSortInput
|
|
createdDate - SortEnumType
|
Example
{
"email": "ASC",
"name": "ASC",
"givenNames": "ASC",
"surname": "ASC",
"activeAccountId": "ASC",
"activeAccount": AccountSortInput,
"createdDate": "ASC"
}
UuidOperationFilterInput
Example
{
"eq": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"neq": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"in": [
"f541c7a1-b5fc-47db-a629-ece43a164ee3"
],
"nin": [
"f541c7a1-b5fc-47db-a629-ece43a164ee3"
],
"gt": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"ngt": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"gte": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"ngte": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"lt": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"nlt": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"lte": "f541c7a1-b5fc-47db-a629-ece43a164ee3",
"nlte": "f541c7a1-b5fc-47db-a629-ece43a164ee3"
}
Verification
Example
{
"id": 987,
"checkId": 123,
"check": Check,
"startedDate": "2007-12-03T10:15:30Z",
"completedDate": "2007-12-03T10:15:30Z",
"isCompleted": false,
"isStarted": true,
"type": "ADDRESS"
}
VerificationFilterInput
Fields
Input Field | Description |
---|---|
and - [VerificationFilterInput!]
|
|
or - [VerificationFilterInput!]
|
|
id - IntOperationFilterInput
|
|
checkId - IntOperationFilterInput
|
|
check - CheckFilterInput
|
|
startedDate - portfolio_DateTimeOperationFilterInput
|
|
completedDate - portfolio_DateTimeOperationFilterInput
|
|
isCompleted - BooleanOperationFilterInput
|
|
isStarted - BooleanOperationFilterInput
|
|
type - VerificationTypeOperationFilterInput
|
Example
{
"and": [VerificationFilterInput],
"or": [VerificationFilterInput],
"id": IntOperationFilterInput,
"checkId": IntOperationFilterInput,
"check": CheckFilterInput,
"startedDate": portfolio_DateTimeOperationFilterInput,
"completedDate": portfolio_DateTimeOperationFilterInput,
"isCompleted": BooleanOperationFilterInput,
"isStarted": BooleanOperationFilterInput,
"type": VerificationTypeOperationFilterInput
}
VerificationInput
Description
Verification Types
Fields
Input Field | Description |
---|---|
type - VerificationType!
|
Type of verification. |
Example
{"type": "ADDRESS"}
VerificationType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDRESS"
VerificationTypeOperationFilterInput
Fields
Input Field | Description |
---|---|
eq - VerificationType
|
|
neq - VerificationType
|
|
in - [VerificationType!]
|
|
nin - [VerificationType!]
|
Example
{"eq": "ADDRESS", "neq": "ADDRESS", "in": ["ADDRESS"], "nin": ["ADDRESS"]}
WebHook
WebHookFilterInput
Fields
Input Field | Description |
---|---|
and - [WebHookFilterInput!]
|
|
or - [WebHookFilterInput!]
|
|
id - IntOperationFilterInput
|
|
accountId - StringOperationFilterInput
|
|
url - StringOperationFilterInput
|
|
account - AccountFilterInput
|
Example
{
"and": [WebHookFilterInput],
"or": [WebHookFilterInput],
"id": IntOperationFilterInput,
"accountId": StringOperationFilterInput,
"url": StringOperationFilterInput,
"account": AccountFilterInput
}
account_CountryCode
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFG"
company_EventType
Values
Enum Value | Description |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NA"
portfolio_DateTimeOperationFilterInput
Example
{
"eq": "2007-12-03T10:15:30Z",
"neq": "2007-12-03T10:15:30Z",
"in": ["2007-12-03T10:15:30Z"],
"nin": ["2007-12-03T10:15:30Z"],
"gt": "2007-12-03T10:15:30Z",
"ngt": "2007-12-03T10:15:30Z",
"gte": "2007-12-03T10:15:30Z",
"ngte": "2007-12-03T10:15:30Z",
"lt": "2007-12-03T10:15:30Z",
"nlt": "2007-12-03T10:15:30Z",
"lte": "2007-12-03T10:15:30Z",
"nlte": "2007-12-03T10:15:30Z"
}