Red Flag Alert GraphQL Reference

Red Flag Alert GraphQL Reference
Playground
GraphiQL

Contact

Erin Fogarty

erin.fogarty@redflagalert.com

API Endpoints
https://graphql.redflagalert.net/graphql/

Queries

account

Response

Returns an AccountDetail

Example

Query
query account {
  account {
    creditBalance
    totalBillCount
    creditsSpent {
      ...AccountCreditSpendFragment
    }
  }
}
Response
{
  "data": {
    "account": {
      "creditBalance": 987,
      "totalBillCount": 123,
      "creditsSpent": [AccountCreditSpend]
    }
  }
}
Queries

accountReportLimits

Response

Returns [ReportLimit]

Example

Query
query accountReportLimits {
  accountReportLimits {
    billingRegion
    limit
  }
}
Response
{
  "data": {
    "accountReportLimits": [{"billingRegion": "REST_OF_WORLD", "limit": 123}]
  }
}
Queries

accountUsage

Response

Returns a CustomerAccount

Example

Query
query accountUsage {
  accountUsage {
    id
    name
    version
    companyReportRegionViews {
      ...CompanyReportRegionViewFragment
    }
  }
}
Response
{
  "data": {
    "accountUsage": {
      "id": "xyz789",
      "name": "abc123",
      "version": 987,
      "companyReportRegionViews": [
        CompanyReportRegionView
      ]
    }
  }
}
Queries

auditors

Response

Returns an AuditorsCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - AuditorFilterInput
order - [AuditorSortInput!]

Example

Query
query auditors(
  $skip: Int,
  $take: Int,
  $where: AuditorFilterInput,
  $order: [AuditorSortInput!]
) {
  auditors(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...AuditorFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": AuditorFilterInput,
  "order": [AuditorSortInput]
}
Response
{
  "data": {
    "auditors": {
      "pageInfo": CollectionSegmentInfo,
      "items": [Auditor],
      "totalCount": 123
    }
  }
}
Queries

companies

Response

Returns a CompaniesCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - CompanySearchFilterInput
order - [CompanySearchSortInput!]
countryCode - CountryCode
searchAfter - String

Example

Query
query companies(
  $skip: Int,
  $take: Int,
  $where: CompanySearchFilterInput,
  $order: [CompanySearchSortInput!],
  $countryCode: CountryCode,
  $searchAfter: String
) {
  companies(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order,
    countryCode: $countryCode,
    searchAfter: $searchAfter
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...CompanySearchFragment
    }
    totalCount
    aggregations {
      ...CompanyAggregateBucketFragment
    }
    searchAfter
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": CompanySearchFilterInput,
  "order": [CompanySearchSortInput],
  "countryCode": "AFG",
  "searchAfter": "xyz789"
}
Response
{
  "data": {
    "companies": {
      "pageInfo": CollectionSegmentInfo,
      "items": [CompanySearch],
      "totalCount": 123,
      "aggregations": [CompanyAggregateBucket],
      "searchAfter": "abc123"
    }
  }
}
Queries

company

Response

Returns a CompanySearch

Arguments
Name Description
id - Any!
countryCode - String

Example

Query
query company(
  $id: Any!,
  $countryCode: String
) {
  company(
    id: $id,
    countryCode: $countryCode
  ) {
    id
    company_id
    posc_summary {
      ...PoscSummaryFragment
    }
    rfa_rating
    rating_history {
      ...Rating_historyCollectionSegmentFragment
    }
    corporate_structure {
      ...CorporateEntityFragment
    }
    ultimate_parent {
      ...CorporateEntityFragment
    }
    ordered_rfa_rating
    rfa_rating_rank
    addresses {
      ...AddressFragment
    }
    active_directors {
      ...DirectorFragment
    }
    people {
      ...PersonFragment
    }
    gazette_notices {
      ...GazetteNoticeFragment
    }
    company_number
    mortgages {
      ...MortgageFragment
    }
    country_code
    archive {
      ...CompanyArchiveFragment
    }
    estimated_turnover
    estimated_employees
    employees
    turnover
    growth_score
    rfa_rating_score
    raw_rating_score
    incorporation_date
    dissolution_date
    dissolution_status
    total_assets
    last_filed_accounts
    accounts_next_due
    tps_registered
    gdpr_registered
    marketing_preference
    website
    primary_sic07_code
    revenue_increase
    creditor_days
    credit_score
    credit_limit
    sic92_sections
    sic92_codes
    sic92_descriptions
    primary_sic92_code
    sic07 {
      ...SIC07Fragment
    }
    sic07_codes
    sic07_descriptions
    sic07_sections
    sic07_section_descriptions
    sic07_divisions
    sic07_division_descriptions
    sic07_groups
    sic07_group_descriptions
    sic07_classes
    sic07_class_descriptions
    sic07_sub_classes
    sic07_sub_class_descriptions
    directors {
      ...DirectorPartialFragment
    }
    director_summary {
      ...DirectorSummaryFragment
    }
    credit_limits {
      ...CreditLimitFragment
    }
    oldest_director {
      ...DirectorFragment
    }
    has_directorships
    has_financials
    is_limited
    is_trading
    company_name
    legal_status
    auditor
    latest_action {
      ...Latest_ActionFragment
    }
    company_type
    history {
      ...HistoryFragment
    }
    ccjs {
      ...CCJFragment
    }
    possible_ccjs {
      ...CCJFragment
    }
    processed_at
    last_updated
    parent_company
    group_id
    telephone_number
    email
    has_contact
    has_phone_contact
    has_email_contact
    generated_rfa_rating
    previous_rfa_rating
    rating_changed_date
    previous_rating_changed_date
    current_directors {
      ...Current_DirectorsFragment
    }
    profit_loss {
      ...Profit_LossFragment
    }
    balance_sheet {
      ...Balance_SheetFragment
    }
    creditors {
      ...CreditorFragment
    }
    debtors {
      ...DebtorFragment
    }
    detrimental_data {
      ...DetrimentalDataFragment
    }
    shareholders {
      ...ShareholderFragment
    }
    poscs {
      ...POSCFragment
    }
    former_names {
      ...FormerNameFragment
    }
    cashflow {
      ...CashFlowFragment
    }
    ratio_analysis {
      ...RatioAnalysisFragment
    }
    contacts {
      ...ContactFragment
    }
    functional_currency
    vat_number
    beneficial_owners {
      ...BeneficialOwnerFragment
    }
  }
}
Variables
{
  "id": Any,
  "countryCode": "abc123"
}
Response
{
  "data": {
    "company": {
      "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",
      "rfa_rating_rank": 123,
      "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": "abc123",
      "total_assets": {},
      "last_filed_accounts": "2007-12-03T10:15:30Z",
      "accounts_next_due": "2007-12-03T10:15:30Z",
      "tps_registered": true,
      "gdpr_registered": true,
      "marketing_preference": "abc123",
      "website": "xyz789",
      "primary_sic07_code": "xyz789",
      "revenue_increase": {},
      "creditor_days": {},
      "credit_score": Decimal,
      "credit_limit": Decimal,
      "sic92_sections": ["abc123"],
      "sic92_codes": ["xyz789"],
      "sic92_descriptions": ["abc123"],
      "primary_sic92_code": "xyz789",
      "sic07": [SIC07],
      "sic07_codes": ["xyz789"],
      "sic07_descriptions": ["xyz789"],
      "sic07_sections": ["xyz789"],
      "sic07_section_descriptions": [
        "xyz789"
      ],
      "sic07_divisions": ["abc123"],
      "sic07_division_descriptions": [
        "abc123"
      ],
      "sic07_groups": ["xyz789"],
      "sic07_group_descriptions": [
        "xyz789"
      ],
      "sic07_classes": ["abc123"],
      "sic07_class_descriptions": [
        "xyz789"
      ],
      "sic07_sub_classes": ["abc123"],
      "sic07_sub_class_descriptions": [
        "xyz789"
      ],
      "directors": [DirectorPartial],
      "director_summary": DirectorSummary,
      "credit_limits": [CreditLimit],
      "oldest_director": Director,
      "has_directorships": false,
      "has_financials": false,
      "is_limited": false,
      "is_trading": false,
      "company_name": "xyz789",
      "legal_status": "xyz789",
      "auditor": "abc123",
      "latest_action": Latest_Action,
      "company_type": "abc123",
      "history": [History],
      "ccjs": [CCJ],
      "possible_ccjs": [CCJ],
      "processed_at": "2007-12-03T10:15:30Z",
      "last_updated": "2007-12-03T10:15:30Z",
      "parent_company": "abc123",
      "group_id": "xyz789",
      "telephone_number": "abc123",
      "email": "xyz789",
      "has_contact": true,
      "has_phone_contact": true,
      "has_email_contact": false,
      "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",
      "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]
    }
  }
}
Queries

companyHistories

Response

Returns a CompanyHistoriesCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - HistoryFilterInput
order - [HistorySortInput!]
countryCode - CountryCode
searchAfter - String

Example

Query
query companyHistories(
  $skip: Int,
  $take: Int,
  $where: HistoryFilterInput,
  $order: [HistorySortInput!],
  $countryCode: CountryCode,
  $searchAfter: String
) {
  companyHistories(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order,
    countryCode: $countryCode,
    searchAfter: $searchAfter
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...HistoryFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": HistoryFilterInput,
  "order": [HistorySortInput],
  "countryCode": "AFG",
  "searchAfter": "abc123"
}
Response
{
  "data": {
    "companyHistories": {
      "pageInfo": CollectionSegmentInfo,
      "items": [History],
      "totalCount": 123
    }
  }
}
Queries

companyPortfolios

Response

Returns a CompanyPortfoliosCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - CompanyPortfolioFilterInput
order - [CompanyPortfolioSortInput!] Default = [{createdTime: DESC}]

Example

Query
query companyPortfolios(
  $skip: Int,
  $take: Int,
  $where: CompanyPortfolioFilterInput,
  $order: [CompanyPortfolioSortInput!]
) {
  companyPortfolios(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...CompanyPortfolioFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": CompanyPortfolioFilterInput,
  "order": [{"createdTime": "DESC"}]
}
Response
{
  "data": {
    "companyPortfolios": {
      "pageInfo": CollectionSegmentInfo,
      "items": [CompanyPortfolio],
      "totalCount": 987
    }
  }
}
Queries

companyReport

Response

Returns a CompanyReport

Arguments
Name Description
reportRequest - CompanyReportRequestInput

Example

Query
query companyReport($reportRequest: CompanyReportRequestInput) {
  companyReport(reportRequest: $reportRequest) {
    rfa_rating_summary
    corporate_structure {
      ...CorporateEntityFragment
    }
    persons_with_significant_control {
      ...PersonsWithSignificantControlFragment
    }
    filing_history {
      ...FilingHistoryFragment
    }
    people {
      ...PersonFragment
    }
    beneficial_owner_graph {
      ...BeneficialOwnerGraphFragment
    }
    beneficial_owners {
      ...BeneficialOwnerFragment
    }
    active_directors {
      ...DirectorFragment
    }
    history {
      ...HistoryCollectionSegmentFragment
    }
    rfa_rating_breakdown {
      ...RatingBreakdownResultFragment
    }
    country_code
    archive_id
    archive {
      ...CompanyArchiveFragment
    }
    id
    company_id
    estimated_turnover
    estimated_employees
    employees
    turnover
    growth_score
    rfa_rating_score
    raw_rating_score
    company_number
    incorporation_date
    dissolution_date
    dissolution_status
    total_assets
    last_filed_accounts
    accounts_next_due
    tps_registered
    gdpr_registered
    marketing_preference
    website
    primary_sic07_code
    revenue_increase
    creditor_days
    credit_score
    credit_limit
    sic92_sections
    sic92_codes
    sic92_descriptions
    primary_sic92_code
    sic07 {
      ...SIC07Fragment
    }
    sic07_codes
    sic07_descriptions
    sic07_sections
    sic07_section_descriptions
    sic07_divisions
    sic07_division_descriptions
    sic07_groups
    sic07_group_descriptions
    sic07_classes
    sic07_class_descriptions
    sic07_sub_classes
    sic07_sub_class_descriptions
    directors {
      ...DirectorPartialFragment
    }
    director_summary {
      ...DirectorSummaryFragment
    }
    credit_limits {
      ...CreditLimitFragment
    }
    oldest_director {
      ...DirectorFragment
    }
    has_directorships
    has_financials
    is_limited
    is_trading
    addresses {
      ...AddressFragment
    }
    company_name
    legal_status
    auditor
    latest_action {
      ...Latest_ActionFragment
    }
    company_type
    mortgages {
      ...MortgageFragment
    }
    gazette_notices {
      ...GazetteNoticeFragment
    }
    ccjs {
      ...CCJFragment
    }
    possible_ccjs {
      ...CCJFragment
    }
    processed_at
    last_updated
    parent_company
    group_id
    telephone_number
    email
    has_contact
    has_phone_contact
    has_email_contact
    rfa_rating
    generated_rfa_rating
    previous_rfa_rating
    rating_changed_date
    previous_rating_changed_date
    ordered_rfa_rating
    current_directors {
      ...Current_DirectorsFragment
    }
    profit_loss {
      ...Profit_LossFragment
    }
    balance_sheet {
      ...Balance_SheetFragment
    }
    creditors {
      ...CreditorFragment
    }
    debtors {
      ...DebtorFragment
    }
    detrimental_data {
      ...DetrimentalDataFragment
    }
    shareholders {
      ...ShareholderFragment
    }
    poscs {
      ...POSCFragment
    }
    former_names {
      ...FormerNameFragment
    }
    cashflow {
      ...CashFlowFragment
    }
    ratio_analysis {
      ...RatioAnalysisFragment
    }
    contacts {
      ...ContactFragment
    }
    functional_currency
    vat_number
    rfa_rating_rank
    amlResult {
      ...AmlResultFragment
    }
  }
}
Variables
{"reportRequest": CompanyReportRequestInput}
Response
{
  "data": {
    "companyReport": {
      "rfa_rating_summary": "abc123",
      "corporate_structure": [CorporateEntity],
      "persons_with_significant_control": [
        PersonsWithSignificantControl
      ],
      "filing_history": [FilingHistory],
      "people": [Person],
      "beneficial_owner_graph": BeneficialOwnerGraph,
      "beneficial_owners": [BeneficialOwner],
      "active_directors": [Director],
      "history": HistoryCollectionSegment,
      "rfa_rating_breakdown": RatingBreakdownResult,
      "country_code": "AFG",
      "archive_id": "abc123",
      "archive": [CompanyArchive],
      "id": 123,
      "company_id": "xyz789",
      "estimated_turnover": Decimal,
      "estimated_employees": 987,
      "employees": {},
      "turnover": Decimal,
      "growth_score": 987.65,
      "rfa_rating_score": 987.65,
      "raw_rating_score": 123.45,
      "company_number": "xyz789",
      "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": true,
      "marketing_preference": "xyz789",
      "website": "abc123",
      "primary_sic07_code": "abc123",
      "revenue_increase": {},
      "creditor_days": {},
      "credit_score": Decimal,
      "credit_limit": Decimal,
      "sic92_sections": ["xyz789"],
      "sic92_codes": ["abc123"],
      "sic92_descriptions": ["abc123"],
      "primary_sic92_code": "xyz789",
      "sic07": [SIC07],
      "sic07_codes": ["abc123"],
      "sic07_descriptions": ["abc123"],
      "sic07_sections": ["abc123"],
      "sic07_section_descriptions": [
        "xyz789"
      ],
      "sic07_divisions": ["xyz789"],
      "sic07_division_descriptions": [
        "xyz789"
      ],
      "sic07_groups": ["xyz789"],
      "sic07_group_descriptions": [
        "abc123"
      ],
      "sic07_classes": ["abc123"],
      "sic07_class_descriptions": [
        "xyz789"
      ],
      "sic07_sub_classes": ["abc123"],
      "sic07_sub_class_descriptions": [
        "xyz789"
      ],
      "directors": [DirectorPartial],
      "director_summary": DirectorSummary,
      "credit_limits": [CreditLimit],
      "oldest_director": Director,
      "has_directorships": true,
      "has_financials": true,
      "is_limited": false,
      "is_trading": false,
      "addresses": [Address],
      "company_name": "xyz789",
      "legal_status": "abc123",
      "auditor": "abc123",
      "latest_action": Latest_Action,
      "company_type": "xyz789",
      "mortgages": [Mortgage],
      "gazette_notices": [GazetteNotice],
      "ccjs": [CCJ],
      "possible_ccjs": [CCJ],
      "processed_at": "2007-12-03T10:15:30Z",
      "last_updated": "2007-12-03T10:15:30Z",
      "parent_company": "abc123",
      "group_id": "abc123",
      "telephone_number": "abc123",
      "email": "abc123",
      "has_contact": true,
      "has_phone_contact": false,
      "has_email_contact": false,
      "rfa_rating": "THREE_RED_FLAGS",
      "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",
      "ordered_rfa_rating": "BUSINESS_DISCONTINUED",
      "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": "xyz789",
      "rfa_rating_rank": 123,
      "amlResult": AmlResult
    }
  }
}
Queries

companyReportArchives

Response

Returns a CompanyReportArchivesCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - CompanyReportArchiveFilterInput
order - [CompanyReportArchiveSortInput!]

Example

Query
query companyReportArchives(
  $skip: Int,
  $take: Int,
  $where: CompanyReportArchiveFilterInput,
  $order: [CompanyReportArchiveSortInput!]
) {
  companyReportArchives(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...CompanyReportArchiveFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": CompanyReportArchiveFilterInput,
  "order": [CompanyReportArchiveSortInput]
}
Response
{
  "data": {
    "companyReportArchives": {
      "pageInfo": CollectionSegmentInfo,
      "items": [CompanyReportArchive],
      "totalCount": 123
    }
  }
}
Queries

directors

Response

Returns a DirectorsCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - DirectorFilterInput
order - [DirectorSortInput!]

Example

Query
query directors(
  $skip: Int,
  $take: Int,
  $where: DirectorFilterInput,
  $order: [DirectorSortInput!]
) {
  directors(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...DirectorFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": DirectorFilterInput,
  "order": [DirectorSortInput]
}
Response
{
  "data": {
    "directors": {
      "pageInfo": CollectionSegmentInfo,
      "items": [Director],
      "totalCount": 987
    }
  }
}
Queries

eventTypes

Response

Returns [EventType]

Arguments
Name Description
where - EventTypeFilterInput
order - [EventTypeSortInput!]
portfolioType - PortfolioType

Example

Query
query eventTypes(
  $where: EventTypeFilterInput,
  $order: [EventTypeSortInput!],
  $portfolioType: PortfolioType
) {
  eventTypes(
    where: $where,
    order: $order,
    portfolioType: $portfolioType
  ) {
    description
    name
    id
  }
}
Variables
{
  "where": EventTypeFilterInput,
  "order": [EventTypeSortInput],
  "portfolioType": "NONE"
}
Response
{
  "data": {
    "eventTypes": [
      {
        "description": "xyz789",
        "name": "xyz789",
        "id": "BUSINESS_ADDRESS_AMENDED"
      }
    ]
  }
}
Queries

fileExportCounts

Response

Returns an Int

Arguments
Name Description
fileExportStatuses - [FileExportStatus!]

Example

Query
query fileExportCounts($fileExportStatuses: [FileExportStatus!]) {
  fileExportCounts(fileExportStatuses: $fileExportStatuses)
}
Variables
{"fileExportStatuses": ["REQUESTED"]}
Response
{"data": {"fileExportCounts": 987}}
Queries

fileExports

Response

Returns a FileExportsCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - FileExportFilterInput

Example

Query
query fileExports(
  $skip: Int,
  $take: Int,
  $where: FileExportFilterInput
) {
  fileExports(
    skip: $skip,
    take: $take,
    where: $where
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...FileExportFragment
    }
    totalCount
  }
}
Variables
{"skip": 0, "take": 10, "where": FileExportFilterInput}
Response
{
  "data": {
    "fileExports": {
      "pageInfo": CollectionSegmentInfo,
      "items": [FileExport],
      "totalCount": 123
    }
  }
}
Queries

idAccounts

Response

Returns an AccountsCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - AccountFilterInput
order - [AccountSortInput!]

Example

Query
query idAccounts(
  $skip: Int,
  $take: Int,
  $where: AccountFilterInput,
  $order: [AccountSortInput!]
) {
  idAccounts(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...AccountFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": AccountFilterInput,
  "order": [AccountSortInput]
}
Response
{
  "data": {
    "idAccounts": {
      "pageInfo": CollectionSegmentInfo,
      "items": [Account],
      "totalCount": 987
    }
  }
}
Queries

idCheck

Response

Returns a Check

Arguments
Name Description
id - Int!

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": 987}
Response
{
  "data": {
    "idCheck": {
      "options": CheckOptions,
      "id": 987,
      "detail": DigitalCheckDetail,
      "authenticationLink": AuthenticationLink,
      "checkStartUrl": "xyz789",
      "user": User,
      "reference": "xyz789",
      "bulkReference": "xyz789",
      "isBulk": true,
      "isMonitored": true,
      "createdDate": "2007-12-03T10:15:30Z",
      "result": CheckResult,
      "statuses": [CheckStatus],
      "verificationTypes": [Verification],
      "checkType": "KNOW_YOUR_CLIENT",
      "notifications": [CheckNotification]
    }
  }
}
Queries

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
    }
  }
}
Queries

people

Response

Returns a PeopleCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - PersonSearchFilterInput
order - [PersonSearchSortInput!]

Example

Query
query people(
  $skip: Int,
  $take: Int,
  $where: PersonSearchFilterInput,
  $order: [PersonSearchSortInput!]
) {
  people(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...PersonSearchFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": PersonSearchFilterInput,
  "order": [PersonSearchSortInput]
}
Response
{
  "data": {
    "people": {
      "pageInfo": CollectionSegmentInfo,
      "items": [PersonSearch],
      "totalCount": 123
    }
  }
}
Queries

personReport

Response

Returns a PeopleCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - PersonSearchFilterInput
order - [PersonSearchSortInput!]

Example

Query
query personReport(
  $skip: Int,
  $take: Int,
  $where: PersonSearchFilterInput,
  $order: [PersonSearchSortInput!]
) {
  personReport(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...PersonSearchFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": PersonSearchFilterInput,
  "order": [PersonSearchSortInput]
}
Response
{
  "data": {
    "personReport": {
      "pageInfo": CollectionSegmentInfo,
      "items": [PersonSearch],
      "totalCount": 987
    }
  }
}
Queries

portfolioCompanies

Response

Returns a CompaniesCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - CompanySearchFilterInput
order - [CompanySearchSortInput!]
countryCode - CountryCode
portfolioId - Int

Example

Query
query portfolioCompanies(
  $skip: Int,
  $take: Int,
  $where: CompanySearchFilterInput,
  $order: [CompanySearchSortInput!],
  $countryCode: CountryCode,
  $portfolioId: Int
) {
  portfolioCompanies(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order,
    countryCode: $countryCode,
    portfolioId: $portfolioId
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...CompanySearchFragment
    }
    totalCount
    aggregations {
      ...CompanyAggregateBucketFragment
    }
    searchAfter
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": CompanySearchFilterInput,
  "order": [CompanySearchSortInput],
  "countryCode": "AFG",
  "portfolioId": 123
}
Response
{
  "data": {
    "portfolioCompanies": {
      "pageInfo": CollectionSegmentInfo,
      "items": [CompanySearch],
      "totalCount": 123,
      "aggregations": [CompanyAggregateBucket],
      "searchAfter": "abc123"
    }
  }
}
Queries

portfolioEvents

Response

Returns a PortfolioEventsCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
filterUnacknowledgedEvents - Boolean! Default = false
where - PortfolioEventFilterInput
order - [PortfolioEventSortInput!] Default = [{eventId: DESC}]

Example

Query
query portfolioEvents(
  $skip: Int,
  $take: Int,
  $filterUnacknowledgedEvents: Boolean!,
  $where: PortfolioEventFilterInput,
  $order: [PortfolioEventSortInput!]
) {
  portfolioEvents(
    skip: $skip,
    take: $take,
    filterUnacknowledgedEvents: $filterUnacknowledgedEvents,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...PortfolioEventFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "filterUnacknowledgedEvents": false,
  "where": PortfolioEventFilterInput,
  "order": [{"eventId": "DESC"}]
}
Response
{
  "data": {
    "portfolioEvents": {
      "pageInfo": CollectionSegmentInfo,
      "items": [PortfolioEvent],
      "totalCount": 123
    }
  }
}
Queries

portfolios

Response

Returns a PortfoliosCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - PortfolioFilterInput
order - [PortfolioSortInput!] Default = [{id: DESC}]

Example

Query
query portfolios(
  $skip: Int,
  $take: Int,
  $where: PortfolioFilterInput,
  $order: [PortfolioSortInput!]
) {
  portfolios(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...PortfolioFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": PortfolioFilterInput,
  "order": [{"id": "DESC"}]
}
Response
{
  "data": {
    "portfolios": {
      "pageInfo": CollectionSegmentInfo,
      "items": [Portfolio],
      "totalCount": 987
    }
  }
}
Queries

serviceAnnouncements

Response

Returns [ServiceAnnouncement]

Arguments
Name Description
order - [ServiceAnnouncementSortInput!]

Example

Query
query serviceAnnouncements($order: [ServiceAnnouncementSortInput!]) {
  serviceAnnouncements(order: $order) {
    id
    title
    details
    type
    creationDate
  }
}
Variables
{"order": [ServiceAnnouncementSortInput]}
Response
{
  "data": {
    "serviceAnnouncements": [
      {
        "id": "abc123",
        "title": "abc123",
        "details": "xyz789",
        "type": "SERVICE_ALERT",
        "creationDate": "2007-12-03T10:15:30Z"
      }
    ]
  }
}
Queries

userQueries

Response

Returns a UserQueriesCollectionSegment

Arguments
Name Description
skip - Int Default = 0
take - Int Default = 10
where - UserQueryFilterInput
order - [UserQuerySortInput!]

Example

Query
query userQueries(
  $skip: Int,
  $take: Int,
  $where: UserQueryFilterInput,
  $order: [UserQuerySortInput!]
) {
  userQueries(
    skip: $skip,
    take: $take,
    where: $where,
    order: $order
  ) {
    pageInfo {
      ...CollectionSegmentInfoFragment
    }
    items {
      ...UserQueryFragment
    }
    totalCount
  }
}
Variables
{
  "skip": 0,
  "take": 10,
  "where": UserQueryFilterInput,
  "order": [UserQuerySortInput]
}
Response
{
  "data": {
    "userQueries": {
      "pageInfo": CollectionSegmentInfo,
      "items": [UserQuery],
      "totalCount": 987
    }
  }
}

Mutations

addCompanyToPortfolio

Response

Returns [CompanyPortfolio]

Arguments
Name Description
companyPortfolio - CompanyPortfolioInput

Example

Query
mutation addCompanyToPortfolio($companyPortfolio: CompanyPortfolioInput) {
  addCompanyToPortfolio(companyPortfolio: $companyPortfolio) {
    companyId
    portfolioId
    notes
    portfolio {
      ...PortfolioFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    accountEmail
    createdTime
    id
    company {
      ...CompanySearchFragment
    }
  }
}
Variables
{"companyPortfolio": CompanyPortfolioInput}
Response
{
  "data": {
    "addCompanyToPortfolio": [
      {
        "companyId": 123,
        "portfolioId": 987,
        "notes": "xyz789",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "abc123",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 123,
        "company": CompanySearch
      }
    ]
  }
}
Mutations

addNewPortfolioEvents

Response

Returns [NewEventPortfolioInfo]

Arguments
Name Description
eventInput - [NewEventInput]

Example

Query
mutation addNewPortfolioEvents($eventInput: [NewEventInput]) {
  addNewPortfolioEvents(eventInput: $eventInput) {
    companyId
    eventId
    eventDate
    isImmediate
    portfolioId
    notes
    company {
      ...CompanySearchFragment
    }
  }
}
Variables
{"eventInput": [NewEventInput]}
Response
{
  "data": {
    "addNewPortfolioEvents": [
      {
        "companyId": 987,
        "eventId": "BUSINESS_ADDRESS_AMENDED",
        "eventDate": "2007-12-03T10:15:30Z",
        "isImmediate": true,
        "portfolioId": 123,
        "notes": "xyz789",
        "company": CompanySearch
      }
    ]
  }
}
Mutations

addScheduledExport

Response

Returns a String

Arguments
Name Description
request - CustomScheduledExportRequestInput

Example

Query
mutation addScheduledExport($request: CustomScheduledExportRequestInput) {
  addScheduledExport(request: $request)
}
Variables
{"request": CustomScheduledExportRequestInput}
Response
{"data": {"addScheduledExport": "abc123"}}
Mutations

bill

Response

Returns a Boolean!

Arguments
Name Description
bill - BillingInput

Example

Query
mutation bill($bill: BillingInput) {
  bill(bill: $bill)
}
Variables
{"bill": BillingInput}
Response
{"data": {"bill": false}}
Mutations

cancelFileExports

Response

Returns [FileExport]

Arguments
Name Description
exportIds - [String]

Example

Query
mutation cancelFileExports($exportIds: [String]) {
  cancelFileExports(exportIds: $exportIds) {
    columnSelection
    resultSelection
    apiQuery
    variables
    fieldType
    status
    rowCount
    acknowledged
    id
    timestamp
    createdDate
    completedDate
    relativePath
    exportType
    description
    totalResults
    etaSeconds
    isCancelled
    legacyId
    fileLocation
    downloadLocation
    isScheduledExport
    exportReference
    meta {
      ...FileExportMetaFragment
    }
  }
}
Variables
{"exportIds": ["xyz789"]}
Response
{
  "data": {
    "cancelFileExports": [
      {
        "columnSelection": "ALL_COLUMNS",
        "resultSelection": "ALL_COLUMNS",
        "apiQuery": "xyz789",
        "variables": "abc123",
        "fieldType": "abc123",
        "status": "REQUESTED",
        "rowCount": 123,
        "acknowledged": false,
        "id": "xyz789",
        "timestamp": "2007-12-03T10:15:30Z",
        "createdDate": "2007-12-03T10:15:30Z",
        "completedDate": "2007-12-03T10:15:30Z",
        "relativePath": "abc123",
        "exportType": "CSV",
        "description": "abc123",
        "totalResults": 123,
        "etaSeconds": 987,
        "isCancelled": true,
        "legacyId": "abc123",
        "fileLocation": "xyz789",
        "downloadLocation": "xyz789",
        "isScheduledExport": true,
        "exportReference": "abc123",
        "meta": FileExportMeta
      }
    ]
  }
}
Mutations

copyCompaniesToPortfolio

Response

Returns [CompanyPortfolio]

Arguments
Name Description
copyCompanyPortfolio - CopyPortfolioInput

Example

Query
mutation copyCompaniesToPortfolio($copyCompanyPortfolio: CopyPortfolioInput) {
  copyCompaniesToPortfolio(copyCompanyPortfolio: $copyCompanyPortfolio) {
    companyId
    portfolioId
    notes
    portfolio {
      ...PortfolioFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    accountEmail
    createdTime
    id
    company {
      ...CompanySearchFragment
    }
  }
}
Variables
{"copyCompanyPortfolio": CopyPortfolioInput}
Response
{
  "data": {
    "copyCompaniesToPortfolio": [
      {
        "companyId": 987,
        "portfolioId": 123,
        "notes": "abc123",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "xyz789",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 987,
        "company": CompanySearch
      }
    ]
  }
}
Mutations

createPortfolio

Response

Returns a Portfolio

Arguments
Name Description
portfolio - CreatePortfolioInput

Example

Query
mutation createPortfolio($portfolio: CreatePortfolioInput) {
  createPortfolio(portfolio: $portfolio) {
    description
    name
    isPrivate
    accountId
    accountEmail
    portfolioType
    id
    notifications {
      ...NotificationFragment
    }
    notificationHistory {
      ...NotificationHistoryFragment
    }
    triggerEvents {
      ...TriggerEventFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    lastEventTime
    lastEventType
    lastCompanyId
    lastNotifiedEvent
    portfolioRecipients {
      ...PortfolioRecipientsFragment
    }
    totalCompaniesCount
  }
}
Variables
{"portfolio": CreatePortfolioInput}
Response
{
  "data": {
    "createPortfolio": {
      "description": "abc123",
      "name": "abc123",
      "isPrivate": true,
      "accountId": "abc123",
      "accountEmail": "abc123",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "BUSINESS_ADDRESS_AMENDED",
      "lastCompanyId": 123,
      "lastNotifiedEvent": 987,
      "portfolioRecipients": [PortfolioRecipients],
      "totalCompaniesCount": 123
    }
  }
}
Mutations

deletePortfolio

Response

Returns a Portfolio

Arguments
Name Description
portfolio - DeletePortfolioInput

Example

Query
mutation deletePortfolio($portfolio: DeletePortfolioInput) {
  deletePortfolio(portfolio: $portfolio) {
    description
    name
    isPrivate
    accountId
    accountEmail
    portfolioType
    id
    notifications {
      ...NotificationFragment
    }
    notificationHistory {
      ...NotificationHistoryFragment
    }
    triggerEvents {
      ...TriggerEventFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    lastEventTime
    lastEventType
    lastCompanyId
    lastNotifiedEvent
    portfolioRecipients {
      ...PortfolioRecipientsFragment
    }
    totalCompaniesCount
  }
}
Variables
{"portfolio": DeletePortfolioInput}
Response
{
  "data": {
    "deletePortfolio": {
      "description": "abc123",
      "name": "abc123",
      "isPrivate": true,
      "accountId": "xyz789",
      "accountEmail": "abc123",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "BUSINESS_ADDRESS_AMENDED",
      "lastCompanyId": 987,
      "lastNotifiedEvent": 123,
      "portfolioRecipients": [PortfolioRecipients],
      "totalCompaniesCount": 123
    }
  }
}
Mutations

fileExportAcknowledge

Response

Returns a FileExport

Arguments
Name Description
exportId - String

Example

Query
mutation fileExportAcknowledge($exportId: String) {
  fileExportAcknowledge(exportId: $exportId) {
    columnSelection
    resultSelection
    apiQuery
    variables
    fieldType
    status
    rowCount
    acknowledged
    id
    timestamp
    createdDate
    completedDate
    relativePath
    exportType
    description
    totalResults
    etaSeconds
    isCancelled
    legacyId
    fileLocation
    downloadLocation
    isScheduledExport
    exportReference
    meta {
      ...FileExportMetaFragment
    }
  }
}
Variables
{"exportId": "xyz789"}
Response
{
  "data": {
    "fileExportAcknowledge": {
      "columnSelection": "ALL_COLUMNS",
      "resultSelection": "ALL_COLUMNS",
      "apiQuery": "xyz789",
      "variables": "xyz789",
      "fieldType": "abc123",
      "status": "REQUESTED",
      "rowCount": 123,
      "acknowledged": true,
      "id": "abc123",
      "timestamp": "2007-12-03T10:15:30Z",
      "createdDate": "2007-12-03T10:15:30Z",
      "completedDate": "2007-12-03T10:15:30Z",
      "relativePath": "abc123",
      "exportType": "CSV",
      "description": "abc123",
      "totalResults": 987,
      "etaSeconds": 987,
      "isCancelled": false,
      "legacyId": "abc123",
      "fileLocation": "xyz789",
      "downloadLocation": "abc123",
      "isScheduledExport": false,
      "exportReference": "abc123",
      "meta": FileExportMeta
    }
  }
}
Mutations

fileExportRequest

Response

Returns a FileExport

Arguments
Name Description
fileExportRequest - FileExportRequestInput

Example

Query
mutation fileExportRequest($fileExportRequest: FileExportRequestInput) {
  fileExportRequest(fileExportRequest: $fileExportRequest) {
    columnSelection
    resultSelection
    apiQuery
    variables
    fieldType
    status
    rowCount
    acknowledged
    id
    timestamp
    createdDate
    completedDate
    relativePath
    exportType
    description
    totalResults
    etaSeconds
    isCancelled
    legacyId
    fileLocation
    downloadLocation
    isScheduledExport
    exportReference
    meta {
      ...FileExportMetaFragment
    }
  }
}
Variables
{"fileExportRequest": FileExportRequestInput}
Response
{
  "data": {
    "fileExportRequest": {
      "columnSelection": "ALL_COLUMNS",
      "resultSelection": "ALL_COLUMNS",
      "apiQuery": "xyz789",
      "variables": "abc123",
      "fieldType": "abc123",
      "status": "REQUESTED",
      "rowCount": 123,
      "acknowledged": false,
      "id": "xyz789",
      "timestamp": "2007-12-03T10:15:30Z",
      "createdDate": "2007-12-03T10:15:30Z",
      "completedDate": "2007-12-03T10:15:30Z",
      "relativePath": "xyz789",
      "exportType": "CSV",
      "description": "xyz789",
      "totalResults": 987,
      "etaSeconds": 987,
      "isCancelled": false,
      "legacyId": "xyz789",
      "fileLocation": "abc123",
      "downloadLocation": "xyz789",
      "isScheduledExport": false,
      "exportReference": "xyz789",
      "meta": FileExportMeta
    }
  }
}
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": "abc123",
      "user": User,
      "reference": "abc123",
      "bulkReference": "xyz789",
      "isBulk": false,
      "isMonitored": true,
      "createdDate": "2007-12-03T10:15:30Z",
      "result": CheckResult,
      "statuses": [CheckStatus],
      "verificationTypes": [Verification],
      "checkType": "KNOW_YOUR_CLIENT",
      "notifications": [CheckNotification]
    }
  }
}
Mutations

idCreateChecksBulk

Response

Returns [Check]

Arguments
Name Description
checkRequests - [CheckRequestInput]

Example

Query
mutation idCreateChecksBulk($checkRequests: [CheckRequestInput]) {
  idCreateChecksBulk(checkRequests: $checkRequests) {
    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
{"checkRequests": [CheckRequestInput]}
Response
{
  "data": {
    "idCreateChecksBulk": [
      {
        "options": CheckOptions,
        "id": 987,
        "detail": DigitalCheckDetail,
        "authenticationLink": AuthenticationLink,
        "checkStartUrl": "abc123",
        "user": User,
        "reference": "abc123",
        "bulkReference": "abc123",
        "isBulk": false,
        "isMonitored": false,
        "createdDate": "2007-12-03T10:15:30Z",
        "result": CheckResult,
        "statuses": [CheckStatus],
        "verificationTypes": [Verification],
        "checkType": "KNOW_YOUR_CLIENT",
        "notifications": [CheckNotification]
      }
    ]
  }
}
Mutations

idCreateNote

Response

Returns a Note

Arguments
Name Description
noteRequest - CreateNoteInput

Example

Query
mutation idCreateNote($noteRequest: CreateNoteInput) {
  idCreateNote(noteRequest: $noteRequest) {
    id
    checkResultId
    user {
      ...UserFragment
    }
    created
    noteText
    overriddenStatusType
  }
}
Variables
{"noteRequest": CreateNoteInput}
Response
{
  "data": {
    "idCreateNote": {
      "id": 123,
      "checkResultId": 987,
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "noteText": "abc123",
      "overriddenStatusType": "PASS"
    }
  }
}
Mutations

idCreateOverrideNote

Response

Returns a Note

Arguments
Name Description
overrideNoteRequest - CreateOverrideNoteInput

Example

Query
mutation idCreateOverrideNote($overrideNoteRequest: CreateOverrideNoteInput) {
  idCreateOverrideNote(overrideNoteRequest: $overrideNoteRequest) {
    id
    checkResultId
    user {
      ...UserFragment
    }
    created
    noteText
    overriddenStatusType
  }
}
Variables
{"overrideNoteRequest": CreateOverrideNoteInput}
Response
{
  "data": {
    "idCreateOverrideNote": {
      "id": 987,
      "checkResultId": 123,
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "noteText": "abc123",
      "overriddenStatusType": "PASS"
    }
  }
}
Mutations

idResendCheckNotifications

Response

Returns [Int]

Arguments
Name Description
checkIds - [Int!]

Example

Query
mutation idResendCheckNotifications($checkIds: [Int!]) {
  idResendCheckNotifications(checkIds: $checkIds)
}
Variables
{"checkIds": [987]}
Response
{"data": {"idResendCheckNotifications": [123]}}
Mutations

idVerificationCompleted

Response

Returns a VerificationResult

Arguments
Name Description
checkId - Int
code - String

Example

Query
mutation idVerificationCompleted(
  $checkId: Int,
  $code: String
) {
  idVerificationCompleted(
    checkId: $checkId,
    code: $code
  ) {
    result
  }
}
Variables
{"checkId": 987, "code": "abc123"}
Response
{
  "data": {
    "idVerificationCompleted": {
      "result": "xyz789"
    }
  }
}
Mutations

idVerificationStarted

Response

Returns a VerificationLinkResponse

Arguments
Name Description
checkId - Int

Example

Query
mutation idVerificationStarted($checkId: Int) {
  idVerificationStarted(checkId: $checkId) {
    reference
    message
    verificationRequestUrl
    verificationStartUrl
  }
}
Variables
{"checkId": 123}
Response
{
  "data": {
    "idVerificationStarted": {
      "reference": "abc123",
      "message": "xyz789",
      "verificationRequestUrl": "abc123",
      "verificationStartUrl": "abc123"
    }
  }
}
Mutations

modifyPortfolio

Response

Returns a Portfolio

Arguments
Name Description
portfolio - ModifyPortfolioInput

Example

Query
mutation modifyPortfolio($portfolio: ModifyPortfolioInput) {
  modifyPortfolio(portfolio: $portfolio) {
    description
    name
    isPrivate
    accountId
    accountEmail
    portfolioType
    id
    notifications {
      ...NotificationFragment
    }
    notificationHistory {
      ...NotificationHistoryFragment
    }
    triggerEvents {
      ...TriggerEventFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    lastEventTime
    lastEventType
    lastCompanyId
    lastNotifiedEvent
    portfolioRecipients {
      ...PortfolioRecipientsFragment
    }
    totalCompaniesCount
  }
}
Variables
{"portfolio": ModifyPortfolioInput}
Response
{
  "data": {
    "modifyPortfolio": {
      "description": "xyz789",
      "name": "xyz789",
      "isPrivate": true,
      "accountId": "abc123",
      "accountEmail": "abc123",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "BUSINESS_ADDRESS_AMENDED",
      "lastCompanyId": 123,
      "lastNotifiedEvent": 987,
      "portfolioRecipients": [PortfolioRecipients],
      "totalCompaniesCount": 987
    }
  }
}
Mutations

modifyPortfolioRecipient

Response

Returns [Recipient]

Arguments
Name Description
portfolioRecipient - PortfolioRecipientInput

Example

Query
mutation modifyPortfolioRecipient($portfolioRecipient: PortfolioRecipientInput) {
  modifyPortfolioRecipient(portfolioRecipient: $portfolioRecipient) {
    recipientEmail
    isActive
  }
}
Variables
{"portfolioRecipient": PortfolioRecipientInput}
Response
{
  "data": {
    "modifyPortfolioRecipient": [
      {
        "recipientEmail": "abc123",
        "isActive": false
      }
    ]
  }
}
Mutations

modifyTriggerEvent

Response

Returns [Triggers]

Arguments
Name Description
triggerEvent - TriggerEventInput

Example

Query
mutation modifyTriggerEvent($triggerEvent: TriggerEventInput) {
  modifyTriggerEvent(triggerEvent: $triggerEvent) {
    eventId
    isImmediate
    isActive
  }
}
Variables
{"triggerEvent": TriggerEventInput}
Response
{
  "data": {
    "modifyTriggerEvent": [
      {
        "eventId": "BUSINESS_ADDRESS_AMENDED",
        "isImmediate": true,
        "isActive": true
      }
    ]
  }
}
Mutations

removeCompanyFromPortfolio

Response

Returns [CompanyPortfolio]

Arguments
Name Description
companyPortfolio - CompanyPortfolioInput

Example

Query
mutation removeCompanyFromPortfolio($companyPortfolio: CompanyPortfolioInput) {
  removeCompanyFromPortfolio(companyPortfolio: $companyPortfolio) {
    companyId
    portfolioId
    notes
    portfolio {
      ...PortfolioFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    accountEmail
    createdTime
    id
    company {
      ...CompanySearchFragment
    }
  }
}
Variables
{"companyPortfolio": CompanyPortfolioInput}
Response
{
  "data": {
    "removeCompanyFromPortfolio": [
      {
        "companyId": 987,
        "portfolioId": 987,
        "notes": "xyz789",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "xyz789",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 123,
        "company": CompanySearch
      }
    ]
  }
}
Mutations

setPortfolioLastEvent

Response

Returns a Portfolio

Arguments
Name Description
portfolio - ModifyPortfolioLastEventInput

Example

Query
mutation setPortfolioLastEvent($portfolio: ModifyPortfolioLastEventInput) {
  setPortfolioLastEvent(portfolio: $portfolio) {
    description
    name
    isPrivate
    accountId
    accountEmail
    portfolioType
    id
    notifications {
      ...NotificationFragment
    }
    notificationHistory {
      ...NotificationHistoryFragment
    }
    triggerEvents {
      ...TriggerEventFragment
    }
    portfolioEvents {
      ...PortfolioEventFragment
    }
    lastEventTime
    lastEventType
    lastCompanyId
    lastNotifiedEvent
    portfolioRecipients {
      ...PortfolioRecipientsFragment
    }
    totalCompaniesCount
  }
}
Variables
{"portfolio": ModifyPortfolioLastEventInput}
Response
{
  "data": {
    "setPortfolioLastEvent": {
      "description": "xyz789",
      "name": "abc123",
      "isPrivate": false,
      "accountId": "abc123",
      "accountEmail": "abc123",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "BUSINESS_ADDRESS_AMENDED",
      "lastCompanyId": 987,
      "lastNotifiedEvent": 123,
      "portfolioRecipients": [PortfolioRecipients],
      "totalCompaniesCount": 123
    }
  }
}
Mutations

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": "xyz789",
      "refreshToken": "xyz789",
      "expiresInSeconds": 987
    }
  }
}
Mutations

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": "abc123",
      "refreshToken": "xyz789",
      "expiresInSeconds": 123
    }
  }
}
Mutations

submitInvestigationRequest

Response

Returns an InvestigationRequestSubmitResult

Arguments
Name Description
request - InvestigationRequestInput

Example

Query
mutation submitInvestigationRequest($request: InvestigationRequestInput) {
  submitInvestigationRequest(request: $request) {
    success
    message
  }
}
Variables
{"request": InvestigationRequestInput}
Response
{
  "data": {
    "submitInvestigationRequest": {
      "success": true,
      "message": "abc123"
    }
  }
}

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
fromDays - Int
Example
{
  "id": "xyz789",
  "companyName": "abc123",
  "redirectCompleteUrl": "abc123",
  "redirectStartUrl": "xyz789",
  "accountTypeId": "RFA",
  "webHooks": [WebHook],
  "users": [User],
  "gbgConfiguration": GbGConfiguration,
  "smsConfiguration": SmsConfiguration,
  "idKitConfiguration": IdKitConfiguration,
  "accountSummary": AccountSumary,
  "accountStatistics": [StatisticDetail],
  "checkHighlights": [CheckHighlight]
}
Types

AccountCreditSpend

Fields
Field Name Description
amount - Int!
createdAt - DateTime!
note - String
Example
{
  "amount": 123,
  "createdAt": "2007-12-03T10:15:30Z",
  "note": "xyz789"
}
Types

AccountDetail

Description

Account details

Fields
Field Name Description
creditBalance - Int! Account credit balance
totalBillCount - Int! Total number of bills made to the account
creditsSpent - [AccountCreditSpend] Account credit report
Arguments
skip - Int
take - Int
Example
{
  "creditBalance": 123,
  "totalBillCount": 123,
  "creditsSpent": [AccountCreditSpend]
}
Types

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
}
Types

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"
}
Types

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": true,
  "canCreateChecks": true,
  "totalChecksLastDay": 123
}
Types

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
}
Types

AccountTypeId

Values
Enum Value Description

RFA

ID4S
Example
"RFA"
Types

AccountTypeIdOperationFilterInput

Fields
Input Field Description
eq - AccountTypeId
neq - AccountTypeId
in - [AccountTypeId!]
nin - [AccountTypeId!]
Example
{"eq": "RFA", "neq": "RFA", "in": ["RFA"], "nin": ["RFA"]}
Types

AccountTypeSortInput

Fields
Input Field Description
accountTypeId - SortEnumType
accountTypeName - SortEnumType
Example
{"accountTypeId": "ASC", "accountTypeName": "ASC"}
Types

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
}
Types

AccountsCollectionSegment

Description

A segment of a collection.

Fields
Field Name Description
pageInfo - CollectionSegmentInfo! Information to aid in pagination.
items - [Account] A flattened list of the items.
totalCount - Int!
Example
{
  "pageInfo": CollectionSegmentInfo,
  "items": [Account],
  "totalCount": 987
}
Types

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": "abc123",
  "address_line_3": "xyz789",
  "address_line_4": "xyz789",
  "town": "abc123",
  "county": "abc123",
  "country": "abc123",
  "country_code": "AFG",
  "postcode": "xyz789",
  "type": "xyz789",
  "location": Location,
  "postcode_area": "xyz789",
  "postcode_district": "xyz789",
  "original_county": "xyz789",
  "district": "abc123",
  "os_easting": 987,
  "os_northing": 123,
  "la_ua_gsscode": "xyz789",
  "la_ua_name": "abc123",
  "region": "xyz789",
  "lep_name": "abc123",
  "combined_authority_name": "abc123"
}
Types

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
}
Types

AddressVerificationCheckType

Values
Enum Value Description

INTERNATIONAL_PASSPORT

UK_DRIVING_LICENSE

UK_ELECTORAL_ROLL

UK_LANDLINE

UK_NATIONAL_IDENTITY_REGISTER

UK_CREDIT_HEADER

UK_MORTALITY

UKNCAO

INTERNATIONAL_SANCTIONS_ENHANCED

INTERNATIONAL_PEP_ENHANCED

UK_CREDIT_BUREAU

UK_COMBINED_DECISION

US_IDENTITY

US_POPULATION

CANADA_CREDIT

SAUDI_IDENTITY
Example
"INTERNATIONAL_PASSPORT"
Types

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"]
}
Types

AddressVerificationDecision

Values
Enum Value Description

NA

PASS

REFER

ALERT
Example
"NA"
Types

AddressVerificationDecisionOperationFilterInput

Fields
Input Field Description
eq - AddressVerificationDecision
neq - AddressVerificationDecision
in - [AddressVerificationDecision!]
nin - [AddressVerificationDecision!]
Example
{"eq": "NA", "neq": "NA", "in": ["NA"], "nin": ["NA"]}
Types

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": "abc123"
}
Types

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
}
Types

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": 123,
  "itemSource": "INTERNATIONAL_PASSPORT",
  "itemType": "OVERALL",
  "itemResult": "NA"
}
Types

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
}
Types

AddressVerificationMatchResult

Values
Enum Value Description

NA

MATCH

MISMATCH

NO_MATCH
Example
"NA"
Types

AddressVerificationMatchResultOperationFilterInput

Fields
Input Field Description
eq - AddressVerificationMatchResult
neq - AddressVerificationMatchResult
in - [AddressVerificationMatchResult!]
nin - [AddressVerificationMatchResult!]
Example
{"eq": "NA", "neq": "NA", "in": ["NA"], "nin": ["NA"]}
Types

AddressVerificationMatchType

Values
Enum Value Description

OVERALL

ADDRESS

FORENAME

SURNAME

DATE_OF_BIRTH
Example
"OVERALL"
Types

AddressVerificationMatchTypeOperationFilterInput

Fields
Input Field Description
eq - AddressVerificationMatchType
neq - AddressVerificationMatchType
in - [AddressVerificationMatchType!]
nin - [AddressVerificationMatchType!]
Example
{"eq": "OVERALL", "neq": "OVERALL", "in": ["OVERALL"], "nin": ["OVERALL"]}
Types

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": 123,
  "id": "abc123",
  "decision": "NA",
  "details": [AddressVerificationDetail],
  "items": [AddressVerificationItem]
}
Types

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
}
Types

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"
}
Types

AddressVerificationResultType

Values
Enum Value Description

MATCH

MISMATCH

WARNING

COMMENT
Example
"MATCH"
Types

AddressVerificationResultTypeOperationFilterInput

Fields
Input Field Description
eq - AddressVerificationResultType
neq - AddressVerificationResultType
in - [AddressVerificationResultType!]
nin - [AddressVerificationResultType!]
Example
{"eq": "MATCH", "neq": "MATCH", "in": ["MATCH"], "nin": ["MATCH"]}
Types

AmlAddress

Description

AML Address

Fields
Field Name Description
id - Int! AML Address Id
fullAddress - String AML full address
country - String AML address country
Example
{
  "id": 987,
  "fullAddress": "xyz789",
  "country": "abc123"
}
Types

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
}
Types

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]
}
Types

AmlEntityAsset

Description

AML Entity Asset

Fields
Field Name Description
id - Int! AML Entity Asset Id
url - String AML Entity Asset Url
source - String AML Entity Asset Source
type - String AML Entity Asset Type
Example
{
  "id": 987,
  "url": "abc123",
  "source": "xyz789",
  "type": "xyz789"
}
Types

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
}
Types

AmlEntityAssociate

Description

AML Entity Associate

Fields
Field Name Description
id - Int! AML Entity Associate Id
name - String AML Entity Associate Name
type - String AML Entity Associate Type
comment - String AML Entity Associate Comment
Example
{
  "id": 987,
  "name": "xyz789",
  "type": "abc123",
  "comment": "abc123"
}
Types

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
}
Types

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
}
Types

AmlEntityMedia

Description

AML Media

Fields
Field Name Description
id - Int! AML Media Id
dateTime - DateTime! AML Media DateTime
title - String AML Media Title
snippet - String AML Media Snippet
url - String AML Media Url
Example
{
  "id": 123,
  "dateTime": "2007-12-03T10:15:30Z",
  "title": "xyz789",
  "snippet": "abc123",
  "url": "abc123"
}
Types

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
}
Types

AmlEntityType

Values
Enum Value Description

PERSON

COMPANY

ORGANISATION

VESSEL

AIRCRAFT

UNKNOWN
Example
"PERSON"
Types

AmlEntityTypeOperationFilterInput

Fields
Input Field Description
eq - AmlEntityType
neq - AmlEntityType
in - [AmlEntityType!]
nin - [AmlEntityType!]
Example
{"eq": "PERSON", "neq": "PERSON", "in": ["PERSON"], "nin": ["PERSON"]}
Types

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]
}
Types

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
}
Types

AmlMatchType

Values
Enum Value Description

UNKNOWN

NAME_EXACT

AKA_EXACT

NAME_FUZZY

AKA_FUZZY

INITIAL_NAME

PHONETIC_NAME

PHONETIC_AKA

EQUIVALENT_NAME

EQUIVALENT_AKA

YEAR_OF_BIRTH

REMOVED_PERSONAL_TITLE

REMOVED_PERSONAL_SUFFIX

REMOVED_ORGANISATION_PREFIX

REMOVED_ORGANISATION_SUFFIX

REMOVED_CLERICAL_MARK

EDIT_DISTANCE

PHONETIC

WORD_TO_INITIAL

INITIAL_TO_WORD

REMOVED_SPACES

WORD_TO_DIGIT

DIGIT_TO_WORD

NAME_VARIATIONS_REMOVAL

EXACT_MATCH

EXACT_BIRTH_YEAR_MATCH

FUZZY_BIRTH_YEAR_MATCH

FORENAME

SURNAME

DATE_OF_BIRTH

ADDRESS

PASS
Example
"UNKNOWN"
Types

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": "xyz789",
  "field": "abc123",
  "type": "abc123",
  "matchTypes": ["UNKNOWN"]
}
Types

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
}
Types

AmlMatchTypeOperationFilterInput

Fields
Input Field Description
eq - AmlMatchType
neq - AmlMatchType
in - [AmlMatchType!]
nin - [AmlMatchType!]
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
Types

AmlPosition

Description

AML Position Asset

Fields
Field Name Description
id - Int! AML Position Id
position - String AML Position
country - String AML Country
Example
{
  "id": 123,
  "position": "abc123",
  "country": "abc123"
}
Types

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
}
Types

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]
}
Types

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
}
Types

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": 987,
  "status": "UNKNOWN",
  "riskLevel": "UNKNOWN",
  "createdDate": "2007-12-03T10:15:30Z",
  "identificationProvider": IdentificationProvider
}
Types

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
}
Types

AmlRiskLevel

Values
Enum Value Description

UNKNOWN

LOW

MEDIUM

HIGH
Example
"UNKNOWN"
Types

AmlRiskLevelOperationFilterInput

Fields
Input Field Description
eq - AmlRiskLevel
neq - AmlRiskLevel
in - [AmlRiskLevel!]
nin - [AmlRiskLevel!]
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
Types

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"]
}
Types

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
}
Types

AmlStatus

Values
Enum Value Description

UNKNOWN

NO_MATCH

FALSE_POSITIVE

POTENTIAL_MATCH

TRUE_POSITIVE
Example
"UNKNOWN"
Types

AmlStatusOperationFilterInput

Fields
Input Field Description
eq - AmlStatus
neq - AmlStatus
in - [AmlStatus!]
nin - [AmlStatus!]
Example
{"eq": "UNKNOWN", "neq": "UNKNOWN", "in": ["UNKNOWN"], "nin": ["UNKNOWN"]}
Types

AmlType

Values
Enum Value Description

SANCTION

WARNING

FITNESS_PROBITY

PEP

PEP_CLASS1

PEP_CLASS2

PEP_CLASS3

PEP_CLASS4

ADVERSE_MEDIA

ADVERSE_MEDIA_FINANCIAL_CRIME

ADVERSE_MEDIA_VIOLENT_CRIME

ADVERSE_MEDIA_SEXUAL_CRIME

ADVERSE_MEDIA_TERRORISM

ADVERSE_MEDIA_FRAUD

ADVERSE_MEDIA_NARCOTICS

ADVERSE_MEDIA_GENERAL

UNKNOWN

ADVERSE_MEDIA_V2_PROPERTY

ADVERSE_MEDIA_V2_FINANCIAL_AML_CFT

ADVERSE_MEDIA_V2_FRAUD_LINKED

ADVERSE_MEDIA_V2_NARCOTICS_AML_CFT

ADVERSE_MEDIA_V2_VIOLENCE_AML_CFT

ADVERSE_MEDIA_V2_TERRORISM

ADVERSE_MEDIA_V2_CYBERCRIME

ADVERSE_MEDIA_V2_GENERAL_AML_CFT

ADVERSE_MEDIA_V2_REGULATORY

ADVERSE_MEDIA_V2_FINANCIAL_DIFFICULTY

ADVERSE_MEDIA_V2_VIOLENCE_NON_AML_CFT

ADVERSE_MEDIA_V2_OTHER_FINANCIAL

ADVERSE_MEDIA_V2_OTHER_SERIOUS

ADVERSE_MEDIA_V2_OTHER_MINOR

ACTIVIST

AMLKYC_COMPLIANCE

EXCLUSION_DEBARMENT

FINANCIAL

GLOBAL_CRIMINAL

GLOBAL_HEALTHCARE

GLOBAL_WATCH_LISTS_AND_SANCTIONS

IMPORT_EXPORT

NATIONAL_CRIMINAL_FILE

NATIONAL_HEALTH_CARE

OFFICE_OF_THE_INSPECTOR_GENERAL

SAM_GOVERNMENT_EXCLUSIONS

SAM_GOVERNMENT

SEX_OFFENDERS

CORRUPTION

OFFICE_OF_FOREIGN_ASSETS_CONTROL

TERRORISM

REAL_ESTATE

ANIMAL_RIGHTS

BUSINESS_AND_FINANCIAL

CRIME_AND_COURTS

GENERAL_NEWS

MILITARY_AND_SECURITY

POLITICS_AND_GOVERNMENT
Example
"SANCTION"
Types

AmlTypeOperationFilterInput

Fields
Input Field Description
eq - AmlType
neq - AmlType
in - [AmlType!]
nin - [AmlType!]
Example
{"eq": "SANCTION", "neq": "SANCTION", "in": ["SANCTION"], "nin": ["SANCTION"]}
Types

Any

Example
Any
Types

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
}
Types

AppointmentType

Values
Enum Value Description

CURRENT_SECRETARY

CURRENT_DIRECTOR

RESIGNED_SECRETARY

RESIGNED_DIRECTOR

CURRENT_NON_DESIGNATED_LLP_MEMBER

CURRENT_DESIGNATED_LLP_MEMBER

RESIGNED_NON_DESIGNATED_LLP_MEMBER

RESIGNED_DESIGNATED_LLP_MEMBER

CURRENT_JUDICIAL_FACTOR

CURRENT_RECEIVER_OR_MANAGER_APPOINTED_UNDER_THE_CHARITIES_ACT

CURRENT_MANAGER_APPOINTED_UNDER_THE_CAICE_ACT

RESIGNED_JUDICIAL_FACTOR

RESIGNED_RECEIVER_OR_MANAGER_APPOINTED_UNDER_THE_CHARITIES_ACT

RESIGNED_MANAGER_APPOINTED_UNDER_THE_CAICE_ACT

CURRENT_SE_MEMBER_OF_ADMINISTRATIVE_ORGAN

CURRENT_SE_MEMBER_OF_SUPERVISORY_ORGAN

CURRENT_SE_MEMBER_OF_MANAGEMENT_ORGAN

RESIGNED_SE_MEMBER_OF_ADMINISTRATIVE_ORGAN

RESIGNED_SE_MEMBER_OF_SUPERVISORY_ORGAN

RESIGNED_SE_MEMBER_OF_MANAGEMENT_ORGAN

ERRORED_APPOINTMENT
Example
"CURRENT_SECRETARY"
Types

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"]
}
Types

Auditor

Fields
Field Name Description
id - String
name - String
Example
{
  "id": "xyz789",
  "name": "abc123"
}
Types

AuditorFilterInput

Fields
Input Field Description
and - [AuditorFilterInput!]
or - [AuditorFilterInput!]
id - StringOperationFilterInput
name - StringOperationFilterInput
Example
{
  "and": [AuditorFilterInput],
  "or": [AuditorFilterInput],
  "id": StringOperationFilterInput,
  "name": StringOperationFilterInput
}
Types

AuditorSortInput

Fields
Input Field Description
id - SortEnumType
name - SortEnumType
Example
{"id": "ASC", "name": "ASC"}
Types

AuditorsCollectionSegment

Description

A segment of a collection.

Fields
Field Name Description
pageInfo - CollectionSegmentInfo! Information to aid in pagination.
items - [Auditor] A flattened list of the items.
totalCount - Int!
Example
{
  "pageInfo": CollectionSegmentInfo,
  "items": [Auditor],
  "totalCount": 987
}
Types

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
}
Types

AuthenticationLinkSortInput

Fields
Input Field Description
checkId - SortEnumType
authenticationUrl - SortEnumType
check - CheckSortInput
createdDate - SortEnumType
Example
{
  "checkId": "ASC",
  "authenticationUrl": "ASC",
  "check": CheckSortInput,
  "createdDate": "ASC"
}
Types

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": {}
}
Types

Balance_SheetFilterInput

Fields
Input Field Description
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
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
}
Types

BeneficialOwner

Fields
Field Name Description
id - String
name - String
type - CompanyBeneficiaryType!
seperation - Int!
ownershipPercent - Float
isBeneficiary - Boolean!
parentId - String
Example
{
  "id": "xyz789",
  "name": "xyz789",
  "type": "BUSINESS",
  "seperation": 987,
  "ownershipPercent": 123.45,
  "isBeneficiary": true,
  "parentId": "abc123"
}
Types

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
}
Types

BeneficialOwnerGraph

Fields
Field Name Description
id - String
beneficiaries - [CompanyBeneficiary]
relationships - [CompanyBeneficiaryRelationship]
Example
{
  "id": "xyz789",
  "beneficiaries": [CompanyBeneficiary],
  "relationships": [CompanyBeneficiaryRelationship]
}
Types

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
}
Types

BeneficialOwnerGraphSortInput

Fields
Input Field Description
id - SortEnumType
Example
{"id": "ASC"}
Types

BillingInput

Fields
Input Field Description
companyReportBill - CompanyReportBillInput
idBill - IdReportBillInput
Example
{
  "companyReportBill": CompanyReportBillInput,
  "idBill": IdReportBillInput
}
Types

BillingRegion

Values
Enum Value Description

REST_OF_WORLD

EUROPE

USA_CANADA

UK_IRELAND
Example
"REST_OF_WORLD"
Types

BiometricCheckResultType

Values
Enum Value Description

CONSIDER

FAIL

PASS
Example
"CONSIDER"
Types

BiometricCheckResultTypeOperationFilterInput

Fields
Input Field Description
eq - BiometricCheckResultType
neq - BiometricCheckResultType
in - [BiometricCheckResultType!]
nin - [BiometricCheckResultType!]
Example
{"eq": "CONSIDER", "neq": "CONSIDER", "in": ["CONSIDER"], "nin": ["CONSIDER"]}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanOperationFilterInput

Fields
Input Field Description
eq - Boolean
neq - Boolean
Example
{"eq": false, "neq": true}
Types

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": 987,
  "address": "xyz789",
  "amount": 123,
  "case_number": "abc123",
  "court_name": "abc123",
  "date_of_birth": "2007-12-03T10:15:30Z",
  "date_of_judgement": "2007-12-03T10:15:30Z",
  "entity_type": 123,
  "given_name": "abc123",
  "judgement_type": "abc123",
  "rtl_image_number": "abc123",
  "run_date": "2007-12-03T10:15:30Z",
  "record_type": "abc123",
  "satisfaction_date": "2007-12-03T10:15:30Z",
  "suffix": "xyz789",
  "surname": "xyz789",
  "title": "xyz789",
  "trading_style": "xyz789"
}
Types

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
}
Types

CashFlow

Fields
Field Name Description
account_date - DateTime
no_weeks - Int
consolidated - String
currency - String
net_from_operating_activities - Decimal
net_from_return_investment_servicing - Decimal
net_before_financing - Decimal
net_from_financing - Decimal
increase_in_cash - Decimal
Example
{
  "account_date": "2007-12-03T10:15:30Z",
  "no_weeks": 123,
  "consolidated": "xyz789",
  "currency": "abc123",
  "net_from_operating_activities": Decimal,
  "net_from_return_investment_servicing": Decimal,
  "net_before_financing": Decimal,
  "net_from_financing": Decimal,
  "increase_in_cash": Decimal
}
Types

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
}
Types

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
order - [CheckStatusSortInput!]
verificationTypes - [Verification] Verifications requested
checkType - CheckTypeEnum Type of check performed
notifications - [CheckNotification] Notifications against such as email devivery status
Arguments
order - [CheckNotificationSortInput!]
Example
{
  "options": CheckOptions,
  "id": 123,
  "detail": DigitalCheckDetail,
  "authenticationLink": AuthenticationLink,
  "checkStartUrl": "xyz789",
  "user": User,
  "reference": "abc123",
  "bulkReference": "abc123",
  "isBulk": false,
  "isMonitored": true,
  "createdDate": "2007-12-03T10:15:30Z",
  "result": CheckResult,
  "statuses": [CheckStatus],
  "verificationTypes": [Verification],
  "checkType": "KNOW_YOUR_CLIENT",
  "notifications": [CheckNotification]
}
Types

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
}
Types

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>"
}
Types

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
}
Types

CheckDescription

Fields
Field Name Description
id - Int!
identificationProviderId - IdentificationProviderId!
identificationProvider - IdentificationProvider
description - String
organisation - String
group - String
Example
{
  "id": 987,
  "identificationProviderId": "AUTHENTEQ",
  "identificationProvider": IdentificationProvider,
  "description": "xyz789",
  "organisation": "xyz789",
  "group": "xyz789"
}
Types

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
}
Types

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": 123,
  "addressLine1": "xyz789",
  "addressLine2": "abc123",
  "addressLine3": "xyz789",
  "addressLine4": "xyz789",
  "postcode": "abc123",
  "country": "abc123",
  "countryCode": "AFG",
  "firstResidenceDate": "2007-12-03T10:15:30Z",
  "lastResidenceDate": "2007-12-03T10:15:30Z"
}
Types

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
}
Types

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": "abc123",
  "addressLine2": "xyz789",
  "addressLine3": "abc123",
  "addressLine4": "abc123",
  "postcode": "abc123",
  "country": "abc123",
  "countryCode": "AFG",
  "firstResidenceDate": "2007-12-03T10:15:30Z",
  "lastResidenceDate": "2007-12-03T10:15:30Z"
}
Types

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
}
Types

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"
}
Types

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
}
Types

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": "xyz789",
  "expiryDate": "2007-12-03T10:15:30Z",
  "countryOfOrigin": "AFG",
  "documentType": "PASSPORT"
}
Types

CheckDetailIdentityDocumentType

Values
Enum Value Description

PASSPORT

DRIVING_LICENSE

NATIONAL_INSURANCE

SOCIAL_SECURITY

CANADA_SOCIAL_INSURANCE_NUMBER

INTERNATIONAL_IDENTITY_CARD
Example
"PASSPORT"
Types

CheckDetailIdentityDocumentTypeOperationFilterInput

Fields
Input Field Description
eq - CheckDetailIdentityDocumentType
neq - CheckDetailIdentityDocumentType
in - [CheckDetailIdentityDocumentType!]
nin - [CheckDetailIdentityDocumentType!]
Example
{"eq": "PASSPORT", "neq": "PASSPORT", "in": ["PASSPORT"], "nin": ["PASSPORT"]}
Types

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"]
}
Types

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": 987,
  "email": "abc123",
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z",
  "mobileNumber": "xyz789",
  "countryOfResidence": "AFG"
}
Types

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
}
Types

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
}
Types

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"
}
Types

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": "abc123"
}
Types

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
}
Types

CheckNotificationSortInput

Fields
Input Field Description
id - SortEnumType
checkId - SortEnumType
notificationType - SortEnumType
notificationEvent - SortEnumType
description - SortEnumType
createdDate - SortEnumType
eventDate - SortEnumType