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": 123,
      "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": "xyz789",
      "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": 987
    }
  }
}
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": "abc123"
}
Response
{
  "data": {
    "companies": {
      "pageInfo": CollectionSegmentInfo,
      "items": [CompanySearch],
      "totalCount": 123,
      "aggregations": [CompanyAggregateBucket],
      "searchAfter": "xyz789"
    }
  }
}
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": "xyz789"
}
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": "abc123",
      "mortgages": [Mortgage],
      "country_code": "AFG",
      "archive": [CompanyArchive],
      "estimated_turnover": Decimal,
      "estimated_employees": 987,
      "employees": {},
      "turnover": Decimal,
      "growth_score": 987.65,
      "rfa_rating_score": 123.45,
      "raw_rating_score": 987.65,
      "incorporation_date": "2007-12-03T10:15:30Z",
      "dissolution_date": "2007-12-03T10:15:30Z",
      "dissolution_status": "xyz789",
      "total_assets": {},
      "last_filed_accounts": "2007-12-03T10:15:30Z",
      "accounts_next_due": "2007-12-03T10:15:30Z",
      "tps_registered": true,
      "gdpr_registered": true,
      "marketing_preference": "abc123",
      "website": "abc123",
      "primary_sic07_code": "abc123",
      "revenue_increase": {},
      "creditor_days": {},
      "credit_score": Decimal,
      "credit_limit": Decimal,
      "sic92_sections": ["abc123"],
      "sic92_codes": ["xyz789"],
      "sic92_descriptions": ["abc123"],
      "primary_sic92_code": "abc123",
      "sic07": [SIC07],
      "sic07_codes": ["abc123"],
      "sic07_descriptions": ["abc123"],
      "sic07_sections": ["xyz789"],
      "sic07_section_descriptions": [
        "abc123"
      ],
      "sic07_divisions": ["abc123"],
      "sic07_division_descriptions": [
        "abc123"
      ],
      "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": true,
      "company_name": "xyz789",
      "legal_status": "abc123",
      "auditor": "xyz789",
      "latest_action": Latest_Action,
      "company_type": "xyz789",
      "history": [History],
      "ccjs": [CCJ],
      "possible_ccjs": [CCJ],
      "processed_at": "2007-12-03T10:15:30Z",
      "last_updated": "2007-12-03T10:15:30Z",
      "parent_company": "xyz789",
      "group_id": "xyz789",
      "telephone_number": "xyz789",
      "email": "abc123",
      "has_contact": true,
      "has_phone_contact": false,
      "has_email_contact": true,
      "generated_rfa_rating": "THREE_RED_FLAGS",
      "previous_rfa_rating": "THREE_RED_FLAGS",
      "rating_changed_date": "2007-12-03T10:15:30Z",
      "previous_rating_changed_date": "2007-12-03T10:15:30Z",
      "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": "xyz789"
}
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": "xyz789",
      "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": "xyz789",
      "archive": [CompanyArchive],
      "id": 987,
      "company_id": "xyz789",
      "estimated_turnover": Decimal,
      "estimated_employees": 987,
      "employees": {},
      "turnover": Decimal,
      "growth_score": 123.45,
      "rfa_rating_score": 987.65,
      "raw_rating_score": 987.65,
      "company_number": "xyz789",
      "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": ["xyz789"],
      "sic92_codes": ["abc123"],
      "sic92_descriptions": ["xyz789"],
      "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": [
        "abc123"
      ],
      "sic07_groups": ["abc123"],
      "sic07_group_descriptions": [
        "xyz789"
      ],
      "sic07_classes": ["abc123"],
      "sic07_class_descriptions": [
        "abc123"
      ],
      "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": false,
      "is_limited": true,
      "is_trading": false,
      "addresses": [Address],
      "company_name": "abc123",
      "legal_status": "abc123",
      "auditor": "abc123",
      "latest_action": Latest_Action,
      "company_type": "abc123",
      "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": "xyz789",
      "group_id": "xyz789",
      "telephone_number": "xyz789",
      "email": "xyz789",
      "has_contact": false,
      "has_phone_contact": true,
      "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": "abc123",
      "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": 987
    }
  }
}
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": 123
    }
  }
}
Queries

equifaxToken

Response

Returns a String

Example

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

idUkCheck

Response

Returns an UkCheckType

Arguments
Name Description
checkId - Int!

Example

Query
query idUkCheck($checkId: Int!) {
  idUkCheck(checkId: $checkId) {
    submittedData {
      ...SubmittedDataFragment
    }
    checkDetails {
      ...DetailsFragment
    }
    notifications {
      ...CheckNotificationFragment
    }
    outcome {
      ...OutcomeFragment
    }
    idv {
      ...IdvResultFragment
    }
    aml {
      ...AmlTabulatedResultFragment
    }
    psam {
      ...PsamResultFragment
    }
    notes {
      ...NoteFragment
    }
    id
  }
}
Variables
{"checkId": 987}
Response
{
  "data": {
    "idUkCheck": {
      "submittedData": SubmittedData,
      "checkDetails": Details,
      "notifications": [CheckNotification],
      "outcome": Outcome,
      "idv": IdvResult,
      "aml": AmlTabulatedResult,
      "psam": PsamResult,
      "notes": [Note],
      "id": 987
    }
  }
}
Queries

internationalCompanyReport

Response

Returns an InternationalCompany

Arguments
Name Description
reportRequest - CompanyReportRequestInput

Example

Query
query internationalCompanyReport($reportRequest: CompanyReportRequestInput) {
  internationalCompanyReport(reportRequest: $reportRequest) {
    id
    company_id
    company_name
    country_code
    company_number
    company_type
    generated_rfa_rating
    lastUpdatedAt
    companyDetails {
      ...CompanyDetailsFragment
    }
    companyStatus {
      ...CompanyStatusFragment
    }
    financials {
      ...CompanyFinancialsFragment
    }
    organizationalStructure {
      ...OrganisationalStructureFragment
    }
    paydex {
      ...PaydexFragment
    }
    archive_id
    archive {
      ...CompanyArchiveFragment
    }
    history {
      ...HistoryFragment
    }
    compliance {
      ...AmlResultFragment
    }
  }
}
Variables
{"reportRequest": CompanyReportRequestInput}
Response
{
  "data": {
    "internationalCompanyReport": {
      "id": 987,
      "company_id": "abc123",
      "company_name": "xyz789",
      "country_code": "AFG",
      "company_number": "abc123",
      "company_type": "abc123",
      "generated_rfa_rating": "THREE_RED_FLAGS",
      "lastUpdatedAt": "2007-12-03T10:15:30Z",
      "companyDetails": CompanyDetails,
      "companyStatus": CompanyStatus,
      "financials": CompanyFinancials,
      "organizationalStructure": OrganisationalStructure,
      "paydex": Paydex,
      "archive_id": "xyz789",
      "archive": [CompanyArchive],
      "history": [History],
      "compliance": AmlResult
    }
  }
}
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": 123
    }
  }
}
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": 987
    }
  }
}
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": "xyz789",
        "title": "xyz789",
        "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": 987,
        "portfolioId": 987,
        "notes": "xyz789",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "abc123",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 987,
        "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": "NA",
        "eventDate": "2007-12-03T10:15:30Z",
        "isImmediate": true,
        "portfolioId": 987,
        "notes": "abc123",
        "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": "abc123",
        "variables": "xyz789",
        "fieldType": "abc123",
        "status": "REQUESTED",
        "rowCount": 123,
        "acknowledged": true,
        "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": 987,
        "etaSeconds": 987,
        "isCancelled": false,
        "legacyId": "xyz789",
        "fileLocation": "abc123",
        "downloadLocation": "abc123",
        "isScheduledExport": false,
        "exportReference": "xyz789",
        "meta": FileExportMeta
      }
    ]
  }
}
Mutations

consumerCreditReport

Response

Returns a ConsumerCreditReport

Arguments
Name Description
request - ConsumerCreditRequestInput

Example

Query
mutation consumerCreditReport($request: ConsumerCreditRequestInput) {
  consumerCreditReport(request: $request) {
    userInput {
      ...ConsumerCreditRequestFragment
    }
    requestedBy {
      ...RequestedByFragment
    }
    clientRef
    reportRunDate
    applicantConfirmation {
      ...ApplicantConfirmationFragment
    }
    matchedAddressData {
      ...AddressRelatedDataFragment
    }
    linkedAddressData {
      ...LinkedAddressRelatedDataFragment
    }
    aliases {
      ...PersonalDetailsFragment
    }
    scores {
      ...ScoreDataFragment
    }
    associates {
      ...PersonalDetailsFragment
    }
    potentialAssociates {
      ...PersonalDetailsFragment
    }
    associateLender {
      ...AssociateLenderFragment
    }
    potentialAssociateLender {
      ...AssociateLenderFragment
    }
    riskOverview {
      ...RiskOverviewItemFragment
    }
  }
}
Variables
{"request": ConsumerCreditRequestInput}
Response
{
  "data": {
    "consumerCreditReport": {
      "userInput": ConsumerCreditRequest,
      "requestedBy": RequestedBy,
      "clientRef": "xyz789",
      "reportRunDate": "2007-12-03T10:15:30Z",
      "applicantConfirmation": ApplicantConfirmation,
      "matchedAddressData": [AddressRelatedData],
      "linkedAddressData": [LinkedAddressRelatedData],
      "aliases": [PersonalDetails],
      "scores": [ScoreData],
      "associates": [PersonalDetails],
      "potentialAssociates": [PersonalDetails],
      "associateLender": [AssociateLender],
      "potentialAssociateLender": [AssociateLender],
      "riskOverview": [RiskOverviewItem]
    }
  }
}
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": "xyz789",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "abc123",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 123,
        "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": "xyz789",
      "name": "xyz789",
      "isPrivate": true,
      "accountId": "abc123",
      "accountEmail": "xyz789",
      "portfolioType": "NONE",
      "id": 123,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "NA",
      "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": "xyz789",
      "name": "abc123",
      "isPrivate": false,
      "accountId": "xyz789",
      "accountEmail": "abc123",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "NA",
      "lastCompanyId": 123,
      "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": "abc123"}
Response
{
  "data": {
    "fileExportAcknowledge": {
      "columnSelection": "ALL_COLUMNS",
      "resultSelection": "ALL_COLUMNS",
      "apiQuery": "abc123",
      "variables": "abc123",
      "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": "xyz789",
      "exportType": "CSV",
      "description": "xyz789",
      "totalResults": 123,
      "etaSeconds": 987,
      "isCancelled": true,
      "legacyId": "xyz789",
      "fileLocation": "abc123",
      "downloadLocation": "abc123",
      "isScheduledExport": true,
      "exportReference": "xyz789",
      "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": "abc123",
      "variables": "abc123",
      "fieldType": "xyz789",
      "status": "REQUESTED",
      "rowCount": 123,
      "acknowledged": false,
      "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": "xyz789",
      "totalResults": 123,
      "etaSeconds": 987,
      "isCancelled": false,
      "legacyId": "abc123",
      "fileLocation": "abc123",
      "downloadLocation": "xyz789",
      "isScheduledExport": false,
      "exportReference": "abc123",
      "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": "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]
    }
  }
}
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": 123,
        "detail": DigitalCheckDetail,
        "authenticationLink": AuthenticationLink,
        "checkStartUrl": "abc123",
        "user": User,
        "reference": "abc123",
        "bulkReference": "xyz789",
        "isBulk": true,
        "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": 987,
      "checkResultId": 123,
      "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": 123,
      "checkResultId": 123,
      "user": User,
      "created": "2007-12-03T10:15:30Z",
      "noteText": "abc123",
      "overriddenStatusType": "PASS"
    }
  }
}
Mutations

idCreateUkCheck

Response

Returns an Int!

Arguments
Name Description
ukCheckRequest - UkCheckRequestInput

Example

Query
mutation idCreateUkCheck($ukCheckRequest: UkCheckRequestInput) {
  idCreateUkCheck(ukCheckRequest: $ukCheckRequest)
}
Variables
{"ukCheckRequest": UkCheckRequestInput}
Response
{"data": {"idCreateUkCheck": 123}}
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": [987]}}
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": "abc123"
    }
  }
}
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": 987}
Response
{
  "data": {
    "idVerificationStarted": {
      "reference": "abc123",
      "message": "abc123",
      "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": false,
      "accountId": "abc123",
      "accountEmail": "xyz789",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "NA",
      "lastCompanyId": 123,
      "lastNotifiedEvent": 123,
      "portfolioRecipients": [PortfolioRecipients],
      "totalCompaniesCount": 123
    }
  }
}
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": "xyz789",
        "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": "NA", "isImmediate": true, "isActive": false}
    ]
  }
}
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": 123,
        "notes": "abc123",
        "portfolio": Portfolio,
        "portfolioEvents": [PortfolioEvent],
        "accountEmail": "xyz789",
        "createdTime": "2007-12-03T10:15:30Z",
        "id": 987,
        "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": "xyz789",
      "isPrivate": false,
      "accountId": "xyz789",
      "accountEmail": "xyz789",
      "portfolioType": "NONE",
      "id": 987,
      "notifications": [Notification],
      "notificationHistory": [NotificationHistory],
      "triggerEvents": [TriggerEvent],
      "portfolioEvents": [PortfolioEvent],
      "lastEventTime": "2007-12-03T10:15:30Z",
      "lastEventType": "NA",
      "lastCompanyId": 123,
      "lastNotifiedEvent": 987,
      "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": "abc123",
      "refreshToken": "abc123",
      "expiresInSeconds": 123
    }
  }
}
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": "abc123",
      "expiresInSeconds": 987
    }
  }
}
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": false,
      "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": "xyz789",
  "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": "abc123"
}
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": 987,
  "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": 987,
  "totalChecks": 123,
  "isCustomer": true,
  "isSubscriber": false,
  "canCreateChecks": false,
  "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

AccountsData

Fields
Field Name Description
numberOfAccounts - OpenClosedAccounts!
numberOfDifferentLenders - OpenClosedAccounts!
numberOfAccountsLastUpdatedLast3Months - Int!
numberOfAccountsLastUpdatedLast1Month - Int!
numberOfBankAndBuildingSocietyLenders - OpenClosedAccounts!
numberOfFinancialServicesLenders - OpenClosedAccounts!
numberOfRetailLenders - OpenClosedAccounts!
numberOfMailOrderLenders - OpenClosedAccounts!
numberOfCommsAndUtilitiesLenders - OpenClosedAccounts!
numberOfRentalAndLeasingLenders - OpenClosedAccounts!
timeSinceMostRecentOpened - String!
timeSinceOldestOpened - String!
timeSinceMostRecentClosure - String!
timeSinceOldestClosure - String!
Example
{
  "numberOfAccounts": OpenClosedAccounts,
  "numberOfDifferentLenders": OpenClosedAccounts,
  "numberOfAccountsLastUpdatedLast3Months": 123,
  "numberOfAccountsLastUpdatedLast1Month": 987,
  "numberOfBankAndBuildingSocietyLenders": OpenClosedAccounts,
  "numberOfFinancialServicesLenders": OpenClosedAccounts,
  "numberOfRetailLenders": OpenClosedAccounts,
  "numberOfMailOrderLenders": OpenClosedAccounts,
  "numberOfCommsAndUtilitiesLenders": OpenClosedAccounts,
  "numberOfRentalAndLeasingLenders": OpenClosedAccounts,
  "timeSinceMostRecentOpened": "abc123",
  "timeSinceOldestOpened": "abc123",
  "timeSinceMostRecentClosure": "xyz789",
  "timeSinceOldestClosure": "abc123"
}
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": "abc123",
  "address_line_4": "abc123",
  "town": "abc123",
  "county": "abc123",
  "country": "abc123",
  "country_code": "AFG",
  "postcode": "abc123",
  "type": "abc123",
  "location": Location,
  "postcode_area": "abc123",
  "postcode_district": "abc123",
  "original_county": "xyz789",
  "district": "abc123",
  "os_easting": 123,
  "os_northing": 123,
  "la_ua_gsscode": "abc123",
  "la_ua_name": "abc123",
  "region": "xyz789",
  "lep_name": "xyz789",
  "combined_authority_name": "xyz789"
}
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

AddressRelatedData

Fields
Field Name Description
nameMatchedAddress - NameAddressMatch
matchedAddress - SubjectAddress
electoralRollRegistrations - [ElectoralRollData!]!
rollingRegisterRecords - [RollingRegisterRecord!]!
courtRecords - [CourtRecord!]!
previousCreditSearches - [CreditSearchRecord!]!
previousNonCreditSearches - [PreviousSearchRecord!]!
accountsData - AccountsData
noticeOfCorrectionOrDisputes - [NoticeOfCorrectionOrDispute!]!
Example
{
  "nameMatchedAddress": NameAddressMatch,
  "matchedAddress": SubjectAddress,
  "electoralRollRegistrations": [ElectoralRollData],
  "rollingRegisterRecords": [RollingRegisterRecord],
  "courtRecords": [CourtRecord],
  "previousCreditSearches": [CreditSearchRecord],
  "previousNonCreditSearches": [PreviousSearchRecord],
  "accountsData": AccountsData,
  "noticeOfCorrectionOrDisputes": [
    NoticeOfCorrectionOrDispute
  ]
}
Types

AddressV2

Description

An address in the v2 system

Fields
Field Name Description
id - UUID! Unique address identifier
fullAddress - String Full address string
streetAddress - String Primary street address
streetAddress2 - String Secondary street address
streetAddress3 - String Tertiary street address
city - String City or town
postCode - String Postal/ZIP code
country - String Country code (ISO 3166-1 alpha-3)
state - String State or province
createdAt - DateTime When the address was created
updatedAt - DateTime When the address was last updated
personAddresses - [PersonAddressV2] Person associations for this address
streetAddress4 - String
building - String
subBuilding - String
firstResidenceDate - DateTime
lastResidenceDate - DateTime
line1 - String
line2 - String
line3 - String
line4 - String
buildingName - String
buildingNumber - String
street - String
secondaryStreet - String
postcode - String
addressVerificationResultChecks - [AddressVerificationResultCheckV2!]
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fullAddress": "abc123",
  "streetAddress": "abc123",
  "streetAddress2": "xyz789",
  "streetAddress3": "xyz789",
  "city": "xyz789",
  "postCode": "xyz789",
  "country": "xyz789",
  "state": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "personAddresses": [PersonAddressV2],
  "streetAddress4": "xyz789",
  "building": "abc123",
  "subBuilding": "xyz789",
  "firstResidenceDate": "2007-12-03T10:15:30Z",
  "lastResidenceDate": "2007-12-03T10:15:30Z",
  "line1": "abc123",
  "line2": "xyz789",
  "line3": "abc123",
  "line4": "xyz789",
  "buildingName": "xyz789",
  "buildingNumber": "xyz789",
  "street": "abc123",
  "secondaryStreet": "abc123",
  "postcode": "xyz789",
  "addressVerificationResultChecks": [
    AddressVerificationResultCheckV2
  ]
}
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": 987,
  "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": 987,
  "id": "xyz789",
  "decision": "NA",
  "details": [AddressVerificationDetail],
  "items": [AddressVerificationItem]
}
Types

AddressVerificationResultCheckFieldV2

Description

A field within a check of an address verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique field identifier
addressVerificationResultCheckId - UUID! Associated address verification result check identifier
fieldType - String Type of field (overall, forename, surname, address, alert, etc.)
fieldResult - String Result for this field
createdAt - DateTime When the field was created
updatedAt - DateTime When the field was last updated
addressVerificationResultCheck - AddressVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "addressVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldType": "xyz789",
  "fieldResult": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "addressVerificationResultCheck": AddressVerificationResultCheckV2
}
Types

AddressVerificationResultCheckItemV2

Description

An item within a check of an address verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique item identifier
addressVerificationResultCheckId - UUID! Associated address verification result check identifier
itemType - String Type of item (match, mismatch, comment, nomatch)
providerCode - String Provider code for this item
description - String Item description
createdAt - DateTime When the item was created
updatedAt - DateTime When the item was last updated
addressVerificationResultCheck - AddressVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "addressVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "itemType": "xyz789",
  "providerCode": "abc123",
  "description": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "addressVerificationResultCheck": AddressVerificationResultCheckV2
}
Types

AddressVerificationResultCheckV2

Description

A check within an address verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique check identifier
addressVerificationResultId - UUID! Associated address verification result identifier
addressId - UUID! Associated address identifier
providerCheckId - String Provider check identifier
name - String Check name
description - String Check description
createdAt - DateTime When the check was created
updatedAt - DateTime When the check was last updated
address - AddressV2 Associated address
addressVerificationResult - AddressVerificationResultV2 Associated address verification result
items - [AddressVerificationResultCheckItemV2] Check items
fields - [AddressVerificationResultCheckFieldV2] Check fields
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "addressVerificationResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "addressId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "providerCheckId": "abc123",
  "name": "abc123",
  "description": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "address": AddressV2,
  "addressVerificationResult": AddressVerificationResultV2,
  "items": [AddressVerificationResultCheckItemV2],
  "fields": [AddressVerificationResultCheckFieldV2]
}
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

AddressVerificationResultV2

Description

An address verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique address verification result identifier
checkId - UUID! Associated check identifier
decision - String Address verification decision
status - String Address verification status
vendor - String Vendor used for address verification
rawResponse - String Raw vendor response (JSON)
score - Decimal Verification confidence score
providerId - String Provider identifier
jurisdiction - String Jurisdiction for verification
createdAt - DateTime When the verification was created
updatedAt - DateTime When the verification was last updated
checks - [AddressVerificationResultCheckV2] Address verification checks
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "decision": "xyz789",
  "status": "abc123",
  "vendor": "xyz789",
  "rawResponse": "abc123",
  "score": Decimal,
  "providerId": "xyz789",
  "jurisdiction": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "checks": [AddressVerificationResultCheckV2],
  "check": CheckV2
}
Types

AgeVerified

Values
Enum Value Description

OVER_18

UNDER_18

OTHER
Example
"OVER_18"
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": 123,
  "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": 123,
  "id": "xyz789",
  "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": "xyz789",
  "source": "abc123",
  "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": "xyz789",
  "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": 987,
  "dateTime": "2007-12-03T10:15:30Z",
  "title": "xyz789",
  "snippet": "xyz789",
  "url": "xyz789"
}
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": 123,
  "entity": AmlEntity,
  "matchTypes": ["UNKNOWN"],
  "sources": [AmlSourceNote],
  "matchTypeDetails": [AmlMatchTypeDetail],
  "addresses": [AmlAddress],
  "positions": [AmlPosition],
  "media": [AmlEntityMedia]
}
Types

AmlMatchFieldV2

Description

Field-level result for an AML match

Fields
Field Name Description
id - UUID! Unique match field identifier
amlMatchId - UUID Associated AML match identifier
fieldType - String Type of field (e.g., Name, Date of Birth, Address)
fieldResult - String Result value for this field
createdAt - DateTime When the field result was created
updatedAt - DateTime When the field result was last updated
amlMatch - AmlMatchV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "amlMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldType": "xyz789",
  "fieldResult": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "amlMatch": AmlMatchV2
}
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": "abc123",
  "field": "xyz789",
  "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

AmlMatchTypeDetailV2

Description

Detailed type information for an AML match

Fields
Field Name Description
id - UUID! Unique match type detail identifier
amlMatchId - UUID Associated AML match identifier
type - String Type of match (e.g., Sanction, PEP, Adverse Media)
detail - String Detailed description of the match type
createdAt - DateTime When the detail was created
updatedAt - DateTime When the detail was last updated
amlMatch - AmlMatchV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "amlMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "type": "abc123",
  "detail": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "amlMatch": AmlMatchV2
}
Types

AmlMatchTypeOperationFilterInput

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

AmlMatchV2

Description

An AML match found during a check

Fields
Field Name Description
id - UUID! Unique AML match identifier
amlResultId - UUID Associated AML result identifier
createdAt - DateTime When the match was created
updatedAt - DateTime When the match was last updated
matchTypeDetails - [AmlMatchTypeDetailV2] Detailed type information for this match
sourceNotes - [AmlSourceNoteV2] Source notes and references for this match
matchFields - [AmlMatchFieldV2] Field-level results for this match
amlResult - AmlResultV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "amlResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "matchTypeDetails": [AmlMatchTypeDetailV2],
  "sourceNotes": [AmlSourceNoteV2],
  "matchFields": [AmlMatchFieldV2],
  "amlResult": AmlResultV2
}
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

AmlResultV2

Description

An AML result in the v2 system

Fields
Field Name Description
id - UUID! Unique AML result identifier
checkId - UUID Associated check identifier
riskLevel - String Risk level assessment
matchStatus - String Status of AML matches
status - String Overall AML check status
vendor - String Vendor used for AML check
rawResponse - String Raw vendor response (JSON)
providerTransactionId - String Provider transaction identifier
jurisdiction - String Jurisdiction for this AML check
createdAt - DateTime When the AML check was created
updatedAt - DateTime When the AML check was last updated
matches - [AmlMatchV2] AML matches found during the check
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "riskLevel": "abc123",
  "matchStatus": "abc123",
  "status": "abc123",
  "vendor": "xyz789",
  "rawResponse": "xyz789",
  "providerTransactionId": "xyz789",
  "jurisdiction": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "matches": [AmlMatchV2],
  "check": CheckV2
}
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": "xyz789",
  "source": "xyz789",
  "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

AmlSourceNoteV2

Description

Source note and reference for an AML match

Fields
Field Name Description
id - UUID! Unique source note identifier
amlMatchId - UUID Associated AML match identifier
name - String Name of the source
description - String Description of the source
source - String Source identifier or reference
createdAt - DateTime When the source note was created
updatedAt - DateTime When the source note was last updated
amlMatch - AmlMatchV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "amlMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "name": "xyz789",
  "description": "xyz789",
  "source": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "amlMatch": AmlMatchV2
}
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

AmlTabulatedResult

Fields
Field Name Description
result - ResultEnum!
additionalInformation - String
amlResultTabulation - [AmlTabulation]
Example
{
  "result": "NOT_AVAILABLE",
  "additionalInformation": "abc123",
  "amlResultTabulation": [AmlTabulation]
}
Types

AmlTabulation

Fields
Field Name Description
name - String
description - String
values - [ResultValue]
additionalInformation - String
Example
{
  "name": "abc123",
  "description": "xyz789",
  "values": [ResultValue],
  "additionalInformation": "xyz789"
}
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

ApplicantConfirmation

Fields
Field Name Description
dobVerificationStatus - DobVerifiedStatus Coming soon: How the supplied DOB compared with Equifax-held DOB data
ageVerifiedStatus - AgeVerified Coming soon: Indicates whether the individual was verified to be over/under 18 years of age.
title - String
firstName - String
middleName - String
lastName - String
dateOfBirth - DateTime
Example
{
  "dobVerificationStatus": "FULL_MATCH",
  "ageVerifiedStatus": "OVER_18",
  "title": "xyz789",
  "firstName": "xyz789",
  "middleName": "abc123",
  "lastName": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z"
}
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

AssociateLender

Fields
Field Name Description
person - PersonalDetails!
companyName - String!
Example
{
  "person": PersonalDetails,
  "companyName": "abc123"
}
Types

AuditLogV2

Description

An audit log entry in the v2 system

Fields
Field Name Description
id - UUID! Unique audit log identifier
checkId - UUID Associated check identifier
userId - String User who performed the action
action - String Action performed
entityType - String Type of entity affected
entityId - UUID ID of entity affected
oldValues - String Previous values (JSON)
newValues - String New values (JSON)
ipAddress - String IP address of the user
userAgent - String User agent string
createdAt - DateTime When the event occurred
category - String Category of the audit action
severity - String Severity level of the audit action
correlationId - UUID Correlation ID to link related actions
sessionId - String User session identifier
isUserVisible - Boolean Whether this entry is visible to end users
actionDescription - String User-friendly description of the action
check - CheckV2 Associated check
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "userId": "abc123",
  "action": "xyz789",
  "entityType": "xyz789",
  "entityId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "oldValues": "abc123",
  "newValues": "abc123",
  "ipAddress": "xyz789",
  "userAgent": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "category": "abc123",
  "severity": "xyz789",
  "correlationId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "sessionId": "xyz789",
  "isUserVisible": false,
  "actionDescription": "xyz789",
  "check": CheckV2
}
Types

Auditor

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

AuditorComment

Fields
Field Name Description
type - CommentType!
value - String!
Example
{"type": "UNKNOWN", "value": "abc123"}
Types

AuditorCommentFilterInput

Fields
Input Field Description
and - [AuditorCommentFilterInput!]
or - [AuditorCommentFilterInput!]
type - CommentTypeOperationFilterInput
value - StringOperationFilterInput
Example
{
  "and": [AuditorCommentFilterInput],
  "or": [AuditorCommentFilterInput],
  "type": CommentTypeOperationFilterInput,
  "value": StringOperationFilterInput
}
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 - String
auditorComments - [AuditorComment!]!
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": "abc123",
  "auditorComments": [AuditorComment],
  "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 - StringOperationFilterInput
auditorComments - ListFilterInputTypeOfAuditorCommentFilterInput
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": StringOperationFilterInput,
  "auditorComments": ListFilterInputTypeOfAuditorCommentFilterInput,
  "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

BankAccountVerificationResult

Description

A bank account verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique bank account verification result identifier
checkId - UUID! Associated check identifier
vendor - String Vendor used for bank account verification
vendorReference - String Reference from the bank verification provider
vendorDecision - String Decision from the bank verification provider
accountNumber - String Bank account number (masked)
sortCode - String Bank sort code
iban - String IBAN number
bic - String BIC/SWIFT code
bankName - String Name of the bank
status - String Status of the bank account verification
confidenceScore - Float Confidence score of the verification
rawResponse - String Raw vendor response (JSON)
createdAt - DateTime When the bank account verification result was created
verifiedAt - DateTime When the verification was completed
checks - [BankVerificationResultCheckV2] Bank verification checks
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "vendor": "abc123",
  "vendorReference": "xyz789",
  "vendorDecision": "xyz789",
  "accountNumber": "abc123",
  "sortCode": "abc123",
  "iban": "xyz789",
  "bic": "abc123",
  "bankName": "abc123",
  "status": "xyz789",
  "confidenceScore": 123.45,
  "rawResponse": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "verifiedAt": "2007-12-03T10:15:30Z",
  "checks": [BankVerificationResultCheckV2],
  "check": CheckV2
}
Types

BankVerificationResultCheckFieldV2

Description

A field within a check of a bank verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique field identifier
bankVerificationResultCheckId - UUID! Associated bank verification result check identifier
fieldType - String Type of field (overall, forename, surname, address, alert, etc.)
fieldResult - String Result for this field
createdAt - DateTime When the field was created
updatedAt - DateTime When the field was last updated
bankVerificationResultCheck - BankVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "bankVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldType": "xyz789",
  "fieldResult": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "bankVerificationResultCheck": BankVerificationResultCheckV2
}
Types

BankVerificationResultCheckItemV2

Description

An item within a check of a bank verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique item identifier
bankVerificationResultCheckId - UUID! Associated bank verification result check identifier
itemType - String Type of item (match, mismatch, comment, nomatch)
providerCode - String Provider code for this item
description - String Item description
createdAt - DateTime When the item was created
updatedAt - DateTime When the item was last updated
bankVerificationResultCheck - BankVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "bankVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "itemType": "abc123",
  "providerCode": "xyz789",
  "description": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "bankVerificationResultCheck": BankVerificationResultCheckV2
}
Types

BankVerificationResultCheckV2

Description

A check within a bank verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique check identifier
bankAccountVerificationResultId - UUID! Associated bank account verification result identifier
providerCheckId - String Provider check identifier
name - String Check name
description - String Check description
createdAt - DateTime When the check was created
updatedAt - DateTime When the check was last updated
items - [BankVerificationResultCheckItemV2] Check items
fields - [BankVerificationResultCheckFieldV2] Check fields
bankVerificationResult - BankAccountVerificationResult
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "bankAccountVerificationResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "providerCheckId": "abc123",
  "name": "xyz789",
  "description": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "items": [BankVerificationResultCheckItemV2],
  "fields": [BankVerificationResultCheckFieldV2],
  "bankVerificationResult": BankAccountVerificationResult
}
Types

BeneficialOwner

Fields
Field Name Description
id - String
name - String
type - CompanyBeneficiaryType!
seperation - Int!
ownershipPercent - Float
isBeneficiary - Boolean!
parentId - String
Example
{
  "id": "abc123",
  "name": "abc123",
  "type": "BUSINESS",
  "seperation": 123,
  "ownershipPercent": 987.65,
  "isBeneficiary": false,
  "parentId": "xyz789"
}
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": "abc123",
  "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

NOTAVAILABLE

CONSIDER

FAIL

PASS
Example
"NOTAVAILABLE"
Types

BiometricCheckResultTypeOperationFilterInput

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

Boolean

Description

The Boolean scalar type represents true or false.

Types

BooleanOperationFilterInput

Fields
Input Field Description
eq - Boolean
neq - Boolean
Example
{"eq": true, "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": 123,
  "address": "abc123",
  "amount": 123,
  "case_number": "xyz789",
  "court_name": "xyz789",
  "date_of_birth": "2007-12-03T10:15:30Z",
  "date_of_judgement": "2007-12-03T10:15:30Z",
  "entity_type": 123,
  "given_name": "xyz789",
  "judgement_type": "abc123",
  "rtl_image_number": "xyz789",
  "run_date": "2007-12-03T10:15:30Z",
  "record_type": "abc123",
  "satisfaction_date": "2007-12-03T10:15:30Z",
  "suffix": "xyz789",
  "surname": "abc123",
  "title": "abc123",
  "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": 987,
  "consolidated": "abc123",
  "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": "abc123",
  "user": User,
  "reference": "xyz789",
  "bulkReference": "xyz789",
  "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

CheckCheckTypeV2

Description

Relationship between a check and check types

Fields
Field Name Description
checkId - UUID! Check identifier
checkTypeId - UUID! Check type identifier
check - CheckV2 Associated check
checkType - CheckTypeV2 Associated check type
Example
{
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkTypeId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "check": CheckV2,
  "checkType": CheckTypeV2
}
Types

CheckDescription

Fields
Field Name Description
id - Int!
identificationProviderId - IdentificationProviderId!
identificationProvider - IdentificationProvider
description - String
organisation - String
group - String
Example
{
  "id": 123,
  "identificationProviderId": "AUTHENTEQ",
  "identificationProvider": IdentificationProvider,
  "description": "xyz789",
  "organisation": "xyz789",
  "group": "xyz789"
}
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": "abc123",
  "addressLine4": "abc123",
  "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": "xyz789",
  "addressLine2": "xyz789",
  "addressLine3": "abc123",
  "addressLine4": "xyz789",
  "postcode": "abc123",
  "country": "xyz789",
  "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": "abc123",
  "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": "xyz789",
  "firstName": "abc123",
  "middleName": "xyz789",
  "lastName": "abc123",
  "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": 987,
  "eventDate": "2007-12-03T10:15:30Z",
  "createdDate": "2007-12-03T10:15:30Z",
  "notificationEvent": "SPAM_REPORT",
  "notificationType": "EMAIL",
  "description": "xyz789"
}
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
check - CheckSortInput
Example
{
  "id": "ASC",
  "checkId": "ASC",
  "notificationType": "ASC",
  "notificationEvent": "ASC",
  "description": "ASC",
  "createdDate": "ASC",
  "eventDate": "ASC",
  "check": CheckSortInput
}
Types

CheckOptions

Description

Options

Fields
Field Name Description
psamFuzziness - Decimal
excludeAdverseMedia - Boolean
Example
{"psamFuzziness": Decimal, "excludeAdverseMedia": true}
Types

CheckOptionsFilterInput

Fields
Input Field Description
and - [CheckOptionsFilterInput!]
or - [CheckOptionsFilterInput!]
checkId - IntOperationFilterInput
psamFuzziness - DecimalOperationFilterInput
excludeAdverseMedia - BooleanOperationFilterInput
sendSmSNotification - BooleanOperationFilterInput
sendEmailNotification - BooleanOperationFilterInput
check - CheckFilterInput
Example
{
  "and": [CheckOptionsFilterInput],
  "or": [CheckOptionsFilterInput],
  "checkId": IntOperationFilterInput,
  "psamFuzziness": DecimalOperationFilterInput,
  "excludeAdverseMedia": BooleanOperationFilterInput,
  "sendSmSNotification": BooleanOperationFilterInput,
  "sendEmailNotification": BooleanOperationFilterInput,
  "check": CheckFilterInput
}
Types

CheckOptionsInputType

Description

Check options.

Fields
Input Field Description
psamFuzziness - Float! Fuzziness of PSAM check between 0 and 1. A fuzziness of 1 will return more possible matches. 0 will perform an exact match. Default = 0.5
excludeAdverseMedia - Boolean! When selected will perform a PSAM check without any adverse media. Default = false
sendSmSNotification - Boolean! If disabled then no SMS notification will be sent. Default = true
sendEmailNotification - Boolean! If disabled then no email notification will be sent. Default = true
Example
{
  "psamFuzziness": 123.45,
  "excludeAdverseMedia": true,
  "sendSmSNotification": false,
  "sendEmailNotification": false
}
Types

CheckOptionsSortInput

Fields
Input Field Description
checkId - SortEnumType
psamFuzziness - SortEnumType
excludeAdverseMedia - SortEnumType
sendSmSNotification - SortEnumType
sendEmailNotification - SortEnumType
check - CheckSortInput
Example
{
  "checkId": "ASC",
  "psamFuzziness": "ASC",
  "excludeAdverseMedia": "ASC",
  "sendSmSNotification": "ASC",
  "sendEmailNotification": "ASC",
  "check": CheckSortInput
}
Types

CheckRequestInput

Description

Check request information.

Fields
Input Field Description
checkType - CheckTypeEnum Type of check to perform.
reference - String Check reference. Must not contain \ unless an escaped character is being entered.
bulkReference - String Bulk reference. Must not contain \ unless an escaped character is being entered.
options - CheckOptionsInputType Check options.
checkBranding - CheckBrandingInput Check branding.
detail - CheckDetailInput Check details.
accountId - String Account Id for check being created.
isMonitored - Boolean! Checks with PSAM searches will update when results change. Default = false
userEmail - String Email of person creating check.
verificationTypes - [VerificationInput] [Deprecated - Use CheckType] Additional checks request.
Example
{
  "checkType": "KNOW_YOUR_CLIENT",
  "reference": "RFA12345",
  "bulkReference": "xyz789",
  "options": CheckOptionsInputType,
  "checkBranding": CheckBrandingInput,
  "detail": CheckDetailInput,
  "accountId": "xyz789",
  "isMonitored": true,
  "userEmail": "xyz789",
  "verificationTypes": [VerificationInput]
}
Types

CheckResult

Description

Check result

Fields
Field Name Description
id - Int! Check Result Id
result - CheckResultType! Type of result
createdDate - DateTime! Date result created
reportUrl - String Url for report
identificationDocument - IdentificationDocument Identification document details
notes - [Note] Notes
Arguments
id - Int
amlResult - AmlResult AML Result Use AML Results instead
amlResults - [AmlResult] AML Results
Arguments
id - Int
latestOnly - Boolean
addressVerificationResult - AddressVerificationResult Address verification result
Example
{
  "id": 123,
  "result": "AWAITING",
  "createdDate": "2007-12-03T10:15:30Z",
  "reportUrl": "xyz789",
  "identificationDocument": IdentificationDocument,
  "notes": [Note],
  "amlResult": AmlResult,
  "amlResults": [AmlResult],
  "addressVerificationResult": AddressVerificationResult
}
Types

CheckResultFilterInput

Fields
Input Field Description
and - [CheckResultFilterInput!]
or - [CheckResultFilterInput!]
id - IntOperationFilterInput
checkId - IntOperationFilterInput
reportUrl - StringOperationFilterInput
result - CheckResultTypeOperationFilterInput
check - CheckFilterInput
identificationDocument - IdentificationDocumentFilterInput
amlResult - AmlResultFilterInput
amlResults - ListFilterInputTypeOfAmlResultFilterInput
notes - ListFilterInputTypeOfNoteFilterInput
addressVerificationResult - AddressVerificationResultFilterInput
hasUpdates - BooleanOperationFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
lastModifiedDate - portfolio_DateTimeOperationFilterInput
lastViewedDate - portfolio_DateTimeOperationFilterInput
Example
{
  "and": [CheckResultFilterInput],
  "or": [CheckResultFilterInput],
  "id": IntOperationFilterInput,
  "checkId": IntOperationFilterInput,
  "reportUrl": StringOperationFilterInput,
  "result": CheckResultTypeOperationFilterInput,
  "check": CheckFilterInput,
  "identificationDocument": IdentificationDocumentFilterInput,
  "amlResult": AmlResultFilterInput,
  "amlResults": ListFilterInputTypeOfAmlResultFilterInput,
  "notes": ListFilterInputTypeOfNoteFilterInput,
  "addressVerificationResult": AddressVerificationResultFilterInput,
  "hasUpdates": BooleanOperationFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput,
  "lastModifiedDate": portfolio_DateTimeOperationFilterInput,
  "lastViewedDate": portfolio_DateTimeOperationFilterInput
}
Types

CheckResultMonitoringChangesDbModel

Fields
Field Name Description
id - UUID!
checkId - UUID!
checkType - String
changes - String
changeSource - String
provider - String
externalReference - String
metadata - String
changedAt - DateTime
changedBy - String
createdAt - DateTime
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkType": "xyz789",
  "changes": "abc123",
  "changeSource": "abc123",
  "provider": "xyz789",
  "externalReference": "abc123",
  "metadata": "abc123",
  "changedAt": "2007-12-03T10:15:30Z",
  "changedBy": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "check": CheckV2
}
Types

CheckResultSearchType

Fields
Field Name Description
hasUpdates - Boolean Has the check had updates since last viewed
id - Int! Check Result Id
result - CheckResultType! Type of result
reportUrl - String Url for report
createdDate - DateTime! Date result created
lastViewedDate - DateTime! Date check last viewed in full
lastModifiedDate - DateTime! Date check last modified
identificationDocument - IdentificationDocumentSearchType Identification document details
amlResults - [AmlResultSearchType] AML Result details
Arguments
where - AmlResultFilterInput
order - [AmlResultSortInput!]
Example
{
  "hasUpdates": false,
  "id": 123,
  "result": "AWAITING",
  "reportUrl": "abc123",
  "createdDate": "2007-12-03T10:15:30Z",
  "lastViewedDate": "2007-12-03T10:15:30Z",
  "lastModifiedDate": "2007-12-03T10:15:30Z",
  "identificationDocument": IdentificationDocumentSearchType,
  "amlResults": [AmlResultSearchType]
}
Types

CheckResultSortInput

Fields
Input Field Description
id - SortEnumType
checkId - SortEnumType
reportUrl - SortEnumType
result - SortEnumType
check - CheckSortInput
identificationDocument - IdentificationDocumentSortInput
amlResult - AmlResultSortInput
addressVerificationResult - AddressVerificationResultSortInput
hasUpdates - SortEnumType
createdDate - SortEnumType
lastModifiedDate - SortEnumType
lastViewedDate - SortEnumType
Example
{
  "id": "ASC",
  "checkId": "ASC",
  "reportUrl": "ASC",
  "result": "ASC",
  "check": CheckSortInput,
  "identificationDocument": IdentificationDocumentSortInput,
  "amlResult": AmlResultSortInput,
  "addressVerificationResult": AddressVerificationResultSortInput,
  "hasUpdates": "ASC",
  "createdDate": "ASC",
  "lastModifiedDate": "ASC",
  "lastViewedDate": "ASC"
}
Types

CheckResultType

Values
Enum Value Description

AWAITING

PASSED

CONSIDER

FAILED
Example
"AWAITING"
Types

CheckResultTypeOperationFilterInput

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

CheckSearchType

Description

CheckSearch

Fields
Field Name Description
options - CheckOptions
detail - CheckDetailSearchType Details about person being checked
user - UserSearchType User who performed the check
statuses - [CheckStatusSearchType] Statuses of check
Arguments
order - [CheckStatusSortInput!]
result - CheckResultSearchType Result of check
id - Int! Check Id
reference - String Unique of check
bulkReference - String Bulk Reference
isBulk - Boolean! Is Bulk
isMonitored - Boolean! Will monitored any PSAM searches performed as part of this check.
createdDate - DateTime! Date check was created
checkType - CheckTypeEnum Type of check performed
checkStartUrl - String Identification Check Start Link
notifications - [CheckNotification] Notifications against such as email devivery status
Arguments
order - [CheckNotificationSortInput!]
Example
{
  "options": CheckOptions,
  "detail": CheckDetailSearchType,
  "user": UserSearchType,
  "statuses": [CheckStatusSearchType],
  "result": CheckResultSearchType,
  "id": 123,
  "reference": "xyz789",
  "bulkReference": "abc123",
  "isBulk": true,
  "isMonitored": false,
  "createdDate": "2007-12-03T10:15:30Z",
  "checkType": "KNOW_YOUR_CLIENT",
  "checkStartUrl": "xyz789",
  "notifications": [CheckNotification]
}
Types

CheckSortInput

Fields
Input Field Description
id - SortEnumType
userEmail - SortEnumType
accountId - SortEnumType
reference - SortEnumType
bulkReference - SortEnumType
checkType - SortEnumType
isBulk - SortEnumType
isMonitored - SortEnumType
createdDate - SortEnumType
options - CheckOptionsSortInput
checkBranding - CheckBrandingSortInput
detail - CheckDetailSortInput
user - UserSortInput
result - CheckResultSortInput
complyAdvantageSearch - ComplyAdvantageSearchSortInput
authenticationLink - AuthenticationLinkSortInput
account - AccountSortInput
Example
{
  "id": "ASC",
  "userEmail": "ASC",
  "accountId": "ASC",
  "reference": "ASC",
  "bulkReference": "ASC",
  "checkType": "ASC",
  "isBulk": "ASC",
  "isMonitored": "ASC",
  "createdDate": "ASC",
  "options": CheckOptionsSortInput,
  "checkBranding": CheckBrandingSortInput,
  "detail": CheckDetailSortInput,
  "user": UserSortInput,
  "result": CheckResultSortInput,
  "complyAdvantageSearch": ComplyAdvantageSearchSortInput,
  "authenticationLink": AuthenticationLinkSortInput,
  "account": AccountSortInput
}
Types

CheckStatus

Description

Check Status

Fields
Field Name Description
id - Int! Check Status Id
status - CheckStatusType! Check Status
createdDate - DateTime! Check Status Created DateTime
Example
{
  "id": 987,
  "status": "CREATED",
  "createdDate": "2007-12-03T10:15:30Z"
}
Types

CheckStatusFilterInput

Fields
Input Field Description
and - [CheckStatusFilterInput!]
or - [CheckStatusFilterInput!]
id - IntOperationFilterInput
checkId - IntOperationFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
check - CheckFilterInput
status - CheckStatusTypeOperationFilterInput
Example
{
  "and": [CheckStatusFilterInput],
  "or": [CheckStatusFilterInput],
  "id": IntOperationFilterInput,
  "checkId": IntOperationFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput,
  "check": CheckFilterInput,
  "status": CheckStatusTypeOperationFilterInput
}
Types

CheckStatusSearchType

Fields
Field Name Description
id - Int! Check Status Id
status - CheckStatusType! Check Status
createdDate - DateTime! Check Status Created DateTime
Example
{
  "id": 123,
  "status": "CREATED",
  "createdDate": "2007-12-03T10:15:30Z"
}
Types

CheckStatusSortInput

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

CheckStatusType

Values
Enum Value Description

CREATED

STARTED

COMPLETED

REQUESTED

OVERRIDDEN_PASS

OVERRIDDEN_FAIL
Example
"CREATED"
Types

CheckStatusTypeOperationFilterInput

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

CheckTypeEnum

Values
Enum Value Description

KNOW_YOUR_CLIENT

KNOW_YOUR_CLIENT_BASIC_AML

KNOW_YOUR_CLIENT_ENHANCED_AML

KNOW_YOUR_CLIENT_PSAM

PSAM

DOCUMENT_CHECK_BASIC_AML

DOCUMENT_CHECK_ENHANCED_AML

BASIC_AML
Example
"KNOW_YOUR_CLIENT"
Types

CheckTypeV2

Description

A check type in the v2 system

Fields
Field Name Description
id - UUID! Unique check type identifier
name - String Check type name
checkCheckTypes - [CheckCheckTypeV2!]! Check associations for this type
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "name": "xyz789",
  "checkCheckTypes": [CheckCheckTypeV2]
}
Types

CheckV2

Description

A verification check in the v2 system

Fields
Field Name Description
id - UUID! Unique check identifier
accountId - String Associated account identifier
jurisdictionCode - String Jurisdiction code for this check
reference - String External reference for this check
formData - String Form data associated with this check
isMonitored - Boolean Whether this check is being monitored
options - String Check options and configuration
configVersion - String Configuration version used for this check
status - String Current status of the check
requestedByUsername - String Username of the person who created the check
requestedByEmail - String Email of the person who created the check
createdAt - DateTime When the check was created
updatedAt - DateTime When the check was last updated
auditLogs - [AuditLogV2] Audit trail for this check
checkCheckTypes - [CheckCheckTypeV2] Check types associated with this check
notes - [NoteV2] Notes associated with this check
idvResults - [IdvResultV2] IDV verification results
psamCheckResults - [PsamCheckResult] PSAM check results
bankAccountVerificationResults - [BankAccountVerificationResult] Bank account verification results
documentCheckResults - [DocumentCheckResult] Document check results
addressVerificationResults - [AddressVerificationResultV2] Address verification results
amlResults - [AmlResultV2] AML check results
result - String
persons - [PersonV2!]
phoneVerificationResults - [PhoneVerificationResult!]
monitoringChanges - [CheckResultMonitoringChangesDbModel!]
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "accountId": "abc123",
  "jurisdictionCode": "abc123",
  "reference": "abc123",
  "formData": "xyz789",
  "isMonitored": true,
  "options": "xyz789",
  "configVersion": "abc123",
  "status": "abc123",
  "requestedByUsername": "abc123",
  "requestedByEmail": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "auditLogs": [AuditLogV2],
  "checkCheckTypes": [CheckCheckTypeV2],
  "notes": [NoteV2],
  "idvResults": [IdvResultV2],
  "psamCheckResults": [PsamCheckResult],
  "bankAccountVerificationResults": [
    BankAccountVerificationResult
  ],
  "documentCheckResults": [DocumentCheckResult],
  "addressVerificationResults": [
    AddressVerificationResultV2
  ],
  "amlResults": [AmlResultV2],
  "result": "xyz789",
  "persons": [PersonV2],
  "phoneVerificationResults": [PhoneVerificationResult],
  "monitoringChanges": [
    CheckResultMonitoringChangesDbModel
  ]
}
Types

ChecksCollectionSegment

Description

A segment of a collection.

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

CollectionSegmentInfo

Description

Information about the offset pagination.

Fields
Field Name Description
hasNextPage - Boolean! Indicates whether more items exist following the set defined by the clients arguments.
hasPreviousPage - Boolean! Indicates whether more items exist prior the set defined by the clients arguments.
Example
{"hasNextPage": true, "hasPreviousPage": true}
Types

CommentType

Values
Enum Value Description

UNKNOWN

FAVOURABLE

UNFAVOURABLE
Example
"UNKNOWN"
Types

CommentTypeOperationFilterInput

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

CompaniesCollectionSegment

Description

A segment of a collection.

Fields
Field Name Description
pageInfo - CollectionSegmentInfo! Information to aid in pagination.
items - [CompanySearch] A flattened list of the items.
totalCount - Int!
aggregations - [CompanyAggregateBucket]
Arguments
options - [CompanyAggregationInput]
searchAfter - String
Example
{
  "pageInfo": CollectionSegmentInfo,
  "items": [CompanySearch],
  "totalCount": 123,
  "aggregations": [CompanyAggregateBucket],
  "searchAfter": "abc123"
}
Types

CompanyActivity

Fields
Field Name Description
description - String
Example
{"description": "abc123"}
Types

CompanyAggregate

Fields
Field Name Description
key - String
value - Float
valueAsString - String
Example
{
  "key": "abc123",
  "value": 123.45,
  "valueAsString": "abc123"
}
Types

CompanyAggregateBucket

Fields
Field Name Description
name - String
aggregates - [CompanyAggregate]
Example
{
  "name": "abc123",
  "aggregates": [CompanyAggregate]
}
Types

CompanyAggregationInput

Fields
Input Field Description
term - TermsAggregationInput
range - RangeAggregationInput
metric - MetricAggregationInput
percentile - PercentileAggregationInput
percentileRank - PercentileRankAggregationInput
Example
{
  "term": TermsAggregationInput,
  "range": RangeAggregationInput,
  "metric": MetricAggregationInput,
  "percentile": PercentileAggregationInput,
  "percentileRank": PercentileRankAggregationInput
}
Types

CompanyAppointmentType

Values
Enum Value Description

UNKNOWN

DIRECTOR

NON_DESIGNATED_LIMITED_LIABILITY_PARTNERSHIP_MEMBER

DESIGNATED_LIMITED_LIABILITY_PARTNERSHIP_MEMBER

COMPANY_SECRETARY

JUDICIAL_FACTOR

RECEIVER_OR_MANAGER_UNDER_CHARITIES_ACT

MANAGER_AUDIT_INVESTIGATIONS_COMMUNITY_ENTERPRISE_ACT
Example
"UNKNOWN"
Types

CompanyAppointmentTypeOperationFilterInput

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

CompanyArchive

Fields
Field Name Description
id - UUID!
createdDate - DateTime!
expiryDate - DateTime!
userId - String
countryCode - CountryCode!
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "createdDate": "2007-12-03T10:15:30Z",
  "expiryDate": "2007-12-03T10:15:30Z",
  "userId": "xyz789",
  "countryCode": "AFG"
}
Types

CompanyArchiveFilterInput

Fields
Input Field Description
and - [CompanyArchiveFilterInput!]
or - [CompanyArchiveFilterInput!]
id - UuidOperationFilterInput
createdDate - DateTimeOperationFilterInput
expiryDate - DateTimeOperationFilterInput
userId - StringOperationFilterInput
countryCode - CountryCodeOperationFilterInput
Example
{
  "and": [CompanyArchiveFilterInput],
  "or": [CompanyArchiveFilterInput],
  "id": UuidOperationFilterInput,
  "createdDate": DateTimeOperationFilterInput,
  "expiryDate": DateTimeOperationFilterInput,
  "userId": StringOperationFilterInput,
  "countryCode": CountryCodeOperationFilterInput
}
Types

CompanyBeneficiary

Fields
Field Name Description
address - Address
key - String
type - CompanyBeneficiaryType!
label - String
ownership_percentage - Float
separation - Int!
is_beneficiary - Boolean!
Example
{
  "address": Address,
  "key": "xyz789",
  "type": "BUSINESS",
  "label": "abc123",
  "ownership_percentage": 987.65,
  "separation": 987,
  "is_beneficiary": false
}
Types

CompanyBeneficiaryFilterInput

Fields
Input Field Description
and - [CompanyBeneficiaryFilterInput!]
or - [CompanyBeneficiaryFilterInput!]
address - AddressFilterInput
key - StringOperationFilterInput
type - CompanyBeneficiaryTypeOperationFilterInput
label - StringOperationFilterInput
ownership_percentage - FloatOperationFilterInput
separation - IntOperationFilterInput
is_beneficiary - BooleanOperationFilterInput
Example
{
  "and": [CompanyBeneficiaryFilterInput],
  "or": [CompanyBeneficiaryFilterInput],
  "address": AddressFilterInput,
  "key": StringOperationFilterInput,
  "type": CompanyBeneficiaryTypeOperationFilterInput,
  "label": StringOperationFilterInput,
  "ownership_percentage": FloatOperationFilterInput,
  "separation": IntOperationFilterInput,
  "is_beneficiary": BooleanOperationFilterInput
}
Types

CompanyBeneficiaryRelationship

Fields
Field Name Description
in_key - String
out_key - String
label - String
share_percentage - Float
implied_share_percentage - Float
relationship_type - CompanyBeneficiaryRelationshipType!
Example
{
  "in_key": "abc123",
  "out_key": "xyz789",
  "label": "xyz789",
  "share_percentage": 123.45,
  "implied_share_percentage": 123.45,
  "relationship_type": "PERSONS_OF_SIGNIFICANT_CONTROL"
}
Types

CompanyBeneficiaryRelationshipFilterInput

Fields
Input Field Description
and - [CompanyBeneficiaryRelationshipFilterInput!]
or - [CompanyBeneficiaryRelationshipFilterInput!]
in_key - StringOperationFilterInput
out_key - StringOperationFilterInput
label - StringOperationFilterInput
share_percentage - FloatOperationFilterInput
implied_share_percentage - FloatOperationFilterInput
relationship_type - CompanyBeneficiaryRelationshipTypeOperationFilterInput
Example
{
  "and": [CompanyBeneficiaryRelationshipFilterInput],
  "or": [CompanyBeneficiaryRelationshipFilterInput],
  "in_key": StringOperationFilterInput,
  "out_key": StringOperationFilterInput,
  "label": StringOperationFilterInput,
  "share_percentage": FloatOperationFilterInput,
  "implied_share_percentage": FloatOperationFilterInput,
  "relationship_type": CompanyBeneficiaryRelationshipTypeOperationFilterInput
}
Types

CompanyBeneficiaryRelationshipType

Values
Enum Value Description

PERSONS_OF_SIGNIFICANT_CONTROL

UNIDENTIFIED_SHARE_OWNERSHIP

SHARE_OWNERSHIP

UNKNOWN
Example
"PERSONS_OF_SIGNIFICANT_CONTROL"
Types

CompanyBeneficiaryRelationshipTypeOperationFilterInput

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

CompanyBeneficiaryType

Values
Enum Value Description

BUSINESS

INDIVIDUAL

UNKNOWN
Example
"BUSINESS"
Types

CompanyBeneficiaryTypeOperationFilterInput

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

CompanyDetails

Fields
Field Name Description
incorporationDate - DateTime
addresses - [Address]
registrationNumbers - [RegistrationNumber]
activities - [CompanyActivity]
employees - [EmployeeCount]
industryCodes - [IndustryCode]
telephoneNumber - String
email - String
website - String
url - String
Example
{
  "incorporationDate": "2007-12-03T10:15:30Z",
  "addresses": [Address],
  "registrationNumbers": [RegistrationNumber],
  "activities": [CompanyActivity],
  "employees": [EmployeeCount],
  "industryCodes": [IndustryCode],
  "telephoneNumber": "abc123",
  "email": "abc123",
  "website": "xyz789",
  "url": "abc123"
}
Types

CompanyField

Values
Enum Value Description

DIRECTORS_AGE_YEARS

DIRECTORS_APPOINTMENT_DURATION_YEARS

DIRECTORS_TITLE

DIRECTORS_OCCUPATION

DIRECTORS_NATIONALITIES

DIRECTORS_NATIONALITIES_ISO3

CREDIT_LIMITS_COMPANY_ID

CREDIT_LIMITS_CREDIT_LIMIT

CREDIT_LIMITS_CURRENCY

CREDIT_LIMITS_PUBLISHED_DATE

ADDRESSES_ADDRESS_LINE_1

ADDRESSES_ADDRESS_LINE_2

ADDRESSES_ADDRESS_LINE_3

ADDRESSES_ADDRESS_LINE_4

ADDRESSES_TOWN

ADDRESSES_COUNTY

ADDRESSES_COUNTRY

ADDRESSES_COUNTRY_CODE

ADDRESSES_POSTCODE

ADDRESSES_TYPE

ADDRESSES_LOCATION

ADDRESSES_POSTCODE_AREA

ADDRESSES_POSTCODE_DISTRICT

ADDRESSES_ORIGINAL_COUNTY

ADDRESSES_DISTRICT

ADDRESSES_OS_EASTING

ADDRESSES_OS_NORTHING

ADDRESSES_LA_UA_GSSCODE

ADDRESSES_LA_UA_NAME

ADDRESSES_REGION

ADDRESSES_LEP_NAME

ADDRESSES_COMBINED_AUTHORITY_NAME

MORTGAGES_DATE_CREATED

MORTGAGES_TYPE

MORTGAGES_HOLDER

MORTGAGES_SECURED_ON

MORTGAGES_FORM_NO

MORTGAGES_SATISFIED

MORTGAGES_DETAILS

MORTGAGES_MORTGAGE_ID

MORTGAGES_MORTGAGE_NO

MORTGAGES_COMPANIES_COMPANY_ID

MORTGAGES_SATISFIED_DATE

GAZETTE_NOTICES_COMPANY_ID

GAZETTE_NOTICES_PUBLISHED_DATE

GAZETTE_NOTICES_CREATED_DATE

GAZETTE_NOTICES_NOTICE_CODE_VALUE

GAZETTE_NOTICES_NOTICE_CODE_NAME

GAZETTE_NOTICES_URI

GAZETTE_NOTICES_NOTICE_ID

GAZETTE_NOTICES_SOURCE

CCJS_CURRENCY

CCJS_COMPANY_ID

CCJS_ADDRESS

CCJS_AMOUNT

CCJS_CASE_NUMBER

CCJS_COURT_NAME

CCJS_DATE_OF_BIRTH

CCJS_DATE_OF_JUDGEMENT

CCJS_ENTITY_TYPE

CCJS_GIVEN_NAME

CCJS_JUDGEMENT_TYPE

CCJS_RTL_IMAGE_NUMBER

CCJS_RUN_DATE

CCJS_RECORD_TYPE

CCJS_SATISFACTION_DATE

CCJS_SUFFIX

CCJS_SURNAME

CCJS_TITLE

CCJS_TRADING_STYLE

POSSIBLE_CCJS_CURRENCY

POSSIBLE_CCJS_COMPANY_ID

POSSIBLE_CCJS_ADDRESS

POSSIBLE_CCJS_AMOUNT

POSSIBLE_CCJS_CASE_NUMBER

POSSIBLE_CCJS_COURT_NAME

POSSIBLE_CCJS_DATE_OF_BIRTH

POSSIBLE_CCJS_DATE_OF_JUDGEMENT

POSSIBLE_CCJS_ENTITY_TYPE

POSSIBLE_CCJS_GIVEN_NAME

POSSIBLE_CCJS_JUDGEMENT_TYPE

POSSIBLE_CCJS_RTL_IMAGE_NUMBER

POSSIBLE_CCJS_RUN_DATE

POSSIBLE_CCJS_RECORD_TYPE

POSSIBLE_CCJS_SATISFACTION_DATE

POSSIBLE_CCJS_SUFFIX

POSSIBLE_CCJS_SURNAME

POSSIBLE_CCJS_TITLE

POSSIBLE_CCJS_TRADING_STYLE

PROFIT_LOSS_PROFIT_LOSS_ID

PROFIT_LOSS_ACCOUNT_DATE

PROFIT_LOSS_NO_WEEKS

PROFIT_LOSS_CONSOLIDATED

PROFIT_LOSS_CURRENCY

PROFIT_LOSS_TURNOVER

PROFIT_LOSS_COST_OF_SALES

PROFIT_LOSS_GROSS_PROFIT

PROFIT_LOSS_OPERATING_PROFIT

PROFIT_LOSS_NON_TRADING_INCOME

PROFIT_LOSS_INTEREST_PAYABLE

PROFIT_LOSS_PRE_TAX_PROFIT

PROFIT_LOSS_TAXATION

PROFIT_LOSS_POST_TAX_PROFIT

PROFIT_LOSS_DIVIDENDS

PROFIT_LOSS_RETAINED_PROFIT

PROFIT_LOSS_VALUE_ADDED

PROFIT_LOSS_AUDIT_FEE

PROFIT_LOSS_DIRECTOR_RENUM

PROFIT_LOSS_NON_AUDIT_FEE

PROFIT_LOSS_EMPLOYEES

PROFIT_LOSS_COMPANIES_COMPANY_ID

PROFIT_LOSS_EBITDA

BALANCE_SHEET_BALANCE_SHEET_ID

BALANCE_SHEET_COMPANIES_COMPANY_ID

BALANCE_SHEET_AUDITOR

BALANCE_SHEET_AUDITOR_COMMENTS

BALANCE_SHEET_ACCOUNT_DATE

BALANCE_SHEET_NO_WEEKS

BALANCE_SHEET_CURRENCY

BALANCE_SHEET_TANGIBLE_FIXED_ASSETS

BALANCE_SHEET_INTANGIBLE_ASSETS

BALANCE_SHEET_TOTAL_FIXED_ASSETS

BALANCE_SHEET_STOCKS

BALANCE_SHEET_TRADE_DEBTORS

BALANCE_SHEET_TRADE_CREDITORS

BALANCE_SHEET_CASH

BALANCE_SHEET_MISC_CURRENT_ASSETS

BALANCE_SHEET_TOTAL_CURRENT_ASSETS

BALANCE_SHEET_CREDITORS_AMOUNTS_FALLING

BALANCE_SHEET_TOTAL_ASSETS_LESS_LIABILITIES

BALANCE_SHEET_TOTAL_LONG_TERM_LIABILITIES

BALANCE_SHEET_TOTAL_LIABILITIES

BALANCE_SHEET_SHARE_CAPITAL_RESERVE

BALANCE_SHEET_PL_ACCOUNT_RESERVE

BALANCE_SHEET_REVALUATION_RESERVE

BALANCE_SHEET_SHAREHOLDERS_FUNDS

BALANCE_SHEET_WORKING_CAPITAL

BALANCE_SHEET_NET_WORTH

BALANCE_SHEET_TOTAL_ASSETS

BALANCE_SHEET_CONTINGENT_LIABILITIES

CREDITORS_STATUS

CREDITORS_AMOUNT

CREDITORS_ADDRESS

CREDITORS_COMPANY_NAME

CREDITORS_COMPANY_NUMBER

CREDITORS_STATEMENT_DATE

CREDITORS_INSOLVENCY_PRACTITIONERS

CREDITORS_UPLOAD_DATE

CREDITORS_COMPANY_ID

DEBTORS_STATUS

DEBTORS_AMOUNT

DEBTORS_ADDRESS

DEBTORS_COMPANY_NAME

DEBTORS_COMPANY_NUMBER

DEBTORS_STATEMENT_DATE

DEBTORS_INSOLVENCY_PRACTITIONERS

DEBTORS_UPLOAD_DATE

DEBTORS_COMPANY_ID

CASHFLOW_ACCOUNT_DATE

CASHFLOW_NO_WEEKS

CASHFLOW_CONSOLIDATED

CASHFLOW_CURRENCY

CASHFLOW_NET_FROM_OPERATING_ACTIVITIES

CASHFLOW_NET_FROM_RETURN_INVESTMENT_SERVICING

CASHFLOW_NET_BEFORE_FINANCING

CASHFLOW_NET_FROM_FINANCING

CASHFLOW_INCREASE_IN_CASH

DIRECTOR_SUMMARY_TOTAL_CURRENT

DIRECTOR_SUMMARY_TOTAL_PREVIOUS

RELEVANCE

ESTIMATED_TURNOVER

ESTIMATED_EMPLOYEES

EMPLOYEES

TURNOVER

GROWTH_SCORE

RFA_RATING_SUMMARY

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_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

HAS_DIRECTORSHIPS

HAS_FINANCIALS

IS_LIMITED

IS_TRADING

COMPANY_NAME

LEGAL_STATUS

AUDITOR

COMPANY_TYPE

PROCESSED_AT

LAST_UPDATED

PARENT_COMPANY

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

VAT_NUMBER

RFA_RATING_RANK
Example
"DIRECTORS_AGE_YEARS"
Types

CompanyFinancials

Fields
Field Name Description
currency - CurrencyCode
latestFilingDate - DateTime
profitLoss - [Profit_Loss]
balanceSheets - [Balance_Sheet]
cashflow - [CashFlow]
ratios - [FinancialRatio]
creditLimit - CurrencyAmount
creditScore - Decimal
creditorDays - Long
Example
{
  "currency": "AED",
  "latestFilingDate": "2007-12-03T10:15:30Z",
  "profitLoss": [Profit_Loss],
  "balanceSheets": [Balance_Sheet],
  "cashflow": [CashFlow],
  "ratios": [FinancialRatio],
  "creditLimit": CurrencyAmount,
  "creditScore": Decimal,
  "creditorDays": {}
}
Types

CompanyHistoriesCollectionSegment

Description

A segment of a collection.

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

CompanyNumericField

Values
Enum Value Description

DIRECTORS_AGE_YEARS

DIRECTORS_APPOINTMENT_DURATION_YEARS

CREDIT_LIMITS_CREDIT_LIMIT

ADDRESSES_OS_EASTING

ADDRESSES_OS_NORTHING

MORTGAGES_MORTGAGE_NO

CCJS_AMOUNT

CCJS_ENTITY_TYPE

POSSIBLE_CCJS_AMOUNT

POSSIBLE_CCJS_ENTITY_TYPE

PROFIT_LOSS_NO_WEEKS

PROFIT_LOSS_TURNOVER

PROFIT_LOSS_COST_OF_SALES

PROFIT_LOSS_GROSS_PROFIT

PROFIT_LOSS_OPERATING_PROFIT

PROFIT_LOSS_NON_TRADING_INCOME

PROFIT_LOSS_INTEREST_PAYABLE

PROFIT_LOSS_PRE_TAX_PROFIT

PROFIT_LOSS_TAXATION

PROFIT_LOSS_POST_TAX_PROFIT

PROFIT_LOSS_DIVIDENDS

PROFIT_LOSS_RETAINED_PROFIT

PROFIT_LOSS_VALUE_ADDED

PROFIT_LOSS_AUDIT_FEE

PROFIT_LOSS_DIRECTOR_RENUM

PROFIT_LOSS_NON_AUDIT_FEE

PROFIT_LOSS_EMPLOYEES

PROFIT_LOSS_EBITDA

BALANCE_SHEET_NO_WEEKS

BALANCE_SHEET_TANGIBLE_FIXED_ASSETS

BALANCE_SHEET_INTANGIBLE_ASSETS

BALANCE_SHEET_TOTAL_FIXED_ASSETS

BALANCE_SHEET_STOCKS

BALANCE_SHEET_TRADE_DEBTORS

BALANCE_SHEET_TRADE_CREDITORS

BALANCE_SHEET_CASH

BALANCE_SHEET_MISC_CURRENT_ASSETS

BALANCE_SHEET_TOTAL_CURRENT_ASSETS

BALANCE_SHEET_CREDITORS_AMOUNTS_FALLING

BALANCE_SHEET_TOTAL_ASSETS_LESS_LIABILITIES

BALANCE_SHEET_TOTAL_LONG_TERM_LIABILITIES

BALANCE_SHEET_TOTAL_LIABILITIES

BALANCE_SHEET_SHARE_CAPITAL_RESERVE

BALANCE_SHEET_PL_ACCOUNT_RESERVE

BALANCE_SHEET_REVALUATION_RESERVE

BALANCE_SHEET_SHAREHOLDERS_FUNDS

BALANCE_SHEET_WORKING_CAPITAL

BALANCE_SHEET_NET_WORTH

BALANCE_SHEET_TOTAL_ASSETS

BALANCE_SHEET_CONTINGENT_LIABILITIES

CREDITORS_AMOUNT

DEBTORS_AMOUNT

CASHFLOW_NO_WEEKS

CASHFLOW_NET_FROM_OPERATING_ACTIVITIES

CASHFLOW_NET_FROM_RETURN_INVESTMENT_SERVICING

CASHFLOW_NET_BEFORE_FINANCING

CASHFLOW_NET_FROM_FINANCING

CASHFLOW_INCREASE_IN_CASH

RELEVANCE

ESTIMATED_TURNOVER

ESTIMATED_EMPLOYEES

EMPLOYEES

TURNOVER

GROWTH_SCORE

RFA_RATING_SCORE

RAW_RATING_SCORE

TOTAL_ASSETS

TPS_REGISTERED

GDPR_REGISTERED

REVENUE_INCREASE

CREDITOR_DAYS

CREDIT_SCORE

CREDIT_LIMIT

HAS_DIRECTORSHIPS

HAS_FINANCIALS

IS_LIMITED

IS_TRADING

HAS_CONTACT

HAS_PHONE_CONTACT

HAS_EMAIL_CONTACT

RFA_RATING

ORDERED_RFA_RATING

RFA_RATING_RANK
Example
"DIRECTORS_AGE_YEARS"
Types

CompanyPortfolio

Fields
Field Name Description
companyId - Int CompanyId
portfolioId - Int! PortfolioId
notes - String Notes
portfolio - Portfolio Portfolio
portfolioEvents - [PortfolioEvent] Portfolio Events
Arguments
order - [PortfolioEventSortInput!]
accountEmail - String AccountEmail
createdTime - DateTime! CreatedTime
id - Int! Id
company - CompanySearch
Example
{
  "companyId": 987,
  "portfolioId": 987,
  "notes": "abc123",
  "portfolio": Portfolio,
  "portfolioEvents": [PortfolioEvent],
  "accountEmail": "xyz789",
  "createdTime": "2007-12-03T10:15:30Z",
  "id": 123,
  "company": CompanySearch
}
Types

CompanyPortfolioFilterInput

Fields
Input Field Description
and - [CompanyPortfolioFilterInput!]
or - [CompanyPortfolioFilterInput!]
id - IntOperationFilterInput
companyId - IntOperationFilterInput
portfolioId - IntOperationFilterInput
notes - StringOperationFilterInput
portfolio - PortfolioFilterInput
createdTime - portfolio_DateTimeOperationFilterInput
accountEmail - StringOperationFilterInput
isActive - BooleanOperationFilterInput
portfolioEvents - ListFilterInputTypeOfPortfolioEventFilterInput
Example
{
  "and": [CompanyPortfolioFilterInput],
  "or": [CompanyPortfolioFilterInput],
  "id": IntOperationFilterInput,
  "companyId": IntOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "notes": StringOperationFilterInput,
  "portfolio": PortfolioFilterInput,
  "createdTime": portfolio_DateTimeOperationFilterInput,
  "accountEmail": StringOperationFilterInput,
  "isActive": BooleanOperationFilterInput,
  "portfolioEvents": ListFilterInputTypeOfPortfolioEventFilterInput
}
Types

CompanyPortfolioInput

Fields
Input Field Description
companyIds - [Int]
portfolioId - Int!
notes - String
Example
{
  "companyIds": [123],
  "portfolioId": 987,
  "notes": "xyz789"
}
Types

CompanyPortfolioSortInput

Fields
Input Field Description
id - SortEnumType
companyId - SortEnumType
portfolioId - SortEnumType
notes - SortEnumType
portfolio - PortfolioSortInput
createdTime - SortEnumType
accountEmail - SortEnumType
isActive - SortEnumType
Example
{
  "id": "ASC",
  "companyId": "ASC",
  "portfolioId": "ASC",
  "notes": "ASC",
  "portfolio": PortfolioSortInput,
  "createdTime": "ASC",
  "accountEmail": "ASC",
  "isActive": "ASC"
}
Types

CompanyPortfoliosCollectionSegment

Description

A segment of a collection.

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

CompanyRating

Values
Enum Value Description

THREE_RED_FLAGS

 For any concern carrying three red flags no credit terms should be offered or trading undertaken and a full disclosure of the situation should be obtained.

TWO_RED_FLAGS

 These businesses have a poor credit score or where serious detrimental information has been identified. Trading with these concerns is very high risk. It is advisable to review the full company report.

ONE_RED_FLAG

 These businesses will be higher credit risks due to their past trading history, lack of information or may have detrimental information against them. They could be slow in paying their suppliers and it is recommended that any trading undertaken be supervised carefully. All monitoring notices should be reviewed immediately and acted upon quickly.

NOT_SET

AMBER

BRONZE

SILVER

GOLD

NA

NOT_TRADING

INSOLVENT

STRIKE_OFF

DISSOLVED

BUSINESS_DISCONTINUED

PRE_INSOLVENCY

NEWLY_INCORPORATED

PROVISIONAL_TWO_RED_FLAGS

PROVISIONAL_ONE_RED_FLAG

PROVISIONAL_BRONZE

PROVISIONAL_SILVER

INACTIVE

UNKNOWN
Example
"THREE_RED_FLAGS"
Types

CompanyRatingOperationFilterInput

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

CompanyReport

Fields
Field Name Description
rfa_rating_summary - String
corporate_structure - [CorporateEntity] Corporate Hierarchy
persons_with_significant_control - [PersonsWithSignificantControl] Persons of significant control
filing_history - [FilingHistory] Filing History
people - [Person] Related People
beneficial_owner_graph - BeneficialOwnerGraph Beneficial Owner Graph
beneficial_owners - [BeneficialOwner] Beneficial Owners
active_directors - [Director]
history - HistoryCollectionSegment
Arguments
skip - Int
take - Int
where - HistoryFilterInput
order - [HistorySortInput!]
rfa_rating_breakdown - RatingBreakdownResult
country_code - CountryCode
archive_id - String
archive - [CompanyArchive]
id - Int!
company_id - String
estimated_turnover - Decimal
estimated_employees - Int
employees - Long
turnover - Decimal
growth_score - Float
rfa_rating_score - Float
raw_rating_score - Float
company_number - String
incorporation_date - DateTime
dissolution_date - DateTime
dissolution_status - String
total_assets - Long
last_filed_accounts - DateTime
accounts_next_due - DateTime
tps_registered - Boolean
gdpr_registered - Boolean
marketing_preference - String
website - String
primary_sic07_code - String
revenue_increase - Long
creditor_days - Long
credit_score - Decimal
credit_limit - Decimal
sic92_sections - [String]
sic92_codes - [String]
sic92_descriptions - [String]
primary_sic92_code - String
sic07 - [SIC07]
sic07_codes - [String]
sic07_descriptions - [String]
sic07_sections - [String]
sic07_section_descriptions - [String]
sic07_divisions - [String]
sic07_division_descriptions - [String]
sic07_groups - [String]
sic07_group_descriptions - [String]
sic07_classes - [String]
sic07_class_descriptions - [String]
sic07_sub_classes - [String]
sic07_sub_class_descriptions - [String]
directors - [DirectorPartial]
director_summary - DirectorSummary
credit_limits - [CreditLimit]
oldest_director - Director
has_directorships - Boolean
has_financials - Boolean
is_limited - Boolean
is_trading - Boolean
addresses - [Address]
company_name - String
legal_status - String
auditor - String
latest_action - Latest_Action
company_type - String
mortgages - [Mortgage]
gazette_notices - [GazetteNotice]
ccjs - [CCJ]
possible_ccjs - [CCJ]
processed_at - DateTime
last_updated - DateTime
parent_company - String
group_id - String
telephone_number - String
email - String
has_contact - Boolean
has_phone_contact - Boolean
has_email_contact - Boolean
rfa_rating - CompanyRating
generated_rfa_rating - RfaRating
previous_rfa_rating - RfaRating
rating_changed_date - DateTime
previous_rating_changed_date - DateTime
ordered_rfa_rating - OrderedCompanyRating
current_directors - [Current_Directors]
profit_loss - [Profit_Loss]
balance_sheet - [Balance_Sheet]
creditors - [Creditor]
debtors - [Debtor]
detrimental_data - [DetrimentalData]
shareholders - [Shareholder]
poscs - [POSC]
former_names - [FormerName]
cashflow - [CashFlow]
ratio_analysis - [RatioAnalysis]
contacts - [Contact]
functional_currency - CurrencyCode
vat_number - String
rfa_rating_rank - Int!
amlResult - AmlResult
Example
{
  "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": 987,
  "company_id": "xyz789",
  "estimated_turnover": Decimal,
  "estimated_employees": 987,
  "employees": {},
  "turnover": Decimal,
  "growth_score": 987.65,
  "rfa_rating_score": 123.45,
  "raw_rating_score": 987.65,
  "company_number": "xyz789",
  "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": "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": ["xyz789"],
  "sic07_descriptions": ["abc123"],
  "sic07_sections": ["xyz789"],
  "sic07_section_descriptions": ["xyz789"],
  "sic07_divisions": ["xyz789"],
  "sic07_division_descriptions": ["xyz789"],
  "sic07_groups": ["abc123"],
  "sic07_group_descriptions": ["abc123"],
  "sic07_classes": ["xyz789"],
  "sic07_class_descriptions": ["abc123"],
  "sic07_sub_classes": ["abc123"],
  "sic07_sub_class_descriptions": [
    "abc123"
  ],
  "directors": [DirectorPartial],
  "director_summary": DirectorSummary,
  "credit_limits": [CreditLimit],
  "oldest_director": Director,
  "has_directorships": true,
  "has_financials": false,
  "is_limited": false,
  "is_trading": true,
  "addresses": [Address],
  "company_name": "xyz789",
  "legal_status": "xyz789",
  "auditor": "xyz789",
  "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": "xyz789",
  "group_id": "xyz789",
  "telephone_number": "abc123",
  "email": "abc123",
  "has_contact": false,
  "has_phone_contact": true,
  "has_email_contact": true,
  "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": "abc123",
  "rfa_rating_rank": 123,
  "amlResult": AmlResult
}
Types

CompanyReportArchive

Fields
Field Name Description
id - UUID!
accountId - String
userId - String
companyNumber - String
companyName - String
companyId - String
addresses - [Address]
countryCode - CountryCode!
createdDate - DateTime!
expiryDate - DateTime!
reasonCode - CompanyReportReasonCode
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "accountId": "abc123",
  "userId": "xyz789",
  "companyNumber": "abc123",
  "companyName": "xyz789",
  "companyId": "xyz789",
  "addresses": [Address],
  "countryCode": "AFG",
  "createdDate": "2007-12-03T10:15:30Z",
  "expiryDate": "2007-12-03T10:15:30Z",
  "reasonCode": "CREDIT_DECISION"
}
Types

CompanyReportArchiveFilterInput

Fields
Input Field Description
and - [CompanyReportArchiveFilterInput!]
or - [CompanyReportArchiveFilterInput!]
id - UuidOperationFilterInput
createdDate - DateTimeOperationFilterInput
expiryDate - DateTimeOperationFilterInput
companyName - StringOperationFilterInput
companyId - StringOperationFilterInput
companyNumber - StringOperationFilterInput
countryCode - CountryCodeOperationFilterInput
accountId - StringOperationFilterInput
userId - StringOperationFilterInput
addresses - ListFilterInputTypeOfAddressFilterInput
reasonCode - NullableOfCompanyReportReasonCodeOperationFilterInput
Example
{
  "and": [CompanyReportArchiveFilterInput],
  "or": [CompanyReportArchiveFilterInput],
  "id": UuidOperationFilterInput,
  "createdDate": DateTimeOperationFilterInput,
  "expiryDate": DateTimeOperationFilterInput,
  "companyName": StringOperationFilterInput,
  "companyId": StringOperationFilterInput,
  "companyNumber": StringOperationFilterInput,
  "countryCode": CountryCodeOperationFilterInput,
  "accountId": StringOperationFilterInput,
  "userId": StringOperationFilterInput,
  "addresses": ListFilterInputTypeOfAddressFilterInput,
  "reasonCode": NullableOfCompanyReportReasonCodeOperationFilterInput
}
Types

CompanyReportArchiveSortInput

Fields
Input Field Description
id - SortEnumType
createdDate - SortEnumType
expiryDate - SortEnumType
companyName - SortEnumType
companyId - SortEnumType
companyNumber - SortEnumType
countryCode - SortEnumType
accountId - SortEnumType
userId - SortEnumType
reasonCode - SortEnumType
Example
{
  "id": "ASC",
  "createdDate": "ASC",
  "expiryDate": "ASC",
  "companyName": "ASC",
  "companyId": "ASC",
  "companyNumber": "ASC",
  "countryCode": "ASC",
  "accountId": "ASC",
  "userId": "ASC",
  "reasonCode": "ASC"
}
Types

CompanyReportArchivesCollectionSegment

Description

A segment of a collection.

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

CompanyReportBillInput

Fields
Input Field Description
countryCode - String
accountId - String
apiId - String
companyNumber - String
Example
{
  "countryCode": "xyz789",
  "accountId": "abc123",
  "apiId": "abc123",
  "companyNumber": "xyz789"
}
Types

CompanyReportReasonCode

Values
Enum Value Description

CREDIT_DECISION

ASSESSMENT_OF_CREDIT_SOLVENCY_INTENDED_BUSINESS

ASSESSMENT_OF_CREDIT_SOLVENCY_ONGOING_BUSINESS

DEBT_COLLECTION

COMMERCIAL_CREDIT_INSURANCE

INSURANCE_CONTRACT

LEASING_AGREEMENT

RENTAL_AGREEMENT
Example
"CREDIT_DECISION"
Types

CompanyReportRegionView

Fields
Field Name Description
billingRegion - BillingRegion!
viewCount - Int!
uniqueViews - Int!
Example
{"billingRegion": "REST_OF_WORLD", "viewCount": 123, "uniqueViews": 123}
Types

CompanyReportRequestInput

Description

Company report request inputs

Fields
Input Field Description
id - String Id of company
countryCode - CountryCode
reasonCode - CompanyReportReasonCode
archiveId - String Fetch specific report version from archive
fetchLatest - Boolean Fetch the latest copy of report for company. (May incur costs). Default = false
Example
{
  "id": "abc123",
  "countryCode": "AFG",
  "reasonCode": "CREDIT_DECISION",
  "archiveId": "abc123",
  "fetchLatest": false
}
Types

CompanySearch

Fields
Field Name Description
id - Int
company_id - String
posc_summary - PoscSummary
rfa_rating - CompanyRating
rating_history - Rating_historyCollectionSegment Rating history
Arguments
skip - Int
take - Int
corporate_structure - [CorporateEntity]
ultimate_parent - CorporateEntity Corporate Hierarchy
ordered_rfa_rating - OrderedCompanyRating
rfa_rating_rank - Int
addresses - [Address]
active_directors - [Director]
people - [Person]
gazette_notices - [GazetteNotice]
company_number - String
mortgages - [Mortgage]
country_code - CountryCode
archive - [CompanyArchive]
estimated_turnover - Decimal
estimated_employees - Int
employees - Long
turnover - Decimal
growth_score - Float
rfa_rating_score - Float
raw_rating_score - Float
incorporation_date - DateTime
dissolution_date - DateTime
dissolution_status - String
total_assets - Long
last_filed_accounts - DateTime
accounts_next_due - DateTime
tps_registered - Boolean
gdpr_registered - Boolean
marketing_preference - String
website - String
primary_sic07_code - String
revenue_increase - Long
creditor_days - Long
credit_score - Decimal
credit_limit - Decimal
sic92_sections - [String]
sic92_codes - [String]
sic92_descriptions - [String]
primary_sic92_code - String
sic07 - [SIC07]
sic07_codes - [String]
sic07_descriptions - [String]
sic07_sections - [String]
sic07_section_descriptions - [String]
sic07_divisions - [String]
sic07_division_descriptions - [String]
sic07_groups - [String]
sic07_group_descriptions - [String]
sic07_classes - [String]
sic07_class_descriptions - [String]
sic07_sub_classes - [String]
sic07_sub_class_descriptions - [String]
directors - [DirectorPartial]
director_summary - DirectorSummary
credit_limits - [CreditLimit]
oldest_director - Director
has_directorships - Boolean
has_financials - Boolean
is_limited - Boolean
is_trading - Boolean
company_name - String
legal_status - String
auditor - String
latest_action - Latest_Action
company_type - String
history - [History]
ccjs - [CCJ]
possible_ccjs - [CCJ]
processed_at - DateTime
last_updated - DateTime
parent_company - String
group_id - String
telephone_number - String
email - String
has_contact - Boolean
has_phone_contact - Boolean
has_email_contact - Boolean
generated_rfa_rating - RfaRating
previous_rfa_rating - RfaRating
rating_changed_date - DateTime
previous_rating_changed_date - DateTime
current_directors - [Current_Directors]
profit_loss - [Profit_Loss]
balance_sheet - [Balance_Sheet]
creditors - [Creditor]
debtors - [Debtor]
detrimental_data - [DetrimentalData]
shareholders - [Shareholder]
poscs - [POSC]
former_names - [FormerName]
cashflow - [CashFlow]
ratio_analysis - [RatioAnalysis]
contacts - [Contact]
functional_currency - CurrencyCode
vat_number - String
beneficial_owners - [BeneficialOwner]
Example
{
  "id": 987,
  "company_id": "xyz789",
  "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": "abc123",
  "mortgages": [Mortgage],
  "country_code": "AFG",
  "archive": [CompanyArchive],
  "estimated_turnover": Decimal,
  "estimated_employees": 123,
  "employees": {},
  "turnover": Decimal,
  "growth_score": 987.65,
  "rfa_rating_score": 987.65,
  "raw_rating_score": 123.45,
  "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": ["abc123"],
  "sic92_codes": ["abc123"],
  "sic92_descriptions": ["abc123"],
  "primary_sic92_code": "xyz789",
  "sic07": [SIC07],
  "sic07_codes": ["abc123"],
  "sic07_descriptions": ["xyz789"],
  "sic07_sections": ["xyz789"],
  "sic07_section_descriptions": ["xyz789"],
  "sic07_divisions": ["abc123"],
  "sic07_division_descriptions": ["xyz789"],
  "sic07_groups": ["abc123"],
  "sic07_group_descriptions": ["abc123"],
  "sic07_classes": ["abc123"],
  "sic07_class_descriptions": ["xyz789"],
  "sic07_sub_classes": ["xyz789"],
  "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": "abc123",
  "auditor": "xyz789",
  "latest_action": Latest_Action,
  "company_type": "xyz789",
  "history": [History],
  "ccjs": [CCJ],
  "possible_ccjs": [CCJ],
  "processed_at": "2007-12-03T10:15:30Z",
  "last_updated": "2007-12-03T10:15:30Z",
  "parent_company": "abc123",
  "group_id": "abc123",
  "telephone_number": "xyz789",
  "email": "abc123",
  "has_contact": false,
  "has_phone_contact": false,
  "has_email_contact": true,
  "generated_rfa_rating": "THREE_RED_FLAGS",
  "previous_rfa_rating": "THREE_RED_FLAGS",
  "rating_changed_date": "2007-12-03T10:15:30Z",
  "previous_rating_changed_date": "2007-12-03T10:15:30Z",
  "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]
}
Types

CompanySearchFilterInput

Fields
Input Field Description
and - [CompanySearchFilterInput!]
or - [CompanySearchFilterInput!]
country_code - NullableOfCountryCodeOperationFilterInput
archive_id - StringOperationFilterInput
archive - ListFilterInputTypeOfCompanyArchiveFilterInput
report_source - SourceKeyOperationFilterInput
id - IntOperationFilterInput
relevance - FloatOperationFilterInput
company_id - StringOperationFilterInput
estimated_turnover - DecimalOperationFilterInput
estimated_employees - IntOperationFilterInput
employees - LongOperationFilterInput
turnover - DecimalOperationFilterInput
growth_score - FloatOperationFilterInput
rfa_rating_summary - StringOperationFilterInput
rfa_rating_score - FloatOperationFilterInput
raw_rating_score - FloatOperationFilterInput
company_number - StringOperationFilterInput
incorporation_date - DateTimeOperationFilterInput
dissolution_date - DateTimeOperationFilterInput
dissolution_status - StringOperationFilterInput
total_assets - LongOperationFilterInput
last_filed_accounts - DateTimeOperationFilterInput
accounts_next_due - DateTimeOperationFilterInput
tps_registered - BooleanOperationFilterInput
gdpr_registered - BooleanOperationFilterInput
marketing_preference - StringOperationFilterInput
website - StringOperationFilterInput
primary_sic07_code - StringOperationFilterInput
revenue_increase - LongOperationFilterInput
creditor_days - LongOperationFilterInput
credit_score - DecimalOperationFilterInput
credit_limit - DecimalOperationFilterInput
sic92_sections - ListStringOperationFilterInput
sic92_codes - ListStringOperationFilterInput
sic92_descriptions - ListStringOperationFilterInput
primary_sic92_code - StringOperationFilterInput
sic07 - ListFilterInputTypeOfSIC07FilterInput
sic07_codes - ListStringOperationFilterInput
sic07_descriptions - ListStringOperationFilterInput
sic07_sections - ListStringOperationFilterInput
sic07_section_descriptions - ListStringOperationFilterInput
sic07_divisions - ListStringOperationFilterInput
sic07_division_descriptions - ListStringOperationFilterInput
sic07_groups - ListStringOperationFilterInput
sic07_group_descriptions - ListStringOperationFilterInput
sic07_classes - ListStringOperationFilterInput
sic07_class_descriptions - ListStringOperationFilterInput
sic07_sub_classes - ListStringOperationFilterInput
sic07_sub_class_descriptions - ListStringOperationFilterInput
people - ListFilterInputTypeOfPersonFilterInput
active_directors - ListFilterInputTypeOfDirectorFilterInput
directors - ListFilterInputTypeOfDirectorPartialFilterInput
director_summary - DirectorSummaryFilterInput
credit_limits - ListFilterInputTypeOfCreditLimitFilterInput
oldest_director - DirectorFilterInput
has_directorships - BooleanOperationFilterInput
has_financials - BooleanOperationFilterInput
is_limited - BooleanOperationFilterInput
is_trading - BooleanOperationFilterInput
addresses - ListFilterInputTypeOfAddressFilterInput
company_name - StringOperationFilterInput
legal_status - StringOperationFilterInput
auditor - StringOperationFilterInput
duns_number - StringOperationFilterInput
latest_action - Latest_ActionFilterInput
company_type - StringOperationFilterInput
mortgages - ListFilterInputTypeOfMortgageFilterInput
history - ListFilterInputTypeOfHistoryFilterInput
gazette_notices - ListFilterInputTypeOfGazetteNoticeFilterInput
ccjs - ListFilterInputTypeOfCCJFilterInput
possible_ccjs - ListFilterInputTypeOfCCJFilterInput
processed_at - DateTimeOperationFilterInput
last_updated - DateTimeOperationFilterInput
parent_company - StringOperationFilterInput
group_id - StringOperationFilterInput
telephone_number - StringOperationFilterInput
email - StringOperationFilterInput
has_contact - BooleanOperationFilterInput
has_phone_contact - BooleanOperationFilterInput
has_email_contact - BooleanOperationFilterInput
rfa_rating - NullableOfCompanyRatingOperationFilterInput
generated_rfa_rating - NullableOfRfaRatingOperationFilterInput
previous_rfa_rating - NullableOfRfaRatingOperationFilterInput
rating_changed_date - DateTimeOperationFilterInput
previous_rating_changed_date - DateTimeOperationFilterInput
ordered_rfa_rating - NullableOfOrderedCompanyRatingOperationFilterInput
current_directors - ListFilterInputTypeOfCurrent_DirectorsFilterInput
profit_loss - ListFilterInputTypeOfProfit_LossFilterInput
balance_sheet - ListFilterInputTypeOfBalance_SheetFilterInput
corporate_structure - ListFilterInputTypeOfCorporateEntityFilterInput
creditors - ListFilterInputTypeOfCreditorFilterInput
debtors - ListFilterInputTypeOfDebtorFilterInput
detrimental_data - ListFilterInputTypeOfDetrimentalDataFilterInput
shareholders - ListFilterInputTypeOfShareholderFilterInput
poscs - ListFilterInputTypeOfPOSCFilterInput
former_names - ListFilterInputTypeOfFormerNameFilterInput
cashflow - ListFilterInputTypeOfCashFlowFilterInput
ratio_analysis - ListFilterInputTypeOfRatioAnalysisFilterInput
contacts - ListFilterInputTypeOfContactFilterInput
functional_currency - NullableOfCurrencyCodeOperationFilterInput
vat_number - StringOperationFilterInput
beneficial_owner_graph - BeneficialOwnerGraphFilterInput
beneficial_owners - ListFilterInputTypeOfBeneficialOwnerFilterInput
rfa_rating_rank - IntOperationFilterInput
Example
{
  "and": [CompanySearchFilterInput],
  "or": [CompanySearchFilterInput],
  "country_code": NullableOfCountryCodeOperationFilterInput,
  "archive_id": StringOperationFilterInput,
  "archive": ListFilterInputTypeOfCompanyArchiveFilterInput,
  "report_source": SourceKeyOperationFilterInput,
  "id": IntOperationFilterInput,
  "relevance": FloatOperationFilterInput,
  "company_id": StringOperationFilterInput,
  "estimated_turnover": DecimalOperationFilterInput,
  "estimated_employees": IntOperationFilterInput,
  "employees": LongOperationFilterInput,
  "turnover": DecimalOperationFilterInput,
  "growth_score": FloatOperationFilterInput,
  "rfa_rating_summary": StringOperationFilterInput,
  "rfa_rating_score": FloatOperationFilterInput,
  "raw_rating_score": FloatOperationFilterInput,
  "company_number": StringOperationFilterInput,
  "incorporation_date": DateTimeOperationFilterInput,
  "dissolution_date": DateTimeOperationFilterInput,
  "dissolution_status": StringOperationFilterInput,
  "total_assets": LongOperationFilterInput,
  "last_filed_accounts": DateTimeOperationFilterInput,
  "accounts_next_due": DateTimeOperationFilterInput,
  "tps_registered": BooleanOperationFilterInput,
  "gdpr_registered": BooleanOperationFilterInput,
  "marketing_preference": StringOperationFilterInput,
  "website": StringOperationFilterInput,
  "primary_sic07_code": StringOperationFilterInput,
  "revenue_increase": LongOperationFilterInput,
  "creditor_days": LongOperationFilterInput,
  "credit_score": DecimalOperationFilterInput,
  "credit_limit": DecimalOperationFilterInput,
  "sic92_sections": ListStringOperationFilterInput,
  "sic92_codes": ListStringOperationFilterInput,
  "sic92_descriptions": ListStringOperationFilterInput,
  "primary_sic92_code": StringOperationFilterInput,
  "sic07": ListFilterInputTypeOfSIC07FilterInput,
  "sic07_codes": ListStringOperationFilterInput,
  "sic07_descriptions": ListStringOperationFilterInput,
  "sic07_sections": ListStringOperationFilterInput,
  "sic07_section_descriptions": ListStringOperationFilterInput,
  "sic07_divisions": ListStringOperationFilterInput,
  "sic07_division_descriptions": ListStringOperationFilterInput,
  "sic07_groups": ListStringOperationFilterInput,
  "sic07_group_descriptions": ListStringOperationFilterInput,
  "sic07_classes": ListStringOperationFilterInput,
  "sic07_class_descriptions": ListStringOperationFilterInput,
  "sic07_sub_classes": ListStringOperationFilterInput,
  "sic07_sub_class_descriptions": ListStringOperationFilterInput,
  "people": ListFilterInputTypeOfPersonFilterInput,
  "active_directors": ListFilterInputTypeOfDirectorFilterInput,
  "directors": ListFilterInputTypeOfDirectorPartialFilterInput,
  "director_summary": DirectorSummaryFilterInput,
  "credit_limits": ListFilterInputTypeOfCreditLimitFilterInput,
  "oldest_director": DirectorFilterInput,
  "has_directorships": BooleanOperationFilterInput,
  "has_financials": BooleanOperationFilterInput,
  "is_limited": BooleanOperationFilterInput,
  "is_trading": BooleanOperationFilterInput,
  "addresses": ListFilterInputTypeOfAddressFilterInput,
  "company_name": StringOperationFilterInput,
  "legal_status": StringOperationFilterInput,
  "auditor": StringOperationFilterInput,
  "duns_number": StringOperationFilterInput,
  "latest_action": Latest_ActionFilterInput,
  "company_type": StringOperationFilterInput,
  "mortgages": ListFilterInputTypeOfMortgageFilterInput,
  "history": ListFilterInputTypeOfHistoryFilterInput,
  "gazette_notices": ListFilterInputTypeOfGazetteNoticeFilterInput,
  "ccjs": ListFilterInputTypeOfCCJFilterInput,
  "possible_ccjs": ListFilterInputTypeOfCCJFilterInput,
  "processed_at": DateTimeOperationFilterInput,
  "last_updated": DateTimeOperationFilterInput,
  "parent_company": StringOperationFilterInput,
  "group_id": StringOperationFilterInput,
  "telephone_number": StringOperationFilterInput,
  "email": StringOperationFilterInput,
  "has_contact": BooleanOperationFilterInput,
  "has_phone_contact": BooleanOperationFilterInput,
  "has_email_contact": BooleanOperationFilterInput,
  "rfa_rating": NullableOfCompanyRatingOperationFilterInput,
  "generated_rfa_rating": NullableOfRfaRatingOperationFilterInput,
  "previous_rfa_rating": NullableOfRfaRatingOperationFilterInput,
  "rating_changed_date": DateTimeOperationFilterInput,
  "previous_rating_changed_date": DateTimeOperationFilterInput,
  "ordered_rfa_rating": NullableOfOrderedCompanyRatingOperationFilterInput,
  "current_directors": ListFilterInputTypeOfCurrent_DirectorsFilterInput,
  "profit_loss": ListFilterInputTypeOfProfit_LossFilterInput,
  "balance_sheet": ListFilterInputTypeOfBalance_SheetFilterInput,
  "corporate_structure": ListFilterInputTypeOfCorporateEntityFilterInput,
  "creditors": ListFilterInputTypeOfCreditorFilterInput,
  "debtors": ListFilterInputTypeOfDebtorFilterInput,
  "detrimental_data": ListFilterInputTypeOfDetrimentalDataFilterInput,
  "shareholders": ListFilterInputTypeOfShareholderFilterInput,
  "poscs": ListFilterInputTypeOfPOSCFilterInput,
  "former_names": ListFilterInputTypeOfFormerNameFilterInput,
  "cashflow": ListFilterInputTypeOfCashFlowFilterInput,
  "ratio_analysis": ListFilterInputTypeOfRatioAnalysisFilterInput,
  "contacts": ListFilterInputTypeOfContactFilterInput,
  "functional_currency": NullableOfCurrencyCodeOperationFilterInput,
  "vat_number": StringOperationFilterInput,
  "beneficial_owner_graph": BeneficialOwnerGraphFilterInput,
  "beneficial_owners": ListFilterInputTypeOfBeneficialOwnerFilterInput,
  "rfa_rating_rank": IntOperationFilterInput
}
Types

CompanySearchSortInput

Fields
Input Field Description
id - SortEnumType
relevance - SortEnumType
country_code - SortEnumType
archive_id - SortEnumType
report_source - SortEnumType
company_id - SortEnumType
estimated_turnover - SortEnumType
estimated_employees - SortEnumType
employees - SortEnumType
turnover - SortEnumType
growth_score - SortEnumType
rfa_rating_summary - SortEnumType
rfa_rating_score - SortEnumType
raw_rating_score - SortEnumType
company_number - SortEnumType
incorporation_date - SortEnumType
dissolution_date - SortEnumType
dissolution_status - SortEnumType
total_assets - SortEnumType
last_filed_accounts - SortEnumType
accounts_next_due - SortEnumType
tps_registered - SortEnumType
gdpr_registered - SortEnumType
marketing_preference - SortEnumType
website - SortEnumType
primary_sic07_code - SortEnumType
revenue_increase - SortEnumType
creditor_days - SortEnumType
credit_score - SortEnumType
credit_limit - SortEnumType
primary_sic92_code - SortEnumType
director_summary - DirectorSummarySortInput
oldest_director - DirectorSortInput
has_directorships - SortEnumType
has_financials - SortEnumType
is_limited - SortEnumType
is_trading - SortEnumType
company_name - SortEnumType
legal_status - SortEnumType
auditor - SortEnumType
duns_number - SortEnumType
latest_action - Latest_ActionSortInput
company_type - SortEnumType
processed_at - SortEnumType
last_updated - SortEnumType
parent_company - SortEnumType
group_id - SortEnumType
telephone_number - SortEnumType
email - SortEnumType
has_contact - SortEnumType
has_phone_contact - SortEnumType
has_email_contact - SortEnumType
rfa_rating - SortEnumType
generated_rfa_rating - SortEnumType
previous_rfa_rating - SortEnumType
rating_changed_date - SortEnumType
previous_rating_changed_date - SortEnumType
ordered_rfa_rating - SortEnumType
functional_currency - SortEnumType
vat_number - SortEnumType
beneficial_owner_graph - BeneficialOwnerGraphSortInput
rfa_rating_rank - SortEnumType
Example
{
  "id": "ASC",
  "relevance": "ASC",
  "country_code": "ASC",
  "archive_id": "ASC",
  "report_source": "ASC",
  "company_id": "ASC",
  "estimated_turnover": "ASC",
  "estimated_employees": "ASC",
  "employees": "ASC",
  "turnover": "ASC",
  "growth_score": "ASC",
  "rfa_rating_summary": "ASC",
  "rfa_rating_score": "ASC",
  "raw_rating_score": "ASC",
  "company_number": "ASC",
  "incorporation_date": "ASC",
  "dissolution_date": "ASC",
  "dissolution_status": "ASC",
  "total_assets": "ASC",
  "last_filed_accounts": "ASC",
  "accounts_next_due": "ASC",
  "tps_registered": "ASC",
  "gdpr_registered": "ASC",
  "marketing_preference": "ASC",
  "website": "ASC",
  "primary_sic07_code": "ASC",
  "revenue_increase": "ASC",
  "creditor_days": "ASC",
  "credit_score": "ASC",
  "credit_limit": "ASC",
  "primary_sic92_code": "ASC",
  "director_summary": DirectorSummarySortInput,
  "oldest_director": DirectorSortInput,
  "has_directorships": "ASC",
  "has_financials": "ASC",
  "is_limited": "ASC",
  "is_trading": "ASC",
  "company_name": "ASC",
  "legal_status": "ASC",
  "auditor": "ASC",
  "duns_number": "ASC",
  "latest_action": Latest_ActionSortInput,
  "company_type": "ASC",
  "processed_at": "ASC",
  "last_updated": "ASC",
  "parent_company": "ASC",
  "group_id": "ASC",
  "telephone_number": "ASC",
  "email": "ASC",
  "has_contact": "ASC",
  "has_phone_contact": "ASC",
  "has_email_contact": "ASC",
  "rfa_rating": "ASC",
  "generated_rfa_rating": "ASC",
  "previous_rfa_rating": "ASC",
  "rating_changed_date": "ASC",
  "previous_rating_changed_date": "ASC",
  "ordered_rfa_rating": "ASC",
  "functional_currency": "ASC",
  "vat_number": "ASC",
  "beneficial_owner_graph": BeneficialOwnerGraphSortInput,
  "rfa_rating_rank": "ASC"
}
Types

CompanyStatus

Fields
Field Name Description
legalStatus - String
isDissolved - Boolean!
dissolutionDate - DateTime
riskAssessment - String
legal - Legal
detrimentalData - [DetrimentalData]
Example
{
  "legalStatus": "abc123",
  "isDissolved": false,
  "dissolutionDate": "2007-12-03T10:15:30Z",
  "riskAssessment": "xyz789",
  "legal": Legal,
  "detrimentalData": [DetrimentalData]
}
Types

ComplyAdvantageSearchFilterInput

Fields
Input Field Description
and - [ComplyAdvantageSearchFilterInput!]
or - [ComplyAdvantageSearchFilterInput!]
checkId - IntOperationFilterInput
searchId - LongOperationFilterInput
isMonitored - BooleanOperationFilterInput
check - CheckFilterInput
Example
{
  "and": [ComplyAdvantageSearchFilterInput],
  "or": [ComplyAdvantageSearchFilterInput],
  "checkId": IntOperationFilterInput,
  "searchId": LongOperationFilterInput,
  "isMonitored": BooleanOperationFilterInput,
  "check": CheckFilterInput
}
Types

ComplyAdvantageSearchSortInput

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

ConsumerCreditReport

Fields
Field Name Description
userInput - ConsumerCreditRequest! Parameters that were input to conduct this credit check
requestedBy - RequestedBy!
clientRef - String! The enquiry reference identifier that was used to perform this credit check
reportRunDate - DateTime!
applicantConfirmation - ApplicantConfirmation Subject details successfully confirmed
matchedAddressData - [AddressRelatedData!]! Matched address and related data for the supplied address
linkedAddressData - [LinkedAddressRelatedData!]! Address details and related data for any linked addresses found
aliases - [PersonalDetails!]!
scores - [ScoreData!]!
associates - [PersonalDetails!]!
potentialAssociates - [PersonalDetails!]!
associateLender - [AssociateLender!]!
potentialAssociateLender - [AssociateLender!]!
riskOverview - [RiskOverviewItem!]!
Example
{
  "userInput": ConsumerCreditRequest,
  "requestedBy": RequestedBy,
  "clientRef": "abc123",
  "reportRunDate": "2007-12-03T10:15:30Z",
  "applicantConfirmation": ApplicantConfirmation,
  "matchedAddressData": [AddressRelatedData],
  "linkedAddressData": [LinkedAddressRelatedData],
  "aliases": [PersonalDetails],
  "scores": [ScoreData],
  "associates": [PersonalDetails],
  "potentialAssociates": [PersonalDetails],
  "associateLender": [AssociateLender],
  "potentialAssociateLender": [AssociateLender],
  "riskOverview": [RiskOverviewItem]
}
Types

ConsumerCreditRequest

Fields
Field Name Description
searchType - SearchType!
person - PersonalDetails!
currentAddress - SubjectAddress!
Example
{
  "searchType": "DIRECTOR",
  "person": PersonalDetails,
  "currentAddress": SubjectAddress
}
Types

ConsumerCreditRequestInput

Fields
Input Field Description
searchType - SearchType
person - PersonalDetailsInput
currentAddress - SubjectAddressInput
Example
{
  "searchType": "DIRECTOR",
  "person": PersonalDetailsInput,
  "currentAddress": SubjectAddressInput
}
Types

Contact

Fields
Field Name Description
email_address - String
telephone_number - String
Example
{
  "email_address": "xyz789",
  "telephone_number": "xyz789"
}
Types

ContactFilterInput

Fields
Input Field Description
and - [ContactFilterInput!]
or - [ContactFilterInput!]
email_address - StringOperationFilterInput
telephone_number - StringOperationFilterInput
Example
{
  "and": [ContactFilterInput],
  "or": [ContactFilterInput],
  "email_address": StringOperationFilterInput,
  "telephone_number": StringOperationFilterInput
}
Types

CopyPortfolioInput

Fields
Input Field Description
companyIds - [Int]
fromPortfolioId - Int!
toPortfolioId - Int!
removeAfterCopy - Boolean!
Example
{
  "companyIds": [123],
  "fromPortfolioId": 987,
  "toPortfolioId": 123,
  "removeAfterCopy": true
}
Types

CorporateEntity

Fields
Field Name Description
id - String
company_id - Long!
company_number - String
company_name - String
level - Int
parent - String
ultimate_parent - String
country - String
company - CompanySearch
Example
{
  "id": "abc123",
  "company_id": {},
  "company_number": "xyz789",
  "company_name": "abc123",
  "level": 987,
  "parent": "xyz789",
  "ultimate_parent": "abc123",
  "country": "abc123",
  "company": CompanySearch
}
Types

CorporateEntityFilterInput

Fields
Input Field Description
and - [CorporateEntityFilterInput!]
or - [CorporateEntityFilterInput!]
id - StringOperationFilterInput
company_id - LongOperationFilterInput
company_number - StringOperationFilterInput
company_name - StringOperationFilterInput
level - IntOperationFilterInput
parent - StringOperationFilterInput
ultimate_parent - StringOperationFilterInput
country - StringOperationFilterInput
Example
{
  "and": [CorporateEntityFilterInput],
  "or": [CorporateEntityFilterInput],
  "id": StringOperationFilterInput,
  "company_id": LongOperationFilterInput,
  "company_number": StringOperationFilterInput,
  "company_name": StringOperationFilterInput,
  "level": IntOperationFilterInput,
  "parent": StringOperationFilterInput,
  "ultimate_parent": StringOperationFilterInput,
  "country": StringOperationFilterInput
}
Types

CountryCode

Description

Country codes.

Values
Enum Value Description

AFG

ALB

DZA

ASM

AND

AGO

AIA

ATA

ATG

ARG

ARM

ABW

AUS

AUT

AZE

BHS

BHR

BGD

BRB

BLR

BEL

BLZ

BEN

BMU

BTN

BOL

BIH

BWA

BVT

BRA

IOT

BRN

BGR

BFA

BDI

CPV

KHM

CMR

CAN

CYM

CAF

TCD

CHL

CHN

CXR

CCK

COL

COM

COG

COD

COK

CRI

CIV

HRV

CUB

CYP

CZE

DNK

DJI

DMA

DOM

ECU

EGY

SLV

GNQ

ERI

EST

SWZ

ETH

FLK

FRO

FJI

FIN

FRA

GUF

PYF

ATF

GAB

GMB

GEO

DEU

GHA

GIB

GRC

GRL

GRD

GLP

GUM

GTM

GGY

GIN

GNB

GUY

HTI

HMD

VAT

HND

HKG

HUN

ISL

IND

IDN

IRN

IRQ

IRL

IMN

ISR

ITA

JAM

JPN

JEY

JOR

KAZ

KEN

KIR

PRK

KOR

KWT

KGZ

LAO

LVA

LBN

LSO

LBR

LBY

LIE

LTU

LUX

MAC

MDG

MWI

MYS

MDV

MLI

MLT

MHL

MTQ

MRT

MUS

MYT

MEX

FSM

MDA

MCO

MNG

MNE

MSR

MAR

MOZ

MMR

NAM

NRU

NPL

NLD

NCL

NZL

NIC

NER

NGA

NIU

NFK

MNP

MKD

NOR

OMN

PAK

PLW

PSE

PAN

PNG

PRY

PER

PHL

PCN

POL

PRT

PRI

QAT

REU

ROU

RUS

RWA

BLM

SHN

KNA

LCA

MAF

SPM

VCT

WSM

SMR

STP

SAU

SEN

SRB

SYC

SLE

SGP

SVK

SVN

SLB

SOM

ZAF

SGS

SSD

ESP

LKA

SDN

SUR

SJM

SWE

CHE

SYR

TWN

TJK

TZA

THA

TLS

TGO

TKL

TON

TTO

TUN

TUR

TKM

TCA

TUV

UGA

UKR

ARE

GBR

USA

UMI

URY

UZB

VUT

VEN

VNM

VGB

VIR

WLF

ESH

YEM

ZMB

ZWE

ALA

GBG

GBJ

GBM
Example
"AFG"
Types

CountryCodeOperationFilterInput

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

CourtRecord

Fields
Field Name Description
caseNumber - String!
courtCode - String!
courtName - String!
ccjType - String!
amount - Decimal!
courtDate - DateTime!
satisfiedDate - DateTime
oldCaseNumber - String!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "caseNumber": "abc123",
  "courtCode": "abc123",
  "courtName": "abc123",
  "ccjType": "xyz789",
  "amount": Decimal,
  "courtDate": "2007-12-03T10:15:30Z",
  "satisfiedDate": "2007-12-03T10:15:30Z",
  "oldCaseNumber": "xyz789",
  "person": PersonalDetails,
  "associationType": "abc123",
  "matchesApplicantName": true,
  "matchesApplicantDob": false
}
Types

CreateNoteInput

Description

Note Creator

Fields
Input Field Description
userEmail - String Email of person creating Note
noteText - String Note being created
accountId - String Account of user creating note
checkResultId - Int! Check that the note is attached to
created - DateTime Date and time note is created
Example
{
  "userEmail": "xyz789",
  "noteText": "abc123",
  "accountId": "abc123",
  "checkResultId": 123,
  "created": "2007-12-03T10:15:30Z"
}
Types

CreateOverrideNoteInput

Description

Override Note Creator

Fields
Input Field Description
userEmail - String Email of person creating Note
noteText - String Note being created
accountId - String Account of user creating note
checkResultId - Int! Check that the note is attached to
created - DateTime Date and time note is created
overriddenStatusType - OverriddenStatusType Pass or Fail status override value
Example
{
  "userEmail": "abc123",
  "noteText": "xyz789",
  "accountId": "xyz789",
  "checkResultId": 987,
  "created": "2007-12-03T10:15:30Z",
  "overriddenStatusType": "PASS"
}
Types

CreatePortfolioInput

Fields
Input Field Description
name - String
description - String
portfolioType - PortfolioType!
Example
{
  "name": "abc123",
  "description": "xyz789",
  "portfolioType": "NONE"
}
Types

CreditLimit

Fields
Field Name Description
companyId - Int!
credit_limit - Decimal!
currency - String
published_date - DateTime
Example
{
  "companyId": 987,
  "credit_limit": Decimal,
  "currency": "abc123",
  "published_date": "2007-12-03T10:15:30Z"
}
Types

CreditLimitFilterInput

Fields
Input Field Description
and - [CreditLimitFilterInput!]
or - [CreditLimitFilterInput!]
companyId - IntOperationFilterInput
credit_limit - DecimalOperationFilterInput
currency - StringOperationFilterInput
published_date - DateTimeOperationFilterInput
Example
{
  "and": [CreditLimitFilterInput],
  "or": [CreditLimitFilterInput],
  "companyId": IntOperationFilterInput,
  "credit_limit": DecimalOperationFilterInput,
  "currency": StringOperationFilterInput,
  "published_date": DateTimeOperationFilterInput
}
Types

CreditSearchRecord

Fields
Field Name Description
creditSearchType - String!
thirdPartyDataUsed - Boolean!
searchDate - DateTime!
companyName - String
companyType - String!
singleSearchApplicant - Boolean!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "creditSearchType": "xyz789",
  "thirdPartyDataUsed": false,
  "searchDate": "2007-12-03T10:15:30Z",
  "companyName": "xyz789",
  "companyType": "xyz789",
  "singleSearchApplicant": true,
  "person": PersonalDetails,
  "associationType": "xyz789",
  "matchesApplicantName": true,
  "matchesApplicantDob": false
}
Types

Creditor

Fields
Field Name Description
status - String
amount - Decimal
address - String
company_name - String
company_number - String
statement_date - DateTime
insolvency_practitioners - [String]
upload_date - DateTime
company_id - Int
Example
{
  "status": "abc123",
  "amount": Decimal,
  "address": "abc123",
  "company_name": "abc123",
  "company_number": "abc123",
  "statement_date": "2007-12-03T10:15:30Z",
  "insolvency_practitioners": ["xyz789"],
  "upload_date": "2007-12-03T10:15:30Z",
  "company_id": 123
}
Types

CreditorFilterInput

Fields
Input Field Description
and - [CreditorFilterInput!]
or - [CreditorFilterInput!]
status - StringOperationFilterInput
amount - DecimalOperationFilterInput
address - StringOperationFilterInput
company_name - StringOperationFilterInput
company_number - StringOperationFilterInput
statement_date - DateTimeOperationFilterInput
insolvency_practitioners - ListStringOperationFilterInput
upload_date - DateTimeOperationFilterInput
company_id - IntOperationFilterInput
Example
{
  "and": [CreditorFilterInput],
  "or": [CreditorFilterInput],
  "status": StringOperationFilterInput,
  "amount": DecimalOperationFilterInput,
  "address": StringOperationFilterInput,
  "company_name": StringOperationFilterInput,
  "company_number": StringOperationFilterInput,
  "statement_date": DateTimeOperationFilterInput,
  "insolvency_practitioners": ListStringOperationFilterInput,
  "upload_date": DateTimeOperationFilterInput,
  "company_id": IntOperationFilterInput
}
Types

CurrencyAmount

Fields
Field Name Description
value - Long
currency - CurrencyCode
Example
{"value": {}, "currency": "AED"}
Types

CurrencyCode

Values
Enum Value Description

AED

AFN

ALL

AMD

ANG

AOA

ARS

AUD

AWG

AZN

BAM

BBD

BDT

BGN

BHD

BIF

BMD

BND

BOB

BOV

BRL

BSD

BTN

BWP

BYN

BZD

CAD

CDF

CHE

CHF

CHW

CLF

CLP

COP

COU

CRC

CUC

CUP

CVE

CZK

DJF

DKK

DOP

DZD

EGP

ERN

ETB

EUR

FJD

FKP

GBP

GEL

GHS

GIP

GMD

GNF

GTQ

GYD

HKD

HNL

HTG

HUF

IDR

ILS

INR

IQD

IRR

ISK

JMD

JOD

JPY

KES

KGS

KHR

KMF

KPW

KRW

KWD

KYD

KZT

LAK

LBP

LKR

LRD

LSL

LYD

MAD

MDL

MGA

MKD

MMK

MNT

MOP

MRU

MUR

MVR

MWK

MXN

MXV

MYR

MZN

NAD

NGN

NIO

NOK

NPR

NZD

OMR

PAB

PEN

PGK

PHP

PKR

PLN

PYG

QAR

RON

RSD

CNY

RUB

RWF

SAR

SBD

SCR

SDG

SEK

SGD

SHP

SLE

SLL

SOS

SRD

SSP

STN

SVC

SYP

SZL

THB

TJS

TMT

TND

TOP

TRY

TTD

TWD

TZS

UAH

UGX

USD

USN

UYI

UYU

UYW

UZS

VED

VES

VND

VUV

WST

XAF

XAG

XAU

XBA

XBB

XBC

XBD

XCD

XDR

XOF

XPD

XPF

XPT

XSU

XTS

XUA

XXX

YER

ZAR

ZMW

ZWL

ADP

AFA

ALK

AOK

AON

AOR

ARA

ARP

ARY

ATS

AYM

AZM

BAD

BEC

BEF

BEL

BGJ

BGK

BGL

BOP

BRB

BRC

BRE

BRN

BRR

BUK

BYB

BYR

CHC

CSD

CSJ

CSK

CYP

DDM

DEM

ECS

ECV

EEK

ESA

ESB

ESP

FIM

FRF

GEK

GHC

GHP

GNE

GNS

GQE

GRD

GWE

GWP

HRD

HRK

IEP

ILP

ILR

ISJ

ITL

LAJ

LSM

LTL

LTT

LUC

LUF

LUL

LVL

LVR

MGF

MLF

MRO

MTL

MTP

MVQ

MXP

MZE

MZM

NIC

NLG

PEH

PEI

PES

PLZ

PTE

RHD

ROK

ROL

RUR

SDD

SDP

SIT

SKK

SRG

STD

SUR

TJR

TMM

TPE

TRL

UAK

UGS

UGW

USS

UYN

UYP

VEB

VEF

VNC

XEU

XFO

XFU

XRE

YDD

YUD

YUM

YUN

ZAL

ZMK

ZRN

ZRZ

ZWC

ZWD

ZWN

ZWR
Example
"AED"
Types

Current_Directors

Fields
Field Name Description
birthdate - DateTime
Example
{"birthdate": "2007-12-03T10:15:30Z"}
Types

Current_DirectorsFilterInput

Fields
Input Field Description
and - [Current_DirectorsFilterInput!]
or - [Current_DirectorsFilterInput!]
birthdate - DateTimeOperationFilterInput
Example
{
  "and": [Current_DirectorsFilterInput],
  "or": [Current_DirectorsFilterInput],
  "birthdate": DateTimeOperationFilterInput
}
Types

CustomScheduledExportRequestInput

Description

Custom Scheuled Export Request Type

Fields
Input Field Description
apiQuery - String Api Query
variables - String Api Query Variables
resultSelection - String Result Selection
columnMappings - String Column Mappings
totalResults - Int! Total Results
queryName - String Query Name
fieldType - String Field Type
repeatIntervalInDays - Int! Repeat Interval In Days
exportType - FileExportRequestType! Type of export requested (pdf / csv). Default = CSV
columnSelection - String Column Selection
exportTitle - String Export Title
exportDescription - String Export Description
accountId - String User Account Id
csvExportLimit - Int User Csv Export Limit
userEmail - String User Email Address
Example
{
  "apiQuery": "xyz789",
  "variables": "abc123",
  "resultSelection": "abc123",
  "columnMappings": "abc123",
  "totalResults": 987,
  "queryName": "xyz789",
  "fieldType": "abc123",
  "repeatIntervalInDays": 987,
  "exportType": "CSV",
  "columnSelection": "abc123",
  "exportTitle": "abc123",
  "exportDescription": "abc123",
  "accountId": "abc123",
  "csvExportLimit": 123,
  "userEmail": "abc123"
}
Types

CustomerAccount

Description

Customer Account

Fields
Field Name Description
id - String
name - String
version - Int!
companyReportRegionViews - [CompanyReportRegionView]
Example
{
  "id": "abc123",
  "name": "xyz789",
  "version": 123,
  "companyReportRegionViews": [CompanyReportRegionView]
}
Types

Date

Description

The Date scalar represents an ISO-8601 compliant date type.

Example
"2007-12-03"
Types

DateTime

Description

The DateTime scalar represents an ISO-8601 compliant date time type.

Example
"2007-12-03T10:15:30Z"
Types

DateTimeAfterInput

Fields
Input Field Description
daysAgo - Int!
monthsAgo - Int!
Example
{"daysAgo": 123, "monthsAgo": 123}
Types

DateTimeBeforeInput

Fields
Input Field Description
daysBefore - Int!
monthsBefore - Int!
Example
{"daysBefore": 987, "monthsBefore": 987}
Types

DateTimeOperationFilterInput

Fields
Input Field Description
after - DateTimeAfterInput
before - DateTimeBeforeInput
eq - DateTime
neq - DateTime
in - [DateTime]
nin - [DateTime]
gt - DateTime
ngt - DateTime
gte - DateTime
ngte - DateTime
lt - DateTime
nlt - DateTime
lte - DateTime
nlte - DateTime
Example
{
  "after": DateTimeAfterInput,
  "before": DateTimeBeforeInput,
  "eq": "2007-12-03T10:15:30Z",
  "neq": "2007-12-03T10:15:30Z",
  "in": ["2007-12-03T10:15:30Z"],
  "nin": ["2007-12-03T10:15:30Z"],
  "gt": "2007-12-03T10:15:30Z",
  "ngt": "2007-12-03T10:15:30Z",
  "gte": "2007-12-03T10:15:30Z",
  "ngte": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z",
  "nlt": "2007-12-03T10:15:30Z",
  "lte": "2007-12-03T10:15:30Z",
  "nlte": "2007-12-03T10:15:30Z"
}
Types

Debtor

Fields
Field Name Description
status - String
amount - Decimal
address - String
company_name - String
company_number - String
statement_date - DateTime
insolvency_practitioners - [String]
upload_date - DateTime
company_id - Int
Example
{
  "status": "abc123",
  "amount": Decimal,
  "address": "xyz789",
  "company_name": "xyz789",
  "company_number": "xyz789",
  "statement_date": "2007-12-03T10:15:30Z",
  "insolvency_practitioners": ["xyz789"],
  "upload_date": "2007-12-03T10:15:30Z",
  "company_id": 123
}
Types

DebtorFilterInput

Fields
Input Field Description
and - [DebtorFilterInput!]
or - [DebtorFilterInput!]
status - StringOperationFilterInput
amount - DecimalOperationFilterInput
address - StringOperationFilterInput
company_name - StringOperationFilterInput
company_number - StringOperationFilterInput
statement_date - DateTimeOperationFilterInput
insolvency_practitioners - ListStringOperationFilterInput
upload_date - DateTimeOperationFilterInput
company_id - IntOperationFilterInput
Example
{
  "and": [DebtorFilterInput],
  "or": [DebtorFilterInput],
  "status": StringOperationFilterInput,
  "amount": DecimalOperationFilterInput,
  "address": StringOperationFilterInput,
  "company_name": StringOperationFilterInput,
  "company_number": StringOperationFilterInput,
  "statement_date": DateTimeOperationFilterInput,
  "insolvency_practitioners": ListStringOperationFilterInput,
  "upload_date": DateTimeOperationFilterInput,
  "company_id": IntOperationFilterInput
}
Types

Decimal

Description

The built-in Decimal scalar type.

Example
Decimal
Types

DecimalOperationFilterInput

Fields
Input Field Description
eq - Decimal
neq - Decimal
in - [Decimal]
nin - [Decimal]
gt - Decimal
ngt - Decimal
gte - Decimal
ngte - Decimal
lt - Decimal
nlt - Decimal
lte - Decimal
nlte - Decimal
Example
{
  "eq": Decimal,
  "neq": Decimal,
  "in": [Decimal],
  "nin": [Decimal],
  "gt": Decimal,
  "ngt": Decimal,
  "gte": Decimal,
  "ngte": Decimal,
  "lt": Decimal,
  "nlt": Decimal,
  "lte": Decimal,
  "nlte": Decimal
}
Types

DeletePortfolioInput

Fields
Input Field Description
id - Int!
Example
{"id": 987}
Types

DescriptionValues

Fields
Field Name Description
made_up_date - DateTime
officer_name - String
termination_date - DateTime
description - String
appointment_date - DateTime
charge_creation_date - DateTime
charge_number - String
brought_down_date - DateTime
old_address - String
change_date - DateTime
new_address - String
Example
{
  "made_up_date": "2007-12-03T10:15:30Z",
  "officer_name": "xyz789",
  "termination_date": "2007-12-03T10:15:30Z",
  "description": "xyz789",
  "appointment_date": "2007-12-03T10:15:30Z",
  "charge_creation_date": "2007-12-03T10:15:30Z",
  "charge_number": "abc123",
  "brought_down_date": "2007-12-03T10:15:30Z",
  "old_address": "xyz789",
  "change_date": "2007-12-03T10:15:30Z",
  "new_address": "xyz789"
}
Types

Details

Description

Check metadata.

Fields
Field Name Description
authenticationLink - AuthenticationLink Authentication link.
bulkReference - String Reference to link multiple checks created in bulk together.
checkStartUrl - String Identification Check Start Link
checkId - Int! Check Id
checkResultId - Int! Check result Id
checkType - UkCheckTypeDetail Type of check performed.
createdDate - DateTime! Date check was created.
isBulk - Boolean! Is bulk.
isMonitored - Boolean! Will monitored any PSAM searches performed as part of this check.
reference - String Check author reference for the check.
Example
{
  "authenticationLink": AuthenticationLink,
  "bulkReference": "abc123",
  "checkStartUrl": "xyz789",
  "checkId": 123,
  "checkResultId": 123,
  "checkType": UkCheckTypeDetail,
  "createdDate": "2007-12-03T10:15:30Z",
  "isBulk": false,
  "isMonitored": false,
  "reference": "abc123"
}
Types

DetrimentalData

Fields
Field Name Description
event_date - DateTime
type_short - String
type_long - String
event_text - String
Example
{
  "event_date": "2007-12-03T10:15:30Z",
  "type_short": "xyz789",
  "type_long": "abc123",
  "event_text": "abc123"
}
Types

DetrimentalDataFilterInput

Fields
Input Field Description
and - [DetrimentalDataFilterInput!]
or - [DetrimentalDataFilterInput!]
event_date - DateTimeOperationFilterInput
type_short - StringOperationFilterInput
type_long - StringOperationFilterInput
event_text - StringOperationFilterInput
Example
{
  "and": [DetrimentalDataFilterInput],
  "or": [DetrimentalDataFilterInput],
  "event_date": DateTimeOperationFilterInput,
  "type_short": StringOperationFilterInput,
  "type_long": StringOperationFilterInput,
  "event_text": StringOperationFilterInput
}
Types

DigitalCheckDetail

Description

Detail about user being checked

Fields
Field Name Description
checkId - Int! AML Check Unique ID
id - String Check detail Id
email - String Email of user being checked
firstName - String First name of user being checked
middleName - String Middle name of user being checked
lastName - String Last name of user being checked
dateOfBirth - DateTime Last name of user being checked
mobileNumber - String Mobile number user being checked
countryOfResidence - account_CountryCode! ISO Alpha-3 Country of Residence
identityDocuments - [CheckDetailIdentityDocument] Identity documents provided (passport, driving license, national insurance)
addresses - [CheckDetailAddress] Addresses provided to check
Example
{
  "checkId": 987,
  "id": "xyz789",
  "email": "xyz789",
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z",
  "mobileNumber": "xyz789",
  "countryOfResidence": "AFG",
  "identityDocuments": [CheckDetailIdentityDocument],
  "addresses": [CheckDetailAddress]
}
Types

Director

Fields
Field Name Description
id - String
person_id - String
appointments - [Director]
source - SourceKey!
is_current - Boolean!
appointment - CompanyAppointmentType!
company_name - String
rfa_rating - CompanyRating!
first_name - String
surname - String
nationality - String
town - String
county - String
postcode - String
occupation - String
locality - String
address - String
title - String
appointment_type - String
birthdate - DateTime
date_appointed - DateTime
date_resigned - DateTime
other_appointments - String
company - String
companyId - Long!
company_id - Long!
Example
{
  "id": "xyz789",
  "person_id": "abc123",
  "appointments": [Director],
  "source": "RFA",
  "is_current": false,
  "appointment": "UNKNOWN",
  "company_name": "xyz789",
  "rfa_rating": "THREE_RED_FLAGS",
  "first_name": "xyz789",
  "surname": "abc123",
  "nationality": "xyz789",
  "town": "xyz789",
  "county": "xyz789",
  "postcode": "xyz789",
  "occupation": "xyz789",
  "locality": "xyz789",
  "address": "xyz789",
  "title": "xyz789",
  "appointment_type": "xyz789",
  "birthdate": "2007-12-03T10:15:30Z",
  "date_appointed": "2007-12-03T10:15:30Z",
  "date_resigned": "2007-12-03T10:15:30Z",
  "other_appointments": "xyz789",
  "company": "abc123",
  "companyId": {},
  "company_id": {}
}
Types

DirectorFilterInput

Fields
Input Field Description
and - [DirectorFilterInput!]
or - [DirectorFilterInput!]
source - SourceKeyOperationFilterInput
is_current - BooleanOperationFilterInput
appointment - CompanyAppointmentTypeOperationFilterInput
company_name - StringOperationFilterInput
rfa_rating - CompanyRatingOperationFilterInput
first_name - StringOperationFilterInput
surname - StringOperationFilterInput
nationality - StringOperationFilterInput
town - StringOperationFilterInput
county - StringOperationFilterInput
postcode - StringOperationFilterInput
occupation - StringOperationFilterInput
locality - StringOperationFilterInput
address - StringOperationFilterInput
title - StringOperationFilterInput
appointment_type - StringOperationFilterInput
birthdate - DateTimeOperationFilterInput
date_appointed - DateTimeOperationFilterInput
date_resigned - DateTimeOperationFilterInput
other_appointments - StringOperationFilterInput
person_id - StringOperationFilterInput
company - StringOperationFilterInput
companyId - LongOperationFilterInput
company_id - LongOperationFilterInput
id - StringOperationFilterInput
Example
{
  "and": [DirectorFilterInput],
  "or": [DirectorFilterInput],
  "source": SourceKeyOperationFilterInput,
  "is_current": BooleanOperationFilterInput,
  "appointment": CompanyAppointmentTypeOperationFilterInput,
  "company_name": StringOperationFilterInput,
  "rfa_rating": CompanyRatingOperationFilterInput,
  "first_name": StringOperationFilterInput,
  "surname": StringOperationFilterInput,
  "nationality": StringOperationFilterInput,
  "town": StringOperationFilterInput,
  "county": StringOperationFilterInput,
  "postcode": StringOperationFilterInput,
  "occupation": StringOperationFilterInput,
  "locality": StringOperationFilterInput,
  "address": StringOperationFilterInput,
  "title": StringOperationFilterInput,
  "appointment_type": StringOperationFilterInput,
  "birthdate": DateTimeOperationFilterInput,
  "date_appointed": DateTimeOperationFilterInput,
  "date_resigned": DateTimeOperationFilterInput,
  "other_appointments": StringOperationFilterInput,
  "person_id": StringOperationFilterInput,
  "company": StringOperationFilterInput,
  "companyId": LongOperationFilterInput,
  "company_id": LongOperationFilterInput,
  "id": StringOperationFilterInput
}
Types

DirectorPartial

Fields
Field Name Description
age_years - Int
appointment_duration_years - Int
title - Honorific!
occupation - String
nationalities - [String]
nationalities_iso3 - [String]
Example
{
  "age_years": 987,
  "appointment_duration_years": 123,
  "title": "UNKNOWN",
  "occupation": "abc123",
  "nationalities": ["xyz789"],
  "nationalities_iso3": ["abc123"]
}
Types

DirectorPartialFilterInput

Fields
Input Field Description
and - [DirectorPartialFilterInput!]
or - [DirectorPartialFilterInput!]
age_years - IntOperationFilterInput
appointment_duration_years - IntOperationFilterInput
title - HonorificOperationFilterInput
occupation - StringOperationFilterInput
nationalities - ListStringOperationFilterInput
nationalities_iso3 - ListStringOperationFilterInput
Example
{
  "and": [DirectorPartialFilterInput],
  "or": [DirectorPartialFilterInput],
  "age_years": IntOperationFilterInput,
  "appointment_duration_years": IntOperationFilterInput,
  "title": HonorificOperationFilterInput,
  "occupation": StringOperationFilterInput,
  "nationalities": ListStringOperationFilterInput,
  "nationalities_iso3": ListStringOperationFilterInput
}
Types

DirectorPerson

Fields
Field Name Description
company_number - String
appointment_type - AppointmentType
person_id - String
is_corporate - Boolean
appointment_date - Date
resignation_date - Date
company - CompanySearch
Example
{
  "company_number": "abc123",
  "appointment_type": "CURRENT_SECRETARY",
  "person_id": "xyz789",
  "is_corporate": false,
  "appointment_date": "2007-12-03",
  "resignation_date": "2007-12-03",
  "company": CompanySearch
}
Types

DirectorPersonFilterInput

Fields
Input Field Description
and - [DirectorPersonFilterInput!]
or - [DirectorPersonFilterInput!]
company_number - StringOperationFilterInput
appointment_type - AppointmentTypeOperationFilterInput
person_id - StringOperationFilterInput
is_corporate - BooleanOperationFilterInput
appointment_date - DateTimeOperationFilterInput
resignation_date - DateTimeOperationFilterInput
Example
{
  "and": [DirectorPersonFilterInput],
  "or": [DirectorPersonFilterInput],
  "company_number": StringOperationFilterInput,
  "appointment_type": AppointmentTypeOperationFilterInput,
  "person_id": StringOperationFilterInput,
  "is_corporate": BooleanOperationFilterInput,
  "appointment_date": DateTimeOperationFilterInput,
  "resignation_date": DateTimeOperationFilterInput
}
Types

DirectorPersonSortInput

Fields
Input Field Description
company_number - SortEnumType
appointment_type - SortEnumType
person_id - SortEnumType
is_corporate - SortEnumType
appointment_date - SortEnumType
resignation_date - SortEnumType
Example
{
  "company_number": "ASC",
  "appointment_type": "ASC",
  "person_id": "ASC",
  "is_corporate": "ASC",
  "appointment_date": "ASC",
  "resignation_date": "ASC"
}
Types

DirectorSortInput

Fields
Input Field Description
source - SortEnumType
is_current - SortEnumType
appointment - SortEnumType
company_name - SortEnumType
rfa_rating - SortEnumType
first_name - SortEnumType
surname - SortEnumType
nationality - SortEnumType
town - SortEnumType
county - SortEnumType
postcode - SortEnumType
occupation - SortEnumType
locality - SortEnumType
address - SortEnumType
title - SortEnumType
appointment_type - SortEnumType
birthdate - SortEnumType
date_appointed - SortEnumType
date_resigned - SortEnumType
other_appointments - SortEnumType
person_id - SortEnumType
company - SortEnumType
companyId - SortEnumType
company_id - SortEnumType
id - SortEnumType
Example
{
  "source": "ASC",
  "is_current": "ASC",
  "appointment": "ASC",
  "company_name": "ASC",
  "rfa_rating": "ASC",
  "first_name": "ASC",
  "surname": "ASC",
  "nationality": "ASC",
  "town": "ASC",
  "county": "ASC",
  "postcode": "ASC",
  "occupation": "ASC",
  "locality": "ASC",
  "address": "ASC",
  "title": "ASC",
  "appointment_type": "ASC",
  "birthdate": "ASC",
  "date_appointed": "ASC",
  "date_resigned": "ASC",
  "other_appointments": "ASC",
  "person_id": "ASC",
  "company": "ASC",
  "companyId": "ASC",
  "company_id": "ASC",
  "id": "ASC"
}
Types

DirectorSummary

Fields
Field Name Description
total_current - Int!
total_previous - Int!
Example
{"total_current": 987, "total_previous": 123}
Types

DirectorSummaryFilterInput

Fields
Input Field Description
and - [DirectorSummaryFilterInput!]
or - [DirectorSummaryFilterInput!]
total_current - IntOperationFilterInput
total_previous - IntOperationFilterInput
Example
{
  "and": [DirectorSummaryFilterInput],
  "or": [DirectorSummaryFilterInput],
  "total_current": IntOperationFilterInput,
  "total_previous": IntOperationFilterInput
}
Types

DirectorSummarySortInput

Fields
Input Field Description
total_current - SortEnumType
total_previous - SortEnumType
Example
{"total_current": "ASC", "total_previous": "ASC"}
Types

DirectorsCollectionSegment

Description

A segment of a collection.

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

DobVerifiedStatus

Values
Enum Value Description

FULL_MATCH

MATCHED_DAY_ONLY

MATCHED_MONTH_ONLY

MATCHED_YEAR_ONLY

MATCHED_DAY_AND_MONTH

MATCHED_MONTH_AND_YEAR

MATCHED_DAY_AND_YEAR

NO_DATA

NO_MATCH

TRANSPOSED_MONTH_AND_DAY

OTHER
Example
"FULL_MATCH"
Types

DocumentCheckFieldMatchDbModel

Fields
Field Name Description
id - UUID!
documentCheckResultId - UUID
fieldName - String
matchStatus - String
matchedValue - String
confidenceScore - Float
documentCheckResult - DocumentCheckResult
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "documentCheckResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldName": "xyz789",
  "matchStatus": "xyz789",
  "matchedValue": "abc123",
  "confidenceScore": 987.65,
  "documentCheckResult": DocumentCheckResult
}
Types

DocumentCheckResult

Description

Document check result for a check

Fields
Field Name Description
id - UUID! Unique identifier for the document check result
checkId - UUID ID of the associated check
transactionId - String Transaction ID from the document verification provider
documentType - String Type of document verified
documentNumber - String Document number
documentCountry - String Country that issued the document
issuedDate - DateTime Date when document was issued
expiryDate - DateTime Date when document expires
fullName - String Full name from document
firstName - String First name from document
lastName - String Last name from document
birthDate - DateTime Date of birth from document
gender - String Gender from document
nationality - String Nationality from document
status - String Status of the document verification
confidenceScore - Float Confidence score of the verification
createdAt - DateTime When the document check result was created
verifiedAt - DateTime When the verification was completed
updatedAt - DateTime When the document check result was last updated
vendor - String Vendor used for document verification
check - CheckV2 Associated check
fieldMatches - [DocumentCheckFieldMatchDbModel!]! Field matches found during verification
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "transactionId": "xyz789",
  "documentType": "xyz789",
  "documentNumber": "xyz789",
  "documentCountry": "xyz789",
  "issuedDate": "2007-12-03T10:15:30Z",
  "expiryDate": "2007-12-03T10:15:30Z",
  "fullName": "abc123",
  "firstName": "abc123",
  "lastName": "abc123",
  "birthDate": "2007-12-03T10:15:30Z",
  "gender": "xyz789",
  "nationality": "abc123",
  "status": "xyz789",
  "confidenceScore": 123.45,
  "createdAt": "2007-12-03T10:15:30Z",
  "verifiedAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "vendor": "abc123",
  "check": CheckV2,
  "fieldMatches": [DocumentCheckFieldMatchDbModel]
}
Types

DocumentField

Values
Enum Value Description

FIRST_NAME

MIDDLE_NAME

LAST_NAME

DATE_OF_BIRTH

DOCUMENT_NUMBER

EXPIRY_DATE

ADDRESS
Example
"FIRST_NAME"
Types

DocumentFieldOperationFilterInput

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

ElectoralRollData

Fields
Field Name Description
electoralRollStart - String!
electoralRollEnd - String!
seniority - String!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "electoralRollStart": "xyz789",
  "electoralRollEnd": "xyz789",
  "seniority": "xyz789",
  "person": PersonalDetails,
  "associationType": "abc123",
  "matchesApplicantName": false,
  "matchesApplicantDob": true
}
Types

EmailConfigurationFilterInput

Fields
Input Field Description
and - [EmailConfigurationFilterInput!]
or - [EmailConfigurationFilterInput!]
accountId - StringOperationFilterInput
subject - StringOperationFilterInput
template - StringOperationFilterInput
account - AccountFilterInput
Example
{
  "and": [EmailConfigurationFilterInput],
  "or": [EmailConfigurationFilterInput],
  "accountId": StringOperationFilterInput,
  "subject": StringOperationFilterInput,
  "template": StringOperationFilterInput,
  "account": AccountFilterInput
}
Types

EmailConfigurationSortInput

Fields
Input Field Description
accountId - SortEnumType
subject - SortEnumType
template - SortEnumType
account - AccountSortInput
Example
{
  "accountId": "ASC",
  "subject": "ASC",
  "template": "ASC",
  "account": AccountSortInput
}
Types

EmployeeCount

Fields
Field Name Description
scope - String
reliabilityDescription - String
value - Int
Example
{
  "scope": "abc123",
  "reliabilityDescription": "abc123",
  "value": 987
}
Types

Event

Values
Enum Value Description

NA

BUSINESS_ADDRESS_AMENDED

CCJ_SATISFIED

CCJ_NEW

COMPANY_RESTORATION

ACC_REF_DATE_CHANGE

REG_NAME_CHANGE

REG_ADDRESS_CHANGE

DISSOLUTION_FIRST_GAZETTE

DISSOLUTION_0

DISSOLUTION_9

GAZETTE_ADMIN_ORDER

GAZETTE_RECEIVER_APPOINTED

GAZETTE_BANKRUPTCY_ORDER

GAZETTE_CVA

GAZETTE_COMPANY_DISSOLVED

GAZETTE_PARTNERSHIP_DISSOLUTION

GAZETTE_HIGH_COURT_WRIT

GAZETTE_JOINT_ADMINISTRATORS_APPOINTED

GAZETTE_LIQUIDATOR_APPOINTED

GAZETTE_RECEIVER_LAND_PROPERTY

GAZETTE_CREDITORS_MEETING

GAZETTE_PETITION_DISMISSED

GAZETTE_WINDING_UP_PETITION

GAZETTE_PETITION_ADJOURNED

GAZETTE_PETITION_WITHDRAWN

GAZETTE_RECEIVER_MANAGER_APPOINTED

GAZETTE_RECEIVER_MANAGER_CEASING

GAZETTE_STRIKING_OFF_NOTICE_DISMISSED

GAZETTE_STRIKING_OFF_SUSPENDED

GAZETTE_STRIKING_OFF_APPLICATION

GAZETTE_STRIKING_OFF_NOTICE

GAZETTE_STRIKING_OFF_WITHDRAWN

GAZETTE_TRUST_DEED

GAZETTE_UNADVERTISED_PETITION_TO_WIND_UP

GAZETTE_VOLUNTARY_ARRANGEMENT_IN_DEFAULT

GAZETTE_VOLUNTARY_WINDING_UP

GAZETTE_WINDING_UP_ORDER_RESCINDED

GAZETTE_WINDING_UP_ORDER

MORTGAGE_AMENDMENT

SATISFIED_MORTGAGE

NEW_MORTGAGE

LATE_ACCOUNTS

SHAREHOLDER_ADDED

OFFICER_ADDED

OFFICER_RESIGNED

ACCOUNTS_ADDED

PAYMENT_TREND_CHANGE

CCJ_NEW_PROBABLE_MATCH

CCJ_NEW_POSSIBLE_MATCH

IMMINENT_COURT_HEARING

CREDIT_SCORE_INCREASE

CREDIT_SCORE_DECREASE

CREDIT_SCORE_CHANGE_20_POINTS

REVENUE_DROP_GT_10_PERCENT

COMPANY_INCORPORATED

CREDITOR_SERVICES

PRELIMINARY_NOTICE_OF_CREDITOR_ARRANGEMENT

COMPANY_RESTORATION_COURT_ORDER

COMPANY_RESTORATION_ADMINISTRATIVE_RESTORATION

LIQUIDITY_RATIO_DROP_GT_10_PERCENT

COHO_STATEMENT_OF_AFFAIRS

ASSET_VALUE_INCREASE_BY_GT_15_PERCENT

VOLUNTARY_DISSOLUTION_APPLICATION_SUSPENDED

LSE_PROFIT_WARNING

DEBT_EBITDA_RATIO

PRE_INSOLVENCY

CREDITOR_CLAIM_1_YEAR_WORKING_CAPITAL_GT_0_4

CREDITOR_CLAIM_1_YEAR_NET_WORTH_GT_0_4

RFA_RATING_CHANGE

GAZETTE_ANNUAL_LIQUIDATION_MEETINGS

GAZETTE_DEEMED_CONSENT

GAZETTE_FINAL_MEETINGS

GAZETTE_NOTICES_TO_MEMBERS

GAZETTE_NOTICE_OF_DIVIDEND

GAZETTE_NOTICE_OF_INTENDED_DIVIDEND

GAZETTE_NOTICE_TO_CREDITORS

GAZETTE_RESOLUTION_FOR_WINDING_UP

GAZETTE_SERVICE_OF_PETITION

POSC_CHANGE

HMCOURTS_NOTICE_INTENTION_APPOINT_ADMINISTRATOR

HMCOURTS_NOTICE_APPOINT_ADMINISTRATOR

HMCOURTS_ADMINISTRATOR_APPLICATION

HMCOURTS_CVA

HMCOURTS_WINDING_UP_PETITION

HMCOURTS_INITIAL_STAGE_WINDING_UP_PETITION

HMCOURTS_WINDING_UP_PETITION_WITHDRAWN

CREDIT_LIMIT_INCREASED

CREDIT_LIMIT_DECREASED

CREDIT_LIMIT_CHANGED_20_POINTS

ACCOUNTS_OVERDUE

CREDIT_LIMIT_CHANGED_25_PERCENT

RFA_RATING_RECLASSIFICATION

FAILURE_PROBABILITY_CHANGED

HMCOURTS_MORATORIUM_COMING_INTO_FORCE
Example
"NA"
Types

EventOperationFilterInput

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

EventType

Fields
Field Name Description
description - String Description
name - String Name
id - Event! Id
Example
{
  "description": "abc123",
  "name": "xyz789",
  "id": "NA"
}
Types

EventTypeFilterInput

Fields
Input Field Description
and - [EventTypeFilterInput!]
or - [EventTypeFilterInput!]
id - EventOperationFilterInput
name - StringOperationFilterInput
description - StringOperationFilterInput
supportedPortfolioType - PortfolioTypeOperationFilterInput
triggerEvent - ListFilterInputTypeOfTriggerEventFilterInput
portfolioEvent - ListFilterInputTypeOfPortfolioEventFilterInput
Example
{
  "and": [EventTypeFilterInput],
  "or": [EventTypeFilterInput],
  "id": EventOperationFilterInput,
  "name": StringOperationFilterInput,
  "description": StringOperationFilterInput,
  "supportedPortfolioType": PortfolioTypeOperationFilterInput,
  "triggerEvent": ListFilterInputTypeOfTriggerEventFilterInput,
  "portfolioEvent": ListFilterInputTypeOfPortfolioEventFilterInput
}
Types

EventTypeOperationFilterInput

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

EventTypeSortInput

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

FieldUI

Description

UI configuration for form fields

Fields
Field Name Description
label - String Display label for the field
placeholder - String Placeholder text
order - Int Display order
readonly - Boolean Whether the field is readonly
widget - String UI widget type
Example
{
  "label": "abc123",
  "placeholder": "xyz789",
  "order": 123,
  "readonly": false,
  "widget": "abc123"
}
Types

File

Description

A file in the v2 system

Fields
Field Name Description
id - UUID! Unique file identifier
fileName - String Name of the file
filePath - String Path to the file
fileSize - Long Size of the file in bytes
contentType - String MIME type of the file
uploadedAt - DateTime When the file was uploaded
createdAt - DateTime When the file record was created
base64Content - String Base64 encoded content of the file
idvResultPhotos - [IdvResultPhoto!]
idvResultFaceVerifications - [IdvResultFaceVerification!]
idvResultLivenessVideos - [IdvResultLivenessVideo!]
idvResultLivenessAttempts - [IdvResultLivenessAttempt!]
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fileName": "xyz789",
  "filePath": "abc123",
  "fileSize": {},
  "contentType": "abc123",
  "uploadedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "base64Content": "xyz789",
  "idvResultPhotos": [IdvResultPhoto],
  "idvResultFaceVerifications": [
    IdvResultFaceVerification
  ],
  "idvResultLivenessVideos": [IdvResultLivenessVideo],
  "idvResultLivenessAttempts": [IdvResultLivenessAttempt]
}
Types

FileExport

Description

File Export

Fields
Field Name Description
columnSelection - FileExportSelectionType Column Selection
resultSelection - FileExportSelectionType Result Selection
apiQuery - String Query
variables - String Variables
fieldType - String Field Type
status - FileExportStatus! Acknowledged
rowCount - Int Number of records in file export
acknowledged - Boolean Acknowledged
id - String Id of export
timestamp - DateTime! Deprecated, use createdDate
createdDate - DateTime! Time requested
completedDate - DateTime Time completed
relativePath - String Path to export page requested
exportType - FileExportRequestType! Type of export requested
description - String Description
totalResults - Int Description
etaSeconds - Int ETA Seconds
isCancelled - Boolean If cancelled by user
legacyId - String LegacyId of export
fileLocation - String
downloadLocation - String File Export Download Location
Arguments
downloadFilename - String
isScheduledExport - Boolean If the export is a scheduled export
exportReference - String Reference for a customer to identify an export
meta - FileExportMeta Meta data for the export
Example
{
  "columnSelection": "ALL_COLUMNS",
  "resultSelection": "ALL_COLUMNS",
  "apiQuery": "xyz789",
  "variables": "xyz789",
  "fieldType": "xyz789",
  "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": "abc123",
  "isScheduledExport": false,
  "exportReference": "abc123",
  "meta": FileExportMeta
}
Types

FileExportFilterInput

Fields
Input Field Description
and - [FileExportFilterInput!]
or - [FileExportFilterInput!]
id - StringOperationFilterInput
legacyId - StringOperationFilterInput
apiQuery - StringOperationFilterInput
variables - StringOperationFilterInput
accountId - StringOperationFilterInput
userEmail - StringOperationFilterInput
fileLocation - StringOperationFilterInput
columnMappings - StringOperationFilterInput
rowCount - IntOperationFilterInput
etaSeconds - IntOperationFilterInput
totalResults - IntOperationFilterInput
columnSelection - NullableOfFileExportSelectionTypeOperationFilterInput
resultSelection - NullableOfFileExportSelectionTypeOperationFilterInput
status - FileExportStatusOperationFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
completedDate - portfolio_DateTimeOperationFilterInput
timestamp - portfolio_DateTimeOperationFilterInput
acknowledged - BooleanOperationFilterInput
csvExportLimit - IntOperationFilterInput
queryName - StringOperationFilterInput
fieldType - StringOperationFilterInput
exportType - FileExportRequestTypeOperationFilterInput
description - StringOperationFilterInput
relativePath - StringOperationFilterInput
isCancelled - BooleanOperationFilterInput
isScheduledExport - BooleanOperationFilterInput
exportReference - StringOperationFilterInput
meta - FileExportMetaFilterInput
Example
{
  "and": [FileExportFilterInput],
  "or": [FileExportFilterInput],
  "id": StringOperationFilterInput,
  "legacyId": StringOperationFilterInput,
  "apiQuery": StringOperationFilterInput,
  "variables": StringOperationFilterInput,
  "accountId": StringOperationFilterInput,
  "userEmail": StringOperationFilterInput,
  "fileLocation": StringOperationFilterInput,
  "columnMappings": StringOperationFilterInput,
  "rowCount": IntOperationFilterInput,
  "etaSeconds": IntOperationFilterInput,
  "totalResults": IntOperationFilterInput,
  "columnSelection": NullableOfFileExportSelectionTypeOperationFilterInput,
  "resultSelection": NullableOfFileExportSelectionTypeOperationFilterInput,
  "status": FileExportStatusOperationFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput,
  "completedDate": portfolio_DateTimeOperationFilterInput,
  "timestamp": portfolio_DateTimeOperationFilterInput,
  "acknowledged": BooleanOperationFilterInput,
  "csvExportLimit": IntOperationFilterInput,
  "queryName": StringOperationFilterInput,
  "fieldType": StringOperationFilterInput,
  "exportType": FileExportRequestTypeOperationFilterInput,
  "description": StringOperationFilterInput,
  "relativePath": StringOperationFilterInput,
  "isCancelled": BooleanOperationFilterInput,
  "isScheduledExport": BooleanOperationFilterInput,
  "exportReference": StringOperationFilterInput,
  "meta": FileExportMetaFilterInput
}
Types

FileExportMeta

Fields
Field Name Description
pdf - PDFMeta
Example
{"pdf": PDFMeta}
Types

FileExportMetaFilterInput

Fields
Input Field Description
and - [FileExportMetaFilterInput!]
or - [FileExportMetaFilterInput!]
pdf - PDFMetaFilterInput
Example
{
  "and": [FileExportMetaFilterInput],
  "or": [FileExportMetaFilterInput],
  "pdf": PDFMetaFilterInput
}
Types

FileExportRequestInput

Description

File Export Request Type

Fields
Input Field Description
description - String Description of requested export
exportType - FileExportRequestType! Type of export requested (pdf / csv). Default = CSV
relativePath - String Relative path to RFA page for PDF exports
columnSelection - FileExportSelectionType Column Selection
resultSelection - FileExportSelectionType Result Selection
apiQuery - String Query sent to API
variables - String Variables
fieldType - String Type of field being exported
columnMappings - String Mappings for columns
queryName - String Name of query being ran
bearerToken - String Bearer token for user specific exports
totalResults - Int! Total number of results from initial query
accountId - String User Account Id
csvExportLimit - Int User Csv Export Limit
userEmail - String User Email Address
isScheduledExport - Boolean If the export is scheduled
exportReference - String Reference for a customer to identify an export
meta - MetaInput Meta data for export
Example
{
  "description": "xyz789",
  "exportType": "CSV",
  "relativePath": "abc123",
  "columnSelection": "ALL_COLUMNS",
  "resultSelection": "ALL_COLUMNS",
  "apiQuery": "abc123",
  "variables": "xyz789",
  "fieldType": "xyz789",
  "columnMappings": "abc123",
  "queryName": "xyz789",
  "bearerToken": "abc123",
  "totalResults": 123,
  "accountId": "abc123",
  "csvExportLimit": 987,
  "userEmail": "xyz789",
  "isScheduledExport": true,
  "exportReference": "xyz789",
  "meta": MetaInput
}
Types

FileExportRequestType

Values
Enum Value Description

CSV

PDF
Example
"CSV"
Types

FileExportRequestTypeOperationFilterInput

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

FileExportSelectionType

Values
Enum Value Description

ALL_COLUMNS

SELECTED_COLUMNS

SELECTED_PAGES

ALL_PAGES
Example
"ALL_COLUMNS"
Types

FileExportStatus

Values
Enum Value Description

REQUESTED

COMPLETED

RUNNING
Example
"REQUESTED"
Types

FileExportStatusOperationFilterInput

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

FileExportsCollectionSegment

Description

A segment of a collection.

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

FilingHistory

Fields
Field Name Description
download_url - String
description - String
description_values - DescriptionValues
date - DateTime
action_date - DateTime
Example
{
  "download_url": "abc123",
  "description": "abc123",
  "description_values": DescriptionValues,
  "date": "2007-12-03T10:15:30Z",
  "action_date": "2007-12-03T10:15:30Z"
}
Types

FinancialRatio

Fields
Field Name Description
fromDate - DateTime
toDate - DateTime
values - [FinancialRatioValue]
Example
{
  "fromDate": "2007-12-03T10:15:30Z",
  "toDate": "2007-12-03T10:15:30Z",
  "values": [FinancialRatioValue]
}
Types

FinancialRatioValue

Fields
Field Name Description
description - String
value - Float
Example
{"description": "abc123", "value": 123.45}
Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65
Types

FloatOperationFilterInput

Fields
Input Field Description
eq - Float
neq - Float
in - [Float]
nin - [Float]
gt - Float
ngt - Float
gte - Float
ngte - Float
lt - Float
nlt - Float
lte - Float
nlte - Float
Example
{
  "eq": 987.65,
  "neq": 987.65,
  "in": [123.45],
  "nin": [123.45],
  "gt": 123.45,
  "ngt": 123.45,
  "gte": 123.45,
  "ngte": 987.65,
  "lt": 123.45,
  "nlt": 987.65,
  "lte": 123.45,
  "nlte": 987.65
}
Types

FormFieldEntry

Description

Form field entry with name and configuration

Fields
Field Name Description
name - String Field name
type - String Field type
required - Boolean Whether the field is required
maxLength - Int Maximum length
minLength - Int Minimum length
pattern - String Validation pattern
format - String Field format
minAge - Int Minimum age
countryCode - String Country code
enum - [String] Allowed enum values
default - String Default value
properties - [FormFieldEntry] Additional properties
ui - FieldUI UI configuration
Example
{
  "name": "abc123",
  "type": "abc123",
  "required": false,
  "maxLength": 123,
  "minLength": 123,
  "pattern": "abc123",
  "format": "xyz789",
  "minAge": 987,
  "countryCode": "xyz789",
  "enum": ["abc123"],
  "default": "xyz789",
  "properties": [FormFieldEntry],
  "ui": FieldUI
}
Types

FormerName

Fields
Field Name Description
name - String
date_from - DateTime
date_to - DateTime
Example
{
  "name": "abc123",
  "date_from": "2007-12-03T10:15:30Z",
  "date_to": "2007-12-03T10:15:30Z"
}
Types

FormerNameFilterInput

Fields
Input Field Description
and - [FormerNameFilterInput!]
or - [FormerNameFilterInput!]
name - StringOperationFilterInput
date_from - DateTimeOperationFilterInput
date_to - DateTimeOperationFilterInput
Example
{
  "and": [FormerNameFilterInput],
  "or": [FormerNameFilterInput],
  "name": StringOperationFilterInput,
  "date_from": DateTimeOperationFilterInput,
  "date_to": DateTimeOperationFilterInput
}
Types

GazetteNotice

Description

Company Gazette notice

Fields
Field Name Description
published_date - DateTime! Date notice was published.
created_date - DateTime! Date notice created in RFA system
notice_code_value - String Notice code value. For more information: https://www.thegazette.co.uk/noticecodes
notice_code_name - NoticeCodeType! Description of notice code. For more information: https://www.thegazette.co.uk/noticecodes
notice_id - String Description of notice code. For more information: https://www.thegazette.co.uk/noticecodes
uri - String Uri for the notice. All notices: https://www.thegazette.co.uk/all-notices/notice
Example
{
  "published_date": "2007-12-03T10:15:30Z",
  "created_date": "2007-12-03T10:15:30Z",
  "notice_code_value": "xyz789",
  "notice_code_name": "UNKNOWN",
  "notice_id": "xyz789",
  "uri": "xyz789"
}
Types

GazetteNoticeFilterInput

Fields
Input Field Description
and - [GazetteNoticeFilterInput!]
or - [GazetteNoticeFilterInput!]
companyId - IntOperationFilterInput
published_date - DateTimeOperationFilterInput
created_date - DateTimeOperationFilterInput
notice_code_value - StringOperationFilterInput
notice_code_name - NoticeCodeTypeOperationFilterInput
uri - StringOperationFilterInput
notice_id - StringOperationFilterInput
source - StringOperationFilterInput
Example
{
  "and": [GazetteNoticeFilterInput],
  "or": [GazetteNoticeFilterInput],
  "companyId": IntOperationFilterInput,
  "published_date": DateTimeOperationFilterInput,
  "created_date": DateTimeOperationFilterInput,
  "notice_code_value": StringOperationFilterInput,
  "notice_code_name": NoticeCodeTypeOperationFilterInput,
  "uri": StringOperationFilterInput,
  "notice_id": StringOperationFilterInput,
  "source": StringOperationFilterInput
}
Types

GbGConfiguration

Fields
Field Name Description
username - String
password - String
dataProtectionNumber - String
enabled - Boolean!
profileConfigurations - [GbgProfileConfiguration]
accountId - String
account - Account
Example
{
  "username": "abc123",
  "password": "abc123",
  "dataProtectionNumber": "abc123",
  "enabled": false,
  "profileConfigurations": [GbgProfileConfiguration],
  "accountId": "abc123",
  "account": Account
}
Types

GbGConfigurationFilterInput

Fields
Input Field Description
and - [GbGConfigurationFilterInput!]
or - [GbGConfigurationFilterInput!]
accountId - StringOperationFilterInput
username - StringOperationFilterInput
password - StringOperationFilterInput
dataProtectionNumber - StringOperationFilterInput
enabled - BooleanOperationFilterInput
profileConfigurations - ListFilterInputTypeOfGbgProfileConfigurationFilterInput
account - AccountFilterInput
Example
{
  "and": [GbGConfigurationFilterInput],
  "or": [GbGConfigurationFilterInput],
  "accountId": StringOperationFilterInput,
  "username": StringOperationFilterInput,
  "password": StringOperationFilterInput,
  "dataProtectionNumber": StringOperationFilterInput,
  "enabled": BooleanOperationFilterInput,
  "profileConfigurations": ListFilterInputTypeOfGbgProfileConfigurationFilterInput,
  "account": AccountFilterInput
}
Types

GbGConfigurationSortInput

Fields
Input Field Description
accountId - SortEnumType
username - SortEnumType
password - SortEnumType
dataProtectionNumber - SortEnumType
enabled - SortEnumType
account - AccountSortInput
Example
{
  "accountId": "ASC",
  "username": "ASC",
  "password": "ASC",
  "dataProtectionNumber": "ASC",
  "enabled": "ASC",
  "account": AccountSortInput
}
Types

GbgProfileConfiguration

Fields
Field Name Description
countryCode - account_CountryCode!
profileId - String
profileType - GbgProfileType!
accountId - String
gbgConfiguration - GbGConfiguration
Example
{
  "countryCode": "AFG",
  "profileId": "abc123",
  "profileType": "AML",
  "accountId": "abc123",
  "gbgConfiguration": GbGConfiguration
}
Types

GbgProfileConfigurationFilterInput

Fields
Input Field Description
and - [GbgProfileConfigurationFilterInput!]
or - [GbgProfileConfigurationFilterInput!]
accountId - StringOperationFilterInput
profileId - StringOperationFilterInput
profileType - GbgProfileTypeOperationFilterInput
countryCode - CountryCodeOperationFilterInput
gbgConfiguration - GbGConfigurationFilterInput
Example
{
  "and": [GbgProfileConfigurationFilterInput],
  "or": [GbgProfileConfigurationFilterInput],
  "accountId": StringOperationFilterInput,
  "profileId": StringOperationFilterInput,
  "profileType": GbgProfileTypeOperationFilterInput,
  "countryCode": CountryCodeOperationFilterInput,
  "gbgConfiguration": GbGConfigurationFilterInput
}
Types

GbgProfileType

Values
Enum Value Description

AML

KYC

KYC_WITH_DOC

AML_2

BANK_ACCOUNT_VERIFICATION

PHONE_VERIFICATION

EMAIL_VERIFICATION

AML_1
Example
"AML"
Types

GbgProfileTypeOperationFilterInput

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

History

Description

Company History notice

Fields
Field Name Description
event_type - company_EventType!
company_id - Int!
description - String
published_date - DateTime!
id - String!
rating - CompanyRating
score - Float
case_number - String
case_title_company_name - String
case_type - String
source - String
filed_date - DateTime
case_status - String
company_legal_representative - String
applicant_name - String
company - CompanySearch
Example
{
  "event_type": "NA",
  "company_id": 987,
  "description": "abc123",
  "published_date": "2007-12-03T10:15:30Z",
  "id": "abc123",
  "rating": "THREE_RED_FLAGS",
  "score": 123.45,
  "case_number": "abc123",
  "case_title_company_name": "xyz789",
  "case_type": "abc123",
  "source": "xyz789",
  "filed_date": "2007-12-03T10:15:30Z",
  "case_status": "abc123",
  "company_legal_representative": "xyz789",
  "applicant_name": "abc123",
  "company": CompanySearch
}
Types

HistoryCollectionSegment

Description

A segment of a collection.

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

HistoryFilterInput

Fields
Input Field Description
and - [HistoryFilterInput!]
or - [HistoryFilterInput!]
id - StringOperationFilterInput
rating - NullableOfCompanyRatingOperationFilterInput
company_id - IntOperationFilterInput
event_type - EventTypeOperationFilterInput
published_date - DateTimeOperationFilterInput
description - StringOperationFilterInput
score - FloatOperationFilterInput
delete_event - BooleanOperationFilterInput
case_number - StringOperationFilterInput
case_title_company_name - StringOperationFilterInput
case_type - StringOperationFilterInput
source - StringOperationFilterInput
filed_date - DateTimeOperationFilterInput
case_status - StringOperationFilterInput
applicant_name - StringOperationFilterInput
company_legal_representative - StringOperationFilterInput
Example
{
  "and": [HistoryFilterInput],
  "or": [HistoryFilterInput],
  "id": StringOperationFilterInput,
  "rating": NullableOfCompanyRatingOperationFilterInput,
  "company_id": IntOperationFilterInput,
  "event_type": EventTypeOperationFilterInput,
  "published_date": DateTimeOperationFilterInput,
  "description": StringOperationFilterInput,
  "score": FloatOperationFilterInput,
  "delete_event": BooleanOperationFilterInput,
  "case_number": StringOperationFilterInput,
  "case_title_company_name": StringOperationFilterInput,
  "case_type": StringOperationFilterInput,
  "source": StringOperationFilterInput,
  "filed_date": DateTimeOperationFilterInput,
  "case_status": StringOperationFilterInput,
  "applicant_name": StringOperationFilterInput,
  "company_legal_representative": StringOperationFilterInput
}
Types

HistorySortInput

Fields
Input Field Description
id - SortEnumType
rating - SortEnumType
company_id - SortEnumType
event_type - SortEnumType
published_date - SortEnumType
description - SortEnumType
score - SortEnumType
delete_event - SortEnumType
case_number - SortEnumType
case_title_company_name - SortEnumType
case_type - SortEnumType
source - SortEnumType
filed_date - SortEnumType
case_status - SortEnumType
applicant_name - SortEnumType
company_legal_representative - SortEnumType
Example
{
  "id": "ASC",
  "rating": "ASC",
  "company_id": "ASC",
  "event_type": "ASC",
  "published_date": "ASC",
  "description": "ASC",
  "score": "ASC",
  "delete_event": "ASC",
  "case_number": "ASC",
  "case_title_company_name": "ASC",
  "case_type": "ASC",
  "source": "ASC",
  "filed_date": "ASC",
  "case_status": "ASC",
  "applicant_name": "ASC",
  "company_legal_representative": "ASC"
}
Types

Honorific

Values
Enum Value Description

UNKNOWN

MR

MRS

MS

MISS

DOCTOR

PROFESSOR

SIR

COUNCILLOR

REVEREND

LORD

LADY

DAME

SISTER

BARONESS

CANON

FATHER

MX

THE_HONOURABLE

MASTER

RABBI

VISCOUNT
Example
"UNKNOWN"
Types

HonorificOperationFilterInput

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

IdKitConfiguration

Fields
Field Name Description
apiUrl - String
authUrl - String
apiKey - String
accountId - String
account - Account
Example
{
  "apiUrl": "abc123",
  "authUrl": "abc123",
  "apiKey": "abc123",
  "accountId": "xyz789",
  "account": Account
}
Types

IdKitConfigurationFilterInput

Fields
Input Field Description
and - [IdKitConfigurationFilterInput!]
or - [IdKitConfigurationFilterInput!]
accountId - StringOperationFilterInput
apiKey - StringOperationFilterInput
authUrl - StringOperationFilterInput
apiUrl - StringOperationFilterInput
account - AccountFilterInput
Example
{
  "and": [IdKitConfigurationFilterInput],
  "or": [IdKitConfigurationFilterInput],
  "accountId": StringOperationFilterInput,
  "apiKey": StringOperationFilterInput,
  "authUrl": StringOperationFilterInput,
  "apiUrl": StringOperationFilterInput,
  "account": AccountFilterInput
}
Types

IdKitConfigurationSortInput

Fields
Input Field Description
accountId - SortEnumType
apiKey - SortEnumType
authUrl - SortEnumType
apiUrl - SortEnumType
account - AccountSortInput
Example
{
  "accountId": "ASC",
  "apiKey": "ASC",
  "authUrl": "ASC",
  "apiUrl": "ASC",
  "account": AccountSortInput
}
Types

IdReportBillInput

Fields
Input Field Description
apiId - String
productName - String
creditsSpent - Int!
reference - String
accountId - String
Example
{
  "apiId": "xyz789",
  "productName": "abc123",
  "creditsSpent": 987,
  "reference": "abc123",
  "accountId": "abc123"
}
Types

IdentificationDeviceDetails

Description

Details of the device used to perform identity check

Fields
Field Name Description
ipAddress - String IP Address of the device
deviceModel - String The device model
vpnUsed - Boolean! Whether VPN was used
ipLocation - String IP location of the device.
geoLocation - String
Example
{
  "ipAddress": "xyz789",
  "deviceModel": "abc123",
  "vpnUsed": false,
  "ipLocation": "abc123",
  "geoLocation": "abc123"
}
Types

IdentificationDeviceDetailsFilterInput

Fields
Input Field Description
and - [IdentificationDeviceDetailsFilterInput!]
or - [IdentificationDeviceDetailsFilterInput!]
id - IntOperationFilterInput
identificationDocument - IdentificationDocumentFilterInput
identificationDocumentId - IntOperationFilterInput
ipAddress - StringOperationFilterInput
deviceModel - StringOperationFilterInput
vpnUsed - BooleanOperationFilterInput
ipLocation - StringOperationFilterInput
geoLocation - StringOperationFilterInput
Example
{
  "and": [IdentificationDeviceDetailsFilterInput],
  "or": [IdentificationDeviceDetailsFilterInput],
  "id": IntOperationFilterInput,
  "identificationDocument": IdentificationDocumentFilterInput,
  "identificationDocumentId": IntOperationFilterInput,
  "ipAddress": StringOperationFilterInput,
  "deviceModel": StringOperationFilterInput,
  "vpnUsed": BooleanOperationFilterInput,
  "ipLocation": StringOperationFilterInput,
  "geoLocation": StringOperationFilterInput
}
Types

IdentificationDeviceDetailsSortInput

Fields
Input Field Description
id - SortEnumType
identificationDocument - IdentificationDocumentSortInput
identificationDocumentId - SortEnumType
ipAddress - SortEnumType
deviceModel - SortEnumType
vpnUsed - SortEnumType
ipLocation - SortEnumType
geoLocation - SortEnumType
Example
{
  "id": "ASC",
  "identificationDocument": IdentificationDocumentSortInput,
  "identificationDocumentId": "ASC",
  "ipAddress": "ASC",
  "deviceModel": "ASC",
  "vpnUsed": "ASC",
  "ipLocation": "ASC",
  "geoLocation": "ASC"
}
Types

IdentificationDocument

Description

Identification document result

Fields
Field Name Description
checkResultId - Int! AML Check Result Unique ID
fuzzyNameScore - Int! Fuzzy name score against the name specified
result - CheckResultType! Result based on name scoring
id - String Identification document Id
dateOfBirth - DateTime Date of birth
dateOfExpiry - DateTime Date of expiry
dateOfIssue - DateTime Date of issue
documentType - IdentificationDocumentType! Type of document
documentNumber - String Document number
firstName - String First name on document
lastName - String Last name on document
licenseClass - String License class
nationality - String Nationality on document
sex - IdentificationDocumentSexType! Person's sex
givenNames - String Given names
surnameAndGivenNames - String Surname and given names
issuingCountry - String Issueing country
isSuccess - Boolean! Result of identification check
images - [IdentificationDocumentImage] Images associated with document
edits - [IdentificationDocumentEdit] Images associated with document
integrityCheckResult - IdentificationDocumentIntegrity! Document integrity check results
biometrics - IdentificationDocumentBiometrics Liveliness biometric check results
deviceDetails - IdentificationDeviceDetails Details of the device used for check
Example
{
  "checkResultId": 123,
  "fuzzyNameScore": 987,
  "result": "AWAITING",
  "id": "abc123",
  "dateOfBirth": "2007-12-03T10:15:30Z",
  "dateOfExpiry": "2007-12-03T10:15:30Z",
  "dateOfIssue": "2007-12-03T10:15:30Z",
  "documentType": "DRIVING_LICENSE",
  "documentNumber": "xyz789",
  "firstName": "xyz789",
  "lastName": "xyz789",
  "licenseClass": "xyz789",
  "nationality": "xyz789",
  "sex": "FEMALE",
  "givenNames": "xyz789",
  "surnameAndGivenNames": "abc123",
  "issuingCountry": "abc123",
  "isSuccess": true,
  "images": [IdentificationDocumentImage],
  "edits": [IdentificationDocumentEdit],
  "integrityCheckResult": "CONSIDER",
  "biometrics": IdentificationDocumentBiometrics,
  "deviceDetails": IdentificationDeviceDetails
}
Types

IdentificationDocumentBiometrics

Description

Identification document biometrics

Fields
Field Name Description
faceMatch - BiometricCheckResultType! Document and liveness face match check result
liveness - BiometricCheckResultType! Liveness check result
photoCheck - BiometricCheckResultType! Photo check result
imageComposition - BiometricCheckResultType! Image composition result.
breakdown - [LivenessBreakdownItem] Breakdown of biometric checks performed
Example
{
  "faceMatch": "NOTAVAILABLE",
  "liveness": "NOTAVAILABLE",
  "photoCheck": "NOTAVAILABLE",
  "imageComposition": "NOTAVAILABLE",
  "breakdown": [LivenessBreakdownItem]
}
Types

IdentificationDocumentBiometricsFilterInput

Fields
Input Field Description
and - [IdentificationDocumentBiometricsFilterInput!]
or - [IdentificationDocumentBiometricsFilterInput!]
id - IntOperationFilterInput
identificationDocument - IdentificationDocumentFilterInput
identificationDocumentId - IntOperationFilterInput
faceMatch - BiometricCheckResultTypeOperationFilterInput
liveness - BiometricCheckResultTypeOperationFilterInput
photoCheck - BiometricCheckResultTypeOperationFilterInput
imageComposition - BiometricCheckResultTypeOperationFilterInput
breakdown - ListFilterInputTypeOfLivenessBreakdownItemFilterInput
Example
{
  "and": [IdentificationDocumentBiometricsFilterInput],
  "or": [IdentificationDocumentBiometricsFilterInput],
  "id": IntOperationFilterInput,
  "identificationDocument": IdentificationDocumentFilterInput,
  "identificationDocumentId": IntOperationFilterInput,
  "faceMatch": BiometricCheckResultTypeOperationFilterInput,
  "liveness": BiometricCheckResultTypeOperationFilterInput,
  "photoCheck": BiometricCheckResultTypeOperationFilterInput,
  "imageComposition": BiometricCheckResultTypeOperationFilterInput,
  "breakdown": ListFilterInputTypeOfLivenessBreakdownItemFilterInput
}
Types

IdentificationDocumentBiometricsSortInput

Fields
Input Field Description
id - SortEnumType
identificationDocument - IdentificationDocumentSortInput
identificationDocumentId - SortEnumType
faceMatch - SortEnumType
liveness - SortEnumType
photoCheck - SortEnumType
imageComposition - SortEnumType
Example
{
  "id": "ASC",
  "identificationDocument": IdentificationDocumentSortInput,
  "identificationDocumentId": "ASC",
  "faceMatch": "ASC",
  "liveness": "ASC",
  "photoCheck": "ASC",
  "imageComposition": "ASC"
}
Types

IdentificationDocumentEdit

Description

Identification document edit

Fields
Field Name Description
id - Int! Id of edit
field - DocumentField! Field changed
submittedValue - String Submitted Value
Example
{
  "id": 123,
  "field": "FIRST_NAME",
  "submittedValue": "abc123"
}
Types

IdentificationDocumentEditFilterInput

Fields
Input Field Description
and - [IdentificationDocumentEditFilterInput!]
or - [IdentificationDocumentEditFilterInput!]
id - IntOperationFilterInput
checkResultId - IntOperationFilterInput
field - DocumentFieldOperationFilterInput
submittedValue - StringOperationFilterInput
identificationDocument - IdentificationDocumentFilterInput
Example
{
  "and": [IdentificationDocumentEditFilterInput],
  "or": [IdentificationDocumentEditFilterInput],
  "id": IntOperationFilterInput,
  "checkResultId": IntOperationFilterInput,
  "field": DocumentFieldOperationFilterInput,
  "submittedValue": StringOperationFilterInput,
  "identificationDocument": IdentificationDocumentFilterInput
}
Types

IdentificationDocumentFilterInput

Fields
Input Field Description
and - [IdentificationDocumentFilterInput!]
or - [IdentificationDocumentFilterInput!]
checkResultId - IntOperationFilterInput
documentType - IdentificationDocumentTypeOperationFilterInput
documentNumber - StringOperationFilterInput
issuingCountry - StringOperationFilterInput
firstName - StringOperationFilterInput
lastName - StringOperationFilterInput
givenNames - StringOperationFilterInput
surnameAndGivenNames - StringOperationFilterInput
nationality - StringOperationFilterInput
dateOfBirth - portfolio_DateTimeOperationFilterInput
dateOfExpiry - portfolio_DateTimeOperationFilterInput
dateOfIssue - portfolio_DateTimeOperationFilterInput
licenseClass - StringOperationFilterInput
sex - IdentificationDocumentSexTypeOperationFilterInput
checkResult - CheckResultFilterInput
images - ListFilterInputTypeOfIdentificationDocumentImageFilterInput
edits - ListFilterInputTypeOfIdentificationDocumentEditFilterInput
biometrics - IdentificationDocumentBiometricsFilterInput
deviceDetails - IdentificationDeviceDetailsFilterInput
isSuccess - BooleanOperationFilterInput
fuzzyNameScore - IntOperationFilterInput
result - CheckResultTypeOperationFilterInput
verificationId - StringOperationFilterInput
mrz - StringOperationFilterInput
integrityCheckResult - IdentificationDocumentIntegrityOperationFilterInput
Example
{
  "and": [IdentificationDocumentFilterInput],
  "or": [IdentificationDocumentFilterInput],
  "checkResultId": IntOperationFilterInput,
  "documentType": IdentificationDocumentTypeOperationFilterInput,
  "documentNumber": StringOperationFilterInput,
  "issuingCountry": StringOperationFilterInput,
  "firstName": StringOperationFilterInput,
  "lastName": StringOperationFilterInput,
  "givenNames": StringOperationFilterInput,
  "surnameAndGivenNames": StringOperationFilterInput,
  "nationality": StringOperationFilterInput,
  "dateOfBirth": portfolio_DateTimeOperationFilterInput,
  "dateOfExpiry": portfolio_DateTimeOperationFilterInput,
  "dateOfIssue": portfolio_DateTimeOperationFilterInput,
  "licenseClass": StringOperationFilterInput,
  "sex": IdentificationDocumentSexTypeOperationFilterInput,
  "checkResult": CheckResultFilterInput,
  "images": ListFilterInputTypeOfIdentificationDocumentImageFilterInput,
  "edits": ListFilterInputTypeOfIdentificationDocumentEditFilterInput,
  "biometrics": IdentificationDocumentBiometricsFilterInput,
  "deviceDetails": IdentificationDeviceDetailsFilterInput,
  "isSuccess": BooleanOperationFilterInput,
  "fuzzyNameScore": IntOperationFilterInput,
  "result": CheckResultTypeOperationFilterInput,
  "verificationId": StringOperationFilterInput,
  "mrz": StringOperationFilterInput,
  "integrityCheckResult": IdentificationDocumentIntegrityOperationFilterInput
}
Types

IdentificationDocumentImage

Description

Identification document image

Fields
Field Name Description
imageType - IdentificationDocumentImageType! Type of image
content - String Encoded image
contentType - String Content type of image (jpeg, png, etc)
Example
{
  "imageType": "CROPPED_FRONT_IMAGE",
  "content": "xyz789",
  "contentType": "abc123"
}
Types

IdentificationDocumentImageFilterInput

Fields
Input Field Description
and - [IdentificationDocumentImageFilterInput!]
or - [IdentificationDocumentImageFilterInput!]
id - IntOperationFilterInput
checkResultId - IntOperationFilterInput
imageType - IdentificationDocumentImageTypeOperationFilterInput
identificationDocument - IdentificationDocumentFilterInput
contentType - StringOperationFilterInput
content - StringOperationFilterInput
Example
{
  "and": [IdentificationDocumentImageFilterInput],
  "or": [IdentificationDocumentImageFilterInput],
  "id": IntOperationFilterInput,
  "checkResultId": IntOperationFilterInput,
  "imageType": IdentificationDocumentImageTypeOperationFilterInput,
  "identificationDocument": IdentificationDocumentFilterInput,
  "contentType": StringOperationFilterInput,
  "content": StringOperationFilterInput
}
Types

IdentificationDocumentImageType

Values
Enum Value Description

CROPPED_FRONT_IMAGE

CROPPED_BACK_IMAGE

FACE_IMAGE

LIVENESS_FACE_IMAGE
Example
"CROPPED_FRONT_IMAGE"
Types

IdentificationDocumentImageTypeOperationFilterInput

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

IdentificationDocumentIntegrity

Values
Enum Value Description

CONSIDER

FAIL

PASS
Example
"CONSIDER"
Types

IdentificationDocumentIntegrityOperationFilterInput

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

IdentificationDocumentSearchType

Fields
Field Name Description
id - Int! AML Check Result Unique ID
fuzzyNameScore - Int! Fuzzy name score against the name specified
result - CheckResultType! Result based on name scoring
isSuccess - Boolean! Result of identification check
Example
{"id": 123, "fuzzyNameScore": 123, "result": "AWAITING", "isSuccess": true}
Types

IdentificationDocumentSexType

Values
Enum Value Description

FEMALE

MALE

UNSPECIFIED
Example
"FEMALE"
Types

IdentificationDocumentSexTypeOperationFilterInput

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

IdentificationDocumentSortInput

Fields
Input Field Description
checkResultId - SortEnumType
documentType - SortEnumType
documentNumber - SortEnumType
issuingCountry - SortEnumType
firstName - SortEnumType
lastName - SortEnumType
givenNames - SortEnumType
surnameAndGivenNames - SortEnumType
nationality - SortEnumType
dateOfBirth - SortEnumType
dateOfExpiry - SortEnumType
dateOfIssue - SortEnumType
licenseClass - SortEnumType
sex - SortEnumType
checkResult - CheckResultSortInput
biometrics - IdentificationDocumentBiometricsSortInput
deviceDetails - IdentificationDeviceDetailsSortInput
isSuccess - SortEnumType
fuzzyNameScore - SortEnumType
result - SortEnumType
verificationId - SortEnumType
mrz - SortEnumType
integrityCheckResult - SortEnumType
Example
{
  "checkResultId": "ASC",
  "documentType": "ASC",
  "documentNumber": "ASC",
  "issuingCountry": "ASC",
  "firstName": "ASC",
  "lastName": "ASC",
  "givenNames": "ASC",
  "surnameAndGivenNames": "ASC",
  "nationality": "ASC",
  "dateOfBirth": "ASC",
  "dateOfExpiry": "ASC",
  "dateOfIssue": "ASC",
  "licenseClass": "ASC",
  "sex": "ASC",
  "checkResult": CheckResultSortInput,
  "biometrics": IdentificationDocumentBiometricsSortInput,
  "deviceDetails": IdentificationDeviceDetailsSortInput,
  "isSuccess": "ASC",
  "fuzzyNameScore": "ASC",
  "result": "ASC",
  "verificationId": "ASC",
  "mrz": "ASC",
  "integrityCheckResult": "ASC"
}
Types

IdentificationDocumentType

Values
Enum Value Description

DRIVING_LICENSE

PASSPORT

NATIONAL_ID

ID_CARD

UNKNOWN
Example
"DRIVING_LICENSE"
Types

IdentificationDocumentTypeOperationFilterInput

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

IdentificationProvider

Fields
Field Name Description
id - IdentificationProviderId! Provider Id
providerName - String
amlResults - [AmlResult]
checkDescriptions - [CheckDescription]
Example
{
  "id": "AUTHENTEQ",
  "providerName": "abc123",
  "amlResults": [AmlResult],
  "checkDescriptions": [CheckDescription]
}
Types

IdentificationProviderFilterInput

Fields
Input Field Description
and - [IdentificationProviderFilterInput!]
or - [IdentificationProviderFilterInput!]
providerId - IdentificationProviderIdOperationFilterInput
providerName - StringOperationFilterInput
amlResults - ListFilterInputTypeOfAmlResultFilterInput
checkDescriptions - ListFilterInputTypeOfCheckDescriptionFilterInput
Example
{
  "and": [IdentificationProviderFilterInput],
  "or": [IdentificationProviderFilterInput],
  "providerId": IdentificationProviderIdOperationFilterInput,
  "providerName": StringOperationFilterInput,
  "amlResults": ListFilterInputTypeOfAmlResultFilterInput,
  "checkDescriptions": ListFilterInputTypeOfCheckDescriptionFilterInput
}
Types

IdentificationProviderId

Values
Enum Value Description

AUTHENTEQ

COMPLY_ADVANTAGE

GBG

VITAL4
Example
"AUTHENTEQ"
Types

IdentificationProviderIdOperationFilterInput

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

IdentificationProviderSortInput

Fields
Input Field Description
providerId - SortEnumType
providerName - SortEnumType
Example
{"providerId": "ASC", "providerName": "ASC"}
Types

IdvResult

Fields
Field Name Description
result - ResultEnum!
details - IdentificationDocument
Example
{
  "result": "NOT_AVAILABLE",
  "details": IdentificationDocument
}
Types

IdvResultAddress

Description

Address information from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the IDV result address
idvResultId - UUID! ID of the associated IDV result
fullAddress - String Full address string
streetAddress - String Street address line 1
streetAddress2 - String Street address line 2
streetAddress3 - String Street address line 3
city - String City
state - String State or province
postCode - String Postal code
country - String Country
wasValidated - Boolean! Whether this address was validated
line1 - String
line2 - String
line3 - String
line4 - String
buildingName - String
buildingNumber - String
street - String
secondaryStreet - String
postcode - String
idvResult - IdvResultV2!
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fullAddress": "xyz789",
  "streetAddress": "abc123",
  "streetAddress2": "abc123",
  "streetAddress3": "abc123",
  "city": "abc123",
  "state": "abc123",
  "postCode": "xyz789",
  "country": "xyz789",
  "wasValidated": false,
  "line1": "xyz789",
  "line2": "xyz789",
  "line3": "abc123",
  "line4": "xyz789",
  "buildingName": "abc123",
  "buildingNumber": "xyz789",
  "street": "xyz789",
  "secondaryStreet": "abc123",
  "postcode": "xyz789",
  "idvResult": IdvResultV2
}
Types

IdvResultAsfBreakdown

Description

ASF breakdown details for an IDV result document

Fields
Field Name Description
id - UUID! Unique identifier for the ASF breakdown
idvResultDocumentId - UUID ID of the associated IDV result document
photoCheck - String Photo check result
detailCheck - String Detail check result
imageComposition - String Image composition check result
documentIntegrity - String Document integrity check result
idvResultDocument - IdvResultDocument Associated IDV result document
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultDocumentId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "photoCheck": "xyz789",
  "detailCheck": "abc123",
  "imageComposition": "abc123",
  "documentIntegrity": "abc123",
  "idvResultDocument": IdvResultDocument
}
Types

IdvResultDeviceInfo

Description

Device information from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the device info
idvResultId - UUID ID of the associated IDV result
ip - String IP address of the device
os - String Operating system of the device
isp - String Internet service provider
vpn - Boolean Whether VPN was detected
browser - String Browser used for verification
country - String Country of the device
userAgent - String User agent string
geolocation - String Geolocation data
ipLocation - String IP-based location
idvResult - IdvResultV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "ip": "abc123",
  "os": "xyz789",
  "isp": "abc123",
  "vpn": false,
  "browser": "xyz789",
  "country": "xyz789",
  "userAgent": "xyz789",
  "geolocation": "xyz789",
  "ipLocation": "abc123",
  "idvResult": IdvResultV2
}
Types

IdvResultDocument

Description

Document information from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the document
idvResultId - UUID ID of the associated IDV result
documentIndex - Int Index of the document
documentId - String Document ID
identityDocumentType - String Type of identity document
fullName - String Full name from document
firstName - String First name from document
lastName - String Last name from document
middleName - String Middle name from document
givenName - String Given name from document
gender - String Gender from document
birthDate - DateTime Date of birth from document
birthPlace - String Place of birth from document
age - Int Age from document
ageAtIssue - Int Age at issue from document
idNumber - String ID number from document
issuingCountry - String Issuing country from document
issueDate - DateTime Date when document was issued
expiryDate - DateTime Date when document expires
createdAt - DateTime When the document record was created
updatedAt - DateTime When the document record was last updated
idvResultPhotos - [IdvResultPhoto] Photos associated with this document
idvResultAsfBreakdowns - [IdvResultAsfBreakdown] ASF breakdown details for this document
idvResult - IdvResultV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "documentIndex": 987,
  "documentId": "xyz789",
  "identityDocumentType": "abc123",
  "fullName": "xyz789",
  "firstName": "abc123",
  "lastName": "xyz789",
  "middleName": "abc123",
  "givenName": "abc123",
  "gender": "xyz789",
  "birthDate": "2007-12-03T10:15:30Z",
  "birthPlace": "xyz789",
  "age": 987,
  "ageAtIssue": 123,
  "idNumber": "abc123",
  "issuingCountry": "xyz789",
  "issueDate": "2007-12-03T10:15:30Z",
  "expiryDate": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "idvResultPhotos": [IdvResultPhoto],
  "idvResultAsfBreakdowns": [IdvResultAsfBreakdown],
  "idvResult": IdvResultV2
}
Types

IdvResultFaceVerification

Description

Face verification result from IDV

Fields
Field Name Description
id - UUID! Unique identifier for the face verification
idvResultId - UUID ID of the associated IDV result
faceDetected - Boolean Whether a face was detected
livenessScore - Float Liveness detection score
faceMatchScore - Float Face matching score
facematchBestFrameFileId - UUID File ID of the best frame for face matching
facematchBestFrameFile - File File containing the best frame for face matching
idvResult - IdvResultV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "faceDetected": true,
  "livenessScore": 987.65,
  "faceMatchScore": 987.65,
  "facematchBestFrameFileId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "facematchBestFrameFile": File,
  "idvResult": IdvResultV2
}
Types

IdvResultLikenessFeatures

Description

Likeness features from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the likeness features
idvResultId - UUID ID of the associated IDV result
jaw - String Jaw feature data
nose - String Nose feature data
mouth - String Mouth feature data
forehead - String Forehead feature data
leftEye - String Left eye feature data
rightEye - String Right eye feature data
leftBrow - String Left brow feature data
rightBrow - String Right brow feature data
leftCheek - String Left cheek feature data
rightCheek - String Right cheek feature data
philtrum - String Philtrum feature data
middleForehead - String Middle forehead feature data
idvResult - IdvResultV2 Associated IDV result
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "jaw": "xyz789",
  "nose": "abc123",
  "mouth": "xyz789",
  "forehead": "abc123",
  "leftEye": "abc123",
  "rightEye": "xyz789",
  "leftBrow": "xyz789",
  "rightBrow": "abc123",
  "leftCheek": "xyz789",
  "rightCheek": "xyz789",
  "philtrum": "xyz789",
  "middleForehead": "abc123",
  "idvResult": IdvResultV2
}
Types

IdvResultLivenessAction

Description

Liveness action for an IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the liveness action
livenessAttemptId - UUID ID of the associated liveness attempt
action - String Action performed during liveness detection
livenessAttempt - IdvResultLivenessAttempt
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "livenessAttemptId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "action": "abc123",
  "livenessAttempt": IdvResultLivenessAttempt
}
Types

IdvResultLivenessAttempt

Description

Liveness detection attempt from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the liveness attempt
idvResultId - UUID ID of the associated IDV result
sessionId - UUID Session ID for this liveness attempt
result - Boolean Result of the liveness attempt
idvResultLivenessVideos - [IdvResultLivenessVideo] Videos associated with this liveness attempt
idvResultLivenessActions - [IdvResultLivenessAction] Actions performed during this liveness attempt
bestFrameFileId - UUID
idvResult - IdvResultV2
bestFrameFile - File
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "sessionId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "result": false,
  "idvResultLivenessVideos": [IdvResultLivenessVideo],
  "idvResultLivenessActions": [IdvResultLivenessAction],
  "bestFrameFileId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResult": IdvResultV2,
  "bestFrameFile": File
}
Types

IdvResultLivenessVideo

Description

Liveness video for an IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the liveness video
livenessAttemptId - UUID ID of the associated liveness attempt
fileId - UUID ID of the associated file
livenessAttempt - IdvResultLivenessAttempt Associated liveness attempt
file - File Associated file
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "livenessAttemptId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fileId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "livenessAttempt": IdvResultLivenessAttempt,
  "file": File
}
Types

IdvResultPhoto

Description

Photo associated with an IDV result document

Fields
Field Name Description
id - UUID! Unique identifier for the photo
idvResultDocumentId - UUID ID of the associated IDV result document
type - String Type of photo
fileId - UUID ID of the associated file
idvResultDocument - IdvResultDocument Associated IDV result document
file - File Associated file
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultDocumentId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "type": "xyz789",
  "fileId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultDocument": IdvResultDocument,
  "file": File
}
Types

IdvResultStatistics

Description

Statistics from IDV result

Fields
Field Name Description
id - UUID! Unique identifier for the statistics
idvResultId - UUID ID of the associated IDV result
totalDurationSeconds - Float Total duration in seconds
totalDurationExclPrivacySeconds - Float Total duration excluding privacy time in seconds
idvResult - IdvResultV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "idvResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "totalDurationSeconds": 123.45,
  "totalDurationExclPrivacySeconds": 123.45,
  "idvResult": IdvResultV2
}
Types

IdvResultV2

Description

An IDV result in the v2 system

Fields
Field Name Description
id - UUID! Unique IDV result identifier
checkId - UUID Associated check identifier
transactionId - String Vendor transaction identifier
status - String Verification status
overallResult - String Overall verification result
documentsResult - String Document verification result
facematchResult - String Face match verification result
livenessResult - String Liveness verification result
spoofResult - String Spoof detection result
documentOnly - Boolean Whether this is document-only verification
flowType - String Verification flow type
defaultLanguage - String Default language for verification
currentStep - String Current verification step
nationality - String Person's nationality
reference - String Reference string
expiresAt - DateTime When the verification expires
closedAt - DateTime When the verification was closed
createdAt - DateTime When the verification was created
updatedAt - DateTime When the verification was last updated
activatedAt - DateTime When the verification was activated
webhookTimestamp - DateTime Webhook timestamp
likenessOverall - String Overall likeness score
verificationScore - Float Verification confidence score
rawResponse - String Raw vendor response (JSON)
vendor - String Vendor used for IDV check
check - CheckV2 Associated check
idvResultAddresses - [IdvResultAddress] Addresses from IDV result
idvResultDeviceInfos - [IdvResultDeviceInfo] Device information from IDV
idvResultDocuments - [IdvResultDocument] Documents from IDV result
idvResultFaceVerifications - [IdvResultFaceVerification] Face verification results
idvResultLikenessFeatures - [IdvResultLikenessFeatures] Likeness features
idvResultLivenessAttempts - [IdvResultLivenessAttempt] Liveness detection attempts
idvResultStatistics - [IdvResultStatistics] IDV statistics
jurisdiction - String
sessionUrl - String
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "transactionId": "abc123",
  "status": "xyz789",
  "overallResult": "xyz789",
  "documentsResult": "xyz789",
  "facematchResult": "abc123",
  "livenessResult": "xyz789",
  "spoofResult": "abc123",
  "documentOnly": false,
  "flowType": "abc123",
  "defaultLanguage": "xyz789",
  "currentStep": "xyz789",
  "nationality": "abc123",
  "reference": "abc123",
  "expiresAt": "2007-12-03T10:15:30Z",
  "closedAt": "2007-12-03T10:15:30Z",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "activatedAt": "2007-12-03T10:15:30Z",
  "webhookTimestamp": "2007-12-03T10:15:30Z",
  "likenessOverall": "abc123",
  "verificationScore": 123.45,
  "rawResponse": "abc123",
  "vendor": "xyz789",
  "check": CheckV2,
  "idvResultAddresses": [IdvResultAddress],
  "idvResultDeviceInfos": [IdvResultDeviceInfo],
  "idvResultDocuments": [IdvResultDocument],
  "idvResultFaceVerifications": [
    IdvResultFaceVerification
  ],
  "idvResultLikenessFeatures": [
    IdvResultLikenessFeatures
  ],
  "idvResultLivenessAttempts": [IdvResultLivenessAttempt],
  "idvResultStatistics": [IdvResultStatistics],
  "jurisdiction": "abc123",
  "sessionUrl": "xyz789"
}
Types

IndustryCode

Fields
Field Name Description
code - String
description - String
typeDescription - String
isPrimary - Boolean!
Example
{
  "code": "xyz789",
  "description": "abc123",
  "typeDescription": "abc123",
  "isPrimary": false
}
Types

InsolvencyPerson

Fields
Field Name Description
url - String Link into Insolvency Register
court - String
type - String
caseno - String
number - String
start_date - Date
initial_letter - String
Example
{
  "url": "abc123",
  "court": "abc123",
  "type": "abc123",
  "caseno": "abc123",
  "number": "abc123",
  "start_date": "2007-12-03",
  "initial_letter": "xyz789"
}
Types

InsolvencyPersonFilterInput

Fields
Input Field Description
and - [InsolvencyPersonFilterInput!]
or - [InsolvencyPersonFilterInput!]
initial_letter - StringOperationFilterInput
url - StringOperationFilterInput
court - StringOperationFilterInput
type - StringOperationFilterInput
caseno - StringOperationFilterInput
number - StringOperationFilterInput
start_date - DateTimeOperationFilterInput
Example
{
  "and": [InsolvencyPersonFilterInput],
  "or": [InsolvencyPersonFilterInput],
  "initial_letter": StringOperationFilterInput,
  "url": StringOperationFilterInput,
  "court": StringOperationFilterInput,
  "type": StringOperationFilterInput,
  "caseno": StringOperationFilterInput,
  "number": StringOperationFilterInput,
  "start_date": DateTimeOperationFilterInput
}
Types

InsolvencyPersonSortInput

Fields
Input Field Description
initial_letter - SortEnumType
url - SortEnumType
court - SortEnumType
type - SortEnumType
caseno - SortEnumType
number - SortEnumType
start_date - SortEnumType
Example
{
  "initial_letter": "ASC",
  "url": "ASC",
  "court": "ASC",
  "type": "ASC",
  "caseno": "ASC",
  "number": "ASC",
  "start_date": "ASC"
}
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
123
Types

IntOperationFilterInput

Fields
Input Field Description
eq - Int
neq - Int
in - [Int]
nin - [Int]
gt - Int
ngt - Int
gte - Int
ngte - Int
lt - Int
nlt - Int
lte - Int
nlte - Int
Example
{
  "eq": 123,
  "neq": 987,
  "in": [123],
  "nin": [123],
  "gt": 123,
  "ngt": 987,
  "gte": 123,
  "ngte": 123,
  "lt": 123,
  "nlt": 123,
  "lte": 123,
  "nlte": 123
}
Types

InternationalCompany

Fields
Field Name Description
id - Int!
company_id - String
company_name - String
country_code - CountryCode
company_number - String
company_type - String
generated_rfa_rating - RfaRating
lastUpdatedAt - DateTime
companyDetails - CompanyDetails
companyStatus - CompanyStatus
financials - CompanyFinancials
organizationalStructure - OrganisationalStructure
paydex - Paydex
archive_id - String
archive - [CompanyArchive]
history - [History]
compliance - AmlResult
Example
{
  "id": 987,
  "company_id": "xyz789",
  "company_name": "xyz789",
  "country_code": "AFG",
  "company_number": "abc123",
  "company_type": "xyz789",
  "generated_rfa_rating": "THREE_RED_FLAGS",
  "lastUpdatedAt": "2007-12-03T10:15:30Z",
  "companyDetails": CompanyDetails,
  "companyStatus": CompanyStatus,
  "financials": CompanyFinancials,
  "organizationalStructure": OrganisationalStructure,
  "paydex": Paydex,
  "archive_id": "xyz789",
  "archive": [CompanyArchive],
  "history": [History],
  "compliance": AmlResult
}
Types

InvestigationRequestInput

Fields
Input Field Description
isExistingCustomer - Boolean! Is the requester an existing customer?
customerNumber - String The customer number the requester has with the business
customerSince - String How long the requester has been a customer of the business
customerName - String! Customer Company Name
customerEmail - String! Customer Delivery Email Address
tradeSupplierName - String! Trade Supplier Name
permissionToDiscloseSupplier - Boolean! Permission to disclose the name of the supplier
creditRequired - String The amount of credit required
companyNumber - String Company Registration Number
companyName - String Company Registered Name
proprietorName - String Proprietor/Partner name
tradingName - String! The name the owner/business trades as
incorporationDate - String Incorporation Date
addressLine1 - String! Address line 1
addressLine2 - String Address line 2
addressLine3 - String Address line 3
town - String Town or City
postcode - String! Postcode
email - String Business Email
telephoneNumber - String! Business Telephone number
requestedBy - String! Name of the requester
comments - String Comments
Example
{
  "isExistingCustomer": true,
  "customerNumber": "xyz789",
  "customerSince": "abc123",
  "customerName": "abc123",
  "customerEmail": "abc123",
  "tradeSupplierName": "xyz789",
  "permissionToDiscloseSupplier": true,
  "creditRequired": "abc123",
  "companyNumber": "abc123",
  "companyName": "abc123",
  "proprietorName": "abc123",
  "tradingName": "abc123",
  "incorporationDate": "xyz789",
  "addressLine1": "xyz789",
  "addressLine2": "xyz789",
  "addressLine3": "xyz789",
  "town": "abc123",
  "postcode": "abc123",
  "email": "abc123",
  "telephoneNumber": "abc123",
  "requestedBy": "xyz789",
  "comments": "xyz789"
}
Types

InvestigationRequestSubmitResult

Fields
Field Name Description
success - Boolean!
message - String
Example
{"success": true, "message": "xyz789"}
Types

Latest_Action

Fields
Field Name Description
action - String
date - DateTime!
Example
{
  "action": "abc123",
  "date": "2007-12-03T10:15:30Z"
}
Types

Latest_ActionFilterInput

Fields
Input Field Description
and - [Latest_ActionFilterInput!]
or - [Latest_ActionFilterInput!]
action - StringOperationFilterInput
date - DateTimeOperationFilterInput
Example
{
  "and": [Latest_ActionFilterInput],
  "or": [Latest_ActionFilterInput],
  "action": StringOperationFilterInput,
  "date": DateTimeOperationFilterInput
}
Types

Latest_ActionSortInput

Fields
Input Field Description
action - SortEnumType
date - SortEnumType
Example
{"action": "ASC", "date": "ASC"}
Types

LegalEventSummary

Fields
Field Name Description
count - Int!
latestFiling - DateTime
Example
{
  "count": 123,
  "latestFiling": "2007-12-03T10:15:30Z"
}
Types

LinkedAddressRelatedData

Fields
Field Name Description
linkedAddressType - String!
nameMatchedAddress - NameAddressMatch
matchedAddress - SubjectAddress
electoralRollRegistrations - [ElectoralRollData!]!
rollingRegisterRecords - [RollingRegisterRecord!]!
courtRecords - [CourtRecord!]!
previousCreditSearches - [CreditSearchRecord!]!
previousNonCreditSearches - [PreviousSearchRecord!]!
accountsData - AccountsData
noticeOfCorrectionOrDisputes - [NoticeOfCorrectionOrDispute!]!
Example
{
  "linkedAddressType": "abc123",
  "nameMatchedAddress": NameAddressMatch,
  "matchedAddress": SubjectAddress,
  "electoralRollRegistrations": [ElectoralRollData],
  "rollingRegisterRecords": [RollingRegisterRecord],
  "courtRecords": [CourtRecord],
  "previousCreditSearches": [CreditSearchRecord],
  "previousNonCreditSearches": [PreviousSearchRecord],
  "accountsData": AccountsData,
  "noticeOfCorrectionOrDisputes": [
    NoticeOfCorrectionOrDispute
  ]
}
Types

ListAmlMatchTypeOperationFilterInput

Fields
Input Field Description
all - AmlMatchTypeOperationFilterInput
none - AmlMatchTypeOperationFilterInput
some - AmlMatchTypeOperationFilterInput
any - Boolean
Example
{
  "all": AmlMatchTypeOperationFilterInput,
  "none": AmlMatchTypeOperationFilterInput,
  "some": AmlMatchTypeOperationFilterInput,
  "any": false
}
Types

ListAmlTypeOperationFilterInput

Fields
Input Field Description
all - AmlTypeOperationFilterInput
none - AmlTypeOperationFilterInput
some - AmlTypeOperationFilterInput
any - Boolean
Example
{
  "all": AmlTypeOperationFilterInput,
  "none": AmlTypeOperationFilterInput,
  "some": AmlTypeOperationFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAccountFilterInput

Fields
Input Field Description
all - AccountFilterInput
none - AccountFilterInput
some - AccountFilterInput
any - Boolean
Example
{
  "all": AccountFilterInput,
  "none": AccountFilterInput,
  "some": AccountFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAccountTypeWebHookFilterInput

Fields
Input Field Description
all - AccountTypeWebHookFilterInput
none - AccountTypeWebHookFilterInput
some - AccountTypeWebHookFilterInput
any - Boolean
Example
{
  "all": AccountTypeWebHookFilterInput,
  "none": AccountTypeWebHookFilterInput,
  "some": AccountTypeWebHookFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAddressFilterInput

Fields
Input Field Description
all - AddressFilterInput
none - AddressFilterInput
some - AddressFilterInput
any - Boolean
Example
{
  "all": AddressFilterInput,
  "none": AddressFilterInput,
  "some": AddressFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAddressVerificationDetailFilterInput

Fields
Input Field Description
all - AddressVerificationDetailFilterInput
none - AddressVerificationDetailFilterInput
some - AddressVerificationDetailFilterInput
any - Boolean
Example
{
  "all": AddressVerificationDetailFilterInput,
  "none": AddressVerificationDetailFilterInput,
  "some": AddressVerificationDetailFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAddressVerificationItemFilterInput

Fields
Input Field Description
all - AddressVerificationItemFilterInput
none - AddressVerificationItemFilterInput
some - AddressVerificationItemFilterInput
any - Boolean
Example
{
  "all": AddressVerificationItemFilterInput,
  "none": AddressVerificationItemFilterInput,
  "some": AddressVerificationItemFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAmlAddressFilterInput

Fields
Input Field Description
all - AmlAddressFilterInput
none - AmlAddressFilterInput
some - AmlAddressFilterInput
any - Boolean
Example
{
  "all": AmlAddressFilterInput,
  "none": AmlAddressFilterInput,
  "some": AmlAddressFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAmlEntityAssetFilterInput

Fields
Input Field Description
all - AmlEntityAssetFilterInput
none - AmlEntityAssetFilterInput
some - AmlEntityAssetFilterInput
any - Boolean
Example
{
  "all": AmlEntityAssetFilterInput,
  "none": AmlEntityAssetFilterInput,
  "some": AmlEntityAssetFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAmlEntityAssociateFilterInput

Fields
Input Field Description
all - AmlEntityAssociateFilterInput
none - AmlEntityAssociateFilterInput
some - AmlEntityAssociateFilterInput
any - Boolean
Example
{
  "all": AmlEntityAssociateFilterInput,
  "none": AmlEntityAssociateFilterInput,
  "some": AmlEntityAssociateFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAmlEntityMediaFilterInput

Fields
Input Field Description
all - AmlEntityMediaFilterInput
none - AmlEntityMediaFilterInput
some - AmlEntityMediaFilterInput
any - Boolean
Example
{
  "all": AmlEntityMediaFilterInput,
  "none": AmlEntityMediaFilterInput,
  "some": AmlEntityMediaFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAmlMatchFilterInput

Fields
Input Field Description
all - AmlMatchFilterInput
none - AmlMatchFilterInput
some - AmlMatchFilterInput
any - Boolean
Example
{
  "all": AmlMatchFilterInput,
  "none": AmlMatchFilterInput,
  "some": AmlMatchFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAmlMatchTypeDetailFilterInput

Fields
Input Field Description
all - AmlMatchTypeDetailFilterInput
none - AmlMatchTypeDetailFilterInput
some - AmlMatchTypeDetailFilterInput
any - Boolean
Example
{
  "all": AmlMatchTypeDetailFilterInput,
  "none": AmlMatchTypeDetailFilterInput,
  "some": AmlMatchTypeDetailFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAmlPositionFilterInput

Fields
Input Field Description
all - AmlPositionFilterInput
none - AmlPositionFilterInput
some - AmlPositionFilterInput
any - Boolean
Example
{
  "all": AmlPositionFilterInput,
  "none": AmlPositionFilterInput,
  "some": AmlPositionFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAmlResultFilterInput

Fields
Input Field Description
all - AmlResultFilterInput
none - AmlResultFilterInput
some - AmlResultFilterInput
any - Boolean
Example
{
  "all": AmlResultFilterInput,
  "none": AmlResultFilterInput,
  "some": AmlResultFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfAmlSourceNoteFilterInput

Fields
Input Field Description
all - AmlSourceNoteFilterInput
none - AmlSourceNoteFilterInput
some - AmlSourceNoteFilterInput
any - Boolean
Example
{
  "all": AmlSourceNoteFilterInput,
  "none": AmlSourceNoteFilterInput,
  "some": AmlSourceNoteFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfApiRequestFilterInput

Fields
Input Field Description
all - ApiRequestFilterInput
none - ApiRequestFilterInput
some - ApiRequestFilterInput
any - Boolean
Example
{
  "all": ApiRequestFilterInput,
  "none": ApiRequestFilterInput,
  "some": ApiRequestFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfAuditorCommentFilterInput

Fields
Input Field Description
all - AuditorCommentFilterInput
none - AuditorCommentFilterInput
some - AuditorCommentFilterInput
any - Boolean
Example
{
  "all": AuditorCommentFilterInput,
  "none": AuditorCommentFilterInput,
  "some": AuditorCommentFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfBalance_SheetFilterInput

Fields
Input Field Description
all - Balance_SheetFilterInput
none - Balance_SheetFilterInput
some - Balance_SheetFilterInput
any - Boolean
Example
{
  "all": Balance_SheetFilterInput,
  "none": Balance_SheetFilterInput,
  "some": Balance_SheetFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfBeneficialOwnerFilterInput

Fields
Input Field Description
all - BeneficialOwnerFilterInput
none - BeneficialOwnerFilterInput
some - BeneficialOwnerFilterInput
any - Boolean
Example
{
  "all": BeneficialOwnerFilterInput,
  "none": BeneficialOwnerFilterInput,
  "some": BeneficialOwnerFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCCJFilterInput

Fields
Input Field Description
all - CCJFilterInput
none - CCJFilterInput
some - CCJFilterInput
any - Boolean
Example
{
  "all": CCJFilterInput,
  "none": CCJFilterInput,
  "some": CCJFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCashFlowFilterInput

Fields
Input Field Description
all - CashFlowFilterInput
none - CashFlowFilterInput
some - CashFlowFilterInput
any - Boolean
Example
{
  "all": CashFlowFilterInput,
  "none": CashFlowFilterInput,
  "some": CashFlowFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCheckDescriptionFilterInput

Fields
Input Field Description
all - CheckDescriptionFilterInput
none - CheckDescriptionFilterInput
some - CheckDescriptionFilterInput
any - Boolean
Example
{
  "all": CheckDescriptionFilterInput,
  "none": CheckDescriptionFilterInput,
  "some": CheckDescriptionFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCheckDetailAddressFilterInput

Fields
Input Field Description
all - CheckDetailAddressFilterInput
none - CheckDetailAddressFilterInput
some - CheckDetailAddressFilterInput
any - Boolean
Example
{
  "all": CheckDetailAddressFilterInput,
  "none": CheckDetailAddressFilterInput,
  "some": CheckDetailAddressFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCheckDetailIdentityDocumentFilterInput

Fields
Input Field Description
all - CheckDetailIdentityDocumentFilterInput
none - CheckDetailIdentityDocumentFilterInput
some - CheckDetailIdentityDocumentFilterInput
any - Boolean
Example
{
  "all": CheckDetailIdentityDocumentFilterInput,
  "none": CheckDetailIdentityDocumentFilterInput,
  "some": CheckDetailIdentityDocumentFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCheckFilterInput

Fields
Input Field Description
all - CheckFilterInput
none - CheckFilterInput
some - CheckFilterInput
any - Boolean
Example
{
  "all": CheckFilterInput,
  "none": CheckFilterInput,
  "some": CheckFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCheckNotificationFilterInput

Fields
Input Field Description
all - CheckNotificationFilterInput
none - CheckNotificationFilterInput
some - CheckNotificationFilterInput
any - Boolean
Example
{
  "all": CheckNotificationFilterInput,
  "none": CheckNotificationFilterInput,
  "some": CheckNotificationFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCheckStatusFilterInput

Fields
Input Field Description
all - CheckStatusFilterInput
none - CheckStatusFilterInput
some - CheckStatusFilterInput
any - Boolean
Example
{
  "all": CheckStatusFilterInput,
  "none": CheckStatusFilterInput,
  "some": CheckStatusFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCompanyArchiveFilterInput

Fields
Input Field Description
all - CompanyArchiveFilterInput
none - CompanyArchiveFilterInput
some - CompanyArchiveFilterInput
any - Boolean
Example
{
  "all": CompanyArchiveFilterInput,
  "none": CompanyArchiveFilterInput,
  "some": CompanyArchiveFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCompanyBeneficiaryFilterInput

Fields
Input Field Description
all - CompanyBeneficiaryFilterInput
none - CompanyBeneficiaryFilterInput
some - CompanyBeneficiaryFilterInput
any - Boolean
Example
{
  "all": CompanyBeneficiaryFilterInput,
  "none": CompanyBeneficiaryFilterInput,
  "some": CompanyBeneficiaryFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCompanyBeneficiaryRelationshipFilterInput

Fields
Input Field Description
all - CompanyBeneficiaryRelationshipFilterInput
none - CompanyBeneficiaryRelationshipFilterInput
some - CompanyBeneficiaryRelationshipFilterInput
any - Boolean
Example
{
  "all": CompanyBeneficiaryRelationshipFilterInput,
  "none": CompanyBeneficiaryRelationshipFilterInput,
  "some": CompanyBeneficiaryRelationshipFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCompanyPortfolioFilterInput

Fields
Input Field Description
all - CompanyPortfolioFilterInput
none - CompanyPortfolioFilterInput
some - CompanyPortfolioFilterInput
any - Boolean
Example
{
  "all": CompanyPortfolioFilterInput,
  "none": CompanyPortfolioFilterInput,
  "some": CompanyPortfolioFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfContactFilterInput

Fields
Input Field Description
all - ContactFilterInput
none - ContactFilterInput
some - ContactFilterInput
any - Boolean
Example
{
  "all": ContactFilterInput,
  "none": ContactFilterInput,
  "some": ContactFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCorporateEntityFilterInput

Fields
Input Field Description
all - CorporateEntityFilterInput
none - CorporateEntityFilterInput
some - CorporateEntityFilterInput
any - Boolean
Example
{
  "all": CorporateEntityFilterInput,
  "none": CorporateEntityFilterInput,
  "some": CorporateEntityFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCreditLimitFilterInput

Fields
Input Field Description
all - CreditLimitFilterInput
none - CreditLimitFilterInput
some - CreditLimitFilterInput
any - Boolean
Example
{
  "all": CreditLimitFilterInput,
  "none": CreditLimitFilterInput,
  "some": CreditLimitFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfCreditorFilterInput

Fields
Input Field Description
all - CreditorFilterInput
none - CreditorFilterInput
some - CreditorFilterInput
any - Boolean
Example
{
  "all": CreditorFilterInput,
  "none": CreditorFilterInput,
  "some": CreditorFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfCurrent_DirectorsFilterInput

Fields
Input Field Description
all - Current_DirectorsFilterInput
none - Current_DirectorsFilterInput
some - Current_DirectorsFilterInput
any - Boolean
Example
{
  "all": Current_DirectorsFilterInput,
  "none": Current_DirectorsFilterInput,
  "some": Current_DirectorsFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfDebtorFilterInput

Fields
Input Field Description
all - DebtorFilterInput
none - DebtorFilterInput
some - DebtorFilterInput
any - Boolean
Example
{
  "all": DebtorFilterInput,
  "none": DebtorFilterInput,
  "some": DebtorFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfDetrimentalDataFilterInput

Fields
Input Field Description
all - DetrimentalDataFilterInput
none - DetrimentalDataFilterInput
some - DetrimentalDataFilterInput
any - Boolean
Example
{
  "all": DetrimentalDataFilterInput,
  "none": DetrimentalDataFilterInput,
  "some": DetrimentalDataFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfDirectorFilterInput

Fields
Input Field Description
all - DirectorFilterInput
none - DirectorFilterInput
some - DirectorFilterInput
any - Boolean
Example
{
  "all": DirectorFilterInput,
  "none": DirectorFilterInput,
  "some": DirectorFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfDirectorPartialFilterInput

Fields
Input Field Description
all - DirectorPartialFilterInput
none - DirectorPartialFilterInput
some - DirectorPartialFilterInput
any - Boolean
Example
{
  "all": DirectorPartialFilterInput,
  "none": DirectorPartialFilterInput,
  "some": DirectorPartialFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfFormerNameFilterInput

Fields
Input Field Description
all - FormerNameFilterInput
none - FormerNameFilterInput
some - FormerNameFilterInput
any - Boolean
Example
{
  "all": FormerNameFilterInput,
  "none": FormerNameFilterInput,
  "some": FormerNameFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfGazetteNoticeFilterInput

Fields
Input Field Description
all - GazetteNoticeFilterInput
none - GazetteNoticeFilterInput
some - GazetteNoticeFilterInput
any - Boolean
Example
{
  "all": GazetteNoticeFilterInput,
  "none": GazetteNoticeFilterInput,
  "some": GazetteNoticeFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfGbgProfileConfigurationFilterInput

Fields
Input Field Description
all - GbgProfileConfigurationFilterInput
none - GbgProfileConfigurationFilterInput
some - GbgProfileConfigurationFilterInput
any - Boolean
Example
{
  "all": GbgProfileConfigurationFilterInput,
  "none": GbgProfileConfigurationFilterInput,
  "some": GbgProfileConfigurationFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfHistoryFilterInput

Fields
Input Field Description
all - HistoryFilterInput
none - HistoryFilterInput
some - HistoryFilterInput
any - Boolean
Example
{
  "all": HistoryFilterInput,
  "none": HistoryFilterInput,
  "some": HistoryFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfIdentificationDocumentEditFilterInput

Fields
Input Field Description
all - IdentificationDocumentEditFilterInput
none - IdentificationDocumentEditFilterInput
some - IdentificationDocumentEditFilterInput
any - Boolean
Example
{
  "all": IdentificationDocumentEditFilterInput,
  "none": IdentificationDocumentEditFilterInput,
  "some": IdentificationDocumentEditFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfIdentificationDocumentImageFilterInput

Fields
Input Field Description
all - IdentificationDocumentImageFilterInput
none - IdentificationDocumentImageFilterInput
some - IdentificationDocumentImageFilterInput
any - Boolean
Example
{
  "all": IdentificationDocumentImageFilterInput,
  "none": IdentificationDocumentImageFilterInput,
  "some": IdentificationDocumentImageFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfLivenessBreakdownItemFilterInput

Fields
Input Field Description
all - LivenessBreakdownItemFilterInput
none - LivenessBreakdownItemFilterInput
some - LivenessBreakdownItemFilterInput
any - Boolean
Example
{
  "all": LivenessBreakdownItemFilterInput,
  "none": LivenessBreakdownItemFilterInput,
  "some": LivenessBreakdownItemFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfMortgageFilterInput

Fields
Input Field Description
all - MortgageFilterInput
none - MortgageFilterInput
some - MortgageFilterInput
any - Boolean
Example
{
  "all": MortgageFilterInput,
  "none": MortgageFilterInput,
  "some": MortgageFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfNoteFilterInput

Fields
Input Field Description
all - NoteFilterInput
none - NoteFilterInput
some - NoteFilterInput
any - Boolean
Example
{
  "all": NoteFilterInput,
  "none": NoteFilterInput,
  "some": NoteFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfNotificationFilterInput

Fields
Input Field Description
all - NotificationFilterInput
none - NotificationFilterInput
some - NotificationFilterInput
any - Boolean
Example
{
  "all": NotificationFilterInput,
  "none": NotificationFilterInput,
  "some": NotificationFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfNotificationHistoryFilterInput

Fields
Input Field Description
all - NotificationHistoryFilterInput
none - NotificationHistoryFilterInput
some - NotificationHistoryFilterInput
any - Boolean
Example
{
  "all": NotificationHistoryFilterInput,
  "none": NotificationHistoryFilterInput,
  "some": NotificationHistoryFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfPOSCFilterInput

Fields
Input Field Description
all - POSCFilterInput
none - POSCFilterInput
some - POSCFilterInput
any - Boolean
Example
{
  "all": POSCFilterInput,
  "none": POSCFilterInput,
  "some": POSCFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfPersonFilterInput

Fields
Input Field Description
all - PersonFilterInput
none - PersonFilterInput
some - PersonFilterInput
any - Boolean
Example
{
  "all": PersonFilterInput,
  "none": PersonFilterInput,
  "some": PersonFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfPortfolioEventFilterInput

Fields
Input Field Description
all - PortfolioEventFilterInput
none - PortfolioEventFilterInput
some - PortfolioEventFilterInput
any - Boolean
Example
{
  "all": PortfolioEventFilterInput,
  "none": PortfolioEventFilterInput,
  "some": PortfolioEventFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfPortfolioRecipientsFilterInput

Fields
Input Field Description
all - PortfolioRecipientsFilterInput
none - PortfolioRecipientsFilterInput
some - PortfolioRecipientsFilterInput
any - Boolean
Example
{
  "all": PortfolioRecipientsFilterInput,
  "none": PortfolioRecipientsFilterInput,
  "some": PortfolioRecipientsFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfProfit_LossFilterInput

Fields
Input Field Description
all - Profit_LossFilterInput
none - Profit_LossFilterInput
some - Profit_LossFilterInput
any - Boolean
Example
{
  "all": Profit_LossFilterInput,
  "none": Profit_LossFilterInput,
  "some": Profit_LossFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfRatioAnalysisFilterInput

Fields
Input Field Description
all - RatioAnalysisFilterInput
none - RatioAnalysisFilterInput
some - RatioAnalysisFilterInput
any - Boolean
Example
{
  "all": RatioAnalysisFilterInput,
  "none": RatioAnalysisFilterInput,
  "some": RatioAnalysisFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfSIC07FilterInput

Fields
Input Field Description
all - SIC07FilterInput
none - SIC07FilterInput
some - SIC07FilterInput
any - Boolean
Example
{
  "all": SIC07FilterInput,
  "none": SIC07FilterInput,
  "some": SIC07FilterInput,
  "any": false
}
Types

ListFilterInputTypeOfShareholderFilterInput

Fields
Input Field Description
all - ShareholderFilterInput
none - ShareholderFilterInput
some - ShareholderFilterInput
any - Boolean
Example
{
  "all": ShareholderFilterInput,
  "none": ShareholderFilterInput,
  "some": ShareholderFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfTriggerEventFilterInput

Fields
Input Field Description
all - TriggerEventFilterInput
none - TriggerEventFilterInput
some - TriggerEventFilterInput
any - Boolean
Example
{
  "all": TriggerEventFilterInput,
  "none": TriggerEventFilterInput,
  "some": TriggerEventFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfUserFilterInput

Fields
Input Field Description
all - UserFilterInput
none - UserFilterInput
some - UserFilterInput
any - Boolean
Example
{
  "all": UserFilterInput,
  "none": UserFilterInput,
  "some": UserFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfUserRoleFilterInput

Fields
Input Field Description
all - UserRoleFilterInput
none - UserRoleFilterInput
some - UserRoleFilterInput
any - Boolean
Example
{
  "all": UserRoleFilterInput,
  "none": UserRoleFilterInput,
  "some": UserRoleFilterInput,
  "any": true
}
Types

ListFilterInputTypeOfVerificationFilterInput

Fields
Input Field Description
all - VerificationFilterInput
none - VerificationFilterInput
some - VerificationFilterInput
any - Boolean
Example
{
  "all": VerificationFilterInput,
  "none": VerificationFilterInput,
  "some": VerificationFilterInput,
  "any": false
}
Types

ListFilterInputTypeOfWebHookFilterInput

Fields
Input Field Description
all - WebHookFilterInput
none - WebHookFilterInput
some - WebHookFilterInput
any - Boolean
Example
{
  "all": WebHookFilterInput,
  "none": WebHookFilterInput,
  "some": WebHookFilterInput,
  "any": true
}
Types

ListStringOperationFilterInput

Fields
Input Field Description
all - StringOperationFilterInput
none - StringOperationFilterInput
some - StringOperationFilterInput
any - Boolean
Example
{
  "all": StringOperationFilterInput,
  "none": StringOperationFilterInput,
  "some": StringOperationFilterInput,
  "any": true
}
Types

LivenessBreakdownItem

Description

Biometric checks breakdown item

Fields
Field Name Description
field - String Biometric check
value - BiometricCheckResultType! Outcome of biometric check
Example
{"field": "abc123", "value": "NOTAVAILABLE"}
Types

LivenessBreakdownItemFilterInput

Fields
Input Field Description
and - [LivenessBreakdownItemFilterInput!]
or - [LivenessBreakdownItemFilterInput!]
id - IntOperationFilterInput
identificationDocumentBiometrics - IdentificationDocumentBiometricsFilterInput
identificationDocumentBiomertricsId - IntOperationFilterInput
field - StringOperationFilterInput
value - BiometricCheckResultTypeOperationFilterInput
Example
{
  "and": [LivenessBreakdownItemFilterInput],
  "or": [LivenessBreakdownItemFilterInput],
  "id": IntOperationFilterInput,
  "identificationDocumentBiometrics": IdentificationDocumentBiometricsFilterInput,
  "identificationDocumentBiomertricsId": IntOperationFilterInput,
  "field": StringOperationFilterInput,
  "value": BiometricCheckResultTypeOperationFilterInput
}
Types

Location

Fields
Field Name Description
lat - Float!
lon - Float!
Example
{"lat": 987.65, "lon": 987.65}
Types

LocationFilterInput

Fields
Input Field Description
and - [LocationFilterInput!]
or - [LocationFilterInput!]
within - LocationInput
Example
{
  "and": [LocationFilterInput],
  "or": [LocationFilterInput],
  "within": LocationInput
}
Types

LocationInput

Fields
Input Field Description
distance - String
longitude - Float!
latitude - Float!
Example
{
  "distance": "xyz789",
  "longitude": 987.65,
  "latitude": 987.65
}
Types

Long

Description

The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example
{}
Types

LongOperationFilterInput

Fields
Input Field Description
eq - Long
neq - Long
in - [Long]
nin - [Long]
gt - Long
ngt - Long
gte - Long
ngte - Long
lt - Long
nlt - Long
lte - Long
nlte - Long
Example
{
  "eq": {},
  "neq": {},
  "in": [{}],
  "nin": [{}],
  "gt": {},
  "ngt": {},
  "gte": {},
  "ngte": {},
  "lt": {},
  "nlt": {},
  "lte": {},
  "nlte": {}
}
Types

MetaInput

Fields
Input Field Description
pdf - PDFMetaInput
Example
{"pdf": PDFMetaInput}
Types

MetricAggregationInput

Fields
Input Field Description
field - CompanyField
aggregationType - MetricAggregationType!
Example
{"field": "DIRECTORS_AGE_YEARS", "aggregationType": "MEDIAN"}
Types

MetricAggregationType

Values
Enum Value Description

MEDIAN

AVERAGE

SUM

MIN

MAX
Example
"MEDIAN"
Types

ModifyPortfolioInput

Fields
Input Field Description
id - Int!
isPrivate - Boolean
name - String
description - String
Example
{
  "id": 987,
  "isPrivate": true,
  "name": "xyz789",
  "description": "abc123"
}
Types

ModifyPortfolioLastEventInput

Fields
Input Field Description
id - Int!
lastNotifiedEvent - Int!
Example
{"id": 123, "lastNotifiedEvent": 123}
Types

Mortgage

Description

Mortgage / debenture data

Fields
Field Name Description
date_created - DateTime
type - String
holder - String
secured_on - String
form_no - String
satisfied - String
details - String
mortgage_id - Long!
mortgage_no - Int!
companies_company_id - Int!
satisfied_date - DateTime
Example
{
  "date_created": "2007-12-03T10:15:30Z",
  "type": "xyz789",
  "holder": "xyz789",
  "secured_on": "abc123",
  "form_no": "abc123",
  "satisfied": "xyz789",
  "details": "xyz789",
  "mortgage_id": {},
  "mortgage_no": 123,
  "companies_company_id": 123,
  "satisfied_date": "2007-12-03T10:15:30Z"
}
Types

MortgageFilterInput

Fields
Input Field Description
and - [MortgageFilterInput!]
or - [MortgageFilterInput!]
date_created - DateTimeOperationFilterInput
type - StringOperationFilterInput
holder - StringOperationFilterInput
secured_on - StringOperationFilterInput
form_no - StringOperationFilterInput
satisfied - StringOperationFilterInput
details - StringOperationFilterInput
mortgage_id - LongOperationFilterInput
mortgage_no - IntOperationFilterInput
companies_company_id - IntOperationFilterInput
satisfied_date - DateTimeOperationFilterInput
Example
{
  "and": [MortgageFilterInput],
  "or": [MortgageFilterInput],
  "date_created": DateTimeOperationFilterInput,
  "type": StringOperationFilterInput,
  "holder": StringOperationFilterInput,
  "secured_on": StringOperationFilterInput,
  "form_no": StringOperationFilterInput,
  "satisfied": StringOperationFilterInput,
  "details": StringOperationFilterInput,
  "mortgage_id": LongOperationFilterInput,
  "mortgage_no": IntOperationFilterInput,
  "companies_company_id": IntOperationFilterInput,
  "satisfied_date": DateTimeOperationFilterInput
}
Types

NameAddressMatch

Fields
Field Name Description
nameMatchedAddress - Boolean!
sourcesWhereNameMatched - [String!]!
Example
{
  "nameMatchedAddress": false,
  "sourcesWhereNameMatched": ["abc123"]
}
Types

NewEventInput

Fields
Input Field Description
companyId - Int
eventId - Event!
Example
{"companyId": 987, "eventId": "NA"}
Types

NewEventPortfolioInfo

Fields
Field Name Description
companyId - Int!
eventId - Event!
eventDate - DateTime!
isImmediate - Boolean!
portfolioId - Int!
notes - String
company - CompanySearch
Example
{
  "companyId": 987,
  "eventId": "NA",
  "eventDate": "2007-12-03T10:15:30Z",
  "isImmediate": true,
  "portfolioId": 987,
  "notes": "xyz789",
  "company": CompanySearch
}
Types

Note

Description

Note for a Check

Fields
Field Name Description
id - Int! Note Id
checkResultId - Int Check Result note is Attached To
user - User User who created the note
created - DateTime Date and Time created
noteText - String The Note
overriddenStatusType - OverriddenStatusType The new Status Type (Pass or Fail) for the record. Optional.
Example
{
  "id": 123,
  "checkResultId": 987,
  "user": User,
  "created": "2007-12-03T10:15:30Z",
  "noteText": "xyz789",
  "overriddenStatusType": "PASS"
}
Types

NoteFilterInput

Fields
Input Field Description
and - [NoteFilterInput!]
or - [NoteFilterInput!]
id - IntOperationFilterInput
checkResultId - IntOperationFilterInput
checkResult - CheckResultFilterInput
userEmail - StringOperationFilterInput
user - UserFilterInput
accountId - StringOperationFilterInput
created - portfolio_DateTimeOperationFilterInput
noteText - StringOperationFilterInput
overriddenStatusType - NullableOfOverriddenStatusTypeOperationFilterInput
Example
{
  "and": [NoteFilterInput],
  "or": [NoteFilterInput],
  "id": IntOperationFilterInput,
  "checkResultId": IntOperationFilterInput,
  "checkResult": CheckResultFilterInput,
  "userEmail": StringOperationFilterInput,
  "user": UserFilterInput,
  "accountId": StringOperationFilterInput,
  "created": portfolio_DateTimeOperationFilterInput,
  "noteText": StringOperationFilterInput,
  "overriddenStatusType": NullableOfOverriddenStatusTypeOperationFilterInput
}
Types

NoteV2

Description

Note associated with a check

Fields
Field Name Description
id - UUID! Unique identifier for the note
checkId - UUID ID of the associated check
title - String Title of the note
content - String Content of the note
userId - UUID User who created the note
userEmail - String Email of the user who created the note
userFirstName - String First name of the user who created the note
createdAt - DateTime When the note was created
updatedAt - DateTime When the note was last updated
check - CheckV2 Associated check
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "title": "xyz789",
  "content": "xyz789",
  "userId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "userEmail": "xyz789",
  "userFirstName": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "check": CheckV2
}
Types

NoticeCodeType

Values
Enum Value Description

UNKNOWN

PROCLAMATIONS

ROYAL_FAMILY_NOTICE_CODE_NO_LONGER_IN_SERVICE

APPOINTMENTS_TO_THE_ROYAL_HOUSEHOLD_NOTICE_CODE_NO_LONGER_IN_SERVICE

LOYAL_ADDRESSES

HONOURS_AND_AWARDS

PRIVY_COUNCIL_OFFICE

CHANGE_OF_NAME_AND_OR_ARMS

CROWN_OFFICE

DUCHY_OF_CORNWALL_OR_DUCHY_OF_LANCASTER

DEPUTY_LIEUTENANT_COMMISSIONS

APPOINTMENT_OF_ROYAL_COMMISSIONS_NOTICE_CODE_NO_LONGER_IN_SERVICE

LORD_CHANCELLOR_S_OFFICE_NOTICE_CODE_NO_LONGER_IN_SERVICE

HEADING_AS_APPROPRIATE

LORD_LIEUTENANTS

HOME_OFFICE

THE_SCOTTISH_EXECUTIVE

CHANCELLOR_OF_THE_EXCHEQUER

WARRANTS_UNDER_THE_ROYAL_SIGN_MANUAL

ORDER_OF_ST_JOHN

IMMIGRATION_AND_ASYLUM

KNIGHTS_BACHELOR

ORDER_OF_THE_BATH

ORDER_OF_SAINT_MICHAEL_AND_SAINT_GEORGE

THE_ROYAL_VICTORIAN_ORDER

BAR_TO_THE_ROYAL_VICTORIAN_MEDAL

ROYAL_VICTORIAN_MEDAL

ORDER_OF_THE_COMPANIONS_OF_HONOUR

ORDER_OF_THE_BRITISH_EMPIRE

BRITISH_EMPIRE_MEDAL

ROYAL_RED_CROSS

QUEEN_S_POLICE_MEDAL

QUEEN_S_FIRE_SERVICE_MEDAL

QUEEN_S_AMBULANCE_SERVICE_MEDAL

QUEEN_S_VOLUNTEER_RESERVES_MEDAL

OVERSEAS_TERRITORIES_POLICE_AND_FIRE_SERVICE_MEDAL

UK_PARLIAMENT

HOUSE_OF_LORDS

SPEAKER_S_NOTICE

LORD_CHANCELLORS_OFFICE_NOTICE_CODE_NO_LONGER_IN_SERVICE

HOUSE_OF_COMMONS

THE_SCOTTISH_PARLIAMENT

NORTHERN_IRELAND_ASSEMBLY

NATIONAL_ASSEMBLY_FOR_WALES

CHURCH_COMMISSIONERS_NOTICE_CODE_NO_LONGER_IN_SERVICE

MARRIAGE_ACTS

CHURCH_OF_SCOTLAND_NOTICE_CODE_NO_LONGER_IN_SERVICE

CHURCH_USE_AND_FABRIC

TREASURY

NATIONAL_SAVINGS

BANK_OF_ENGLAND

BANKS_OF_ISSUE_IN_SCOTLAND

CUSTOMS_AND_EXCISE

BANKERS_NI_ACTS

INSOLVENCY_SERVICE_NOTICE_CODE_NO_LONGER_IN_SERVICE

ROAD_TRAFFIC_ACTS

NEW_ROADS_AND_STREET_WORKS

HIGHWAYS

LONDON_HACKNEY_CARRIAGES

RAILWAYS

TRANSPORT_ACTS

PORTS

CIVIL_AVIATION

CYCLE_TRACKS

ROADS_NI_ORDER

TOWN_AND_COUNTRY_PLANNING

NEW_TOWNS_NOTICE_CODE_NO_LONGER_IN_SERVICE

ACQUISITION_AND_DISPOSAL_OF_LAND

LOCAL_GOVERNMENT_AND_HOUSING_NOTICE_CODE_NO_LONGER_IN_SERVICE

COMMONS_REGISTRATION_NOTICE_CODE_NO_LONGER_IN_SERVICE

OPEN_SPACES_NOTICE_CODE_NO_LONGER_IN_SERVICE

INNER_URBAN_AREAS_NOTICE_CODE_NO_LONGER_IN_SERVICE

PIPE_LINES

ZOO_LICENSING

MEDICINES

OTHER_NOTICES_HEALTH

CORONAVIRUS_POWERS_RELATING_TO_POTENTIALLY_INFECTIOUS_PERSONS

GATHERINGS_AND_PREMISES

CORONAVIRUS_TRANSPORTATION

CORONAVIRUS_EMERGENCY_VOLUNTEER_COMPENSATION

CORONAVIRUS_DISAPPLICATION_OR_MODIFICATION_OF_DBS_PROVISIONS

CORONAVIRUS_REVIEW_OF_MEDICAL_CERTIFICATES_OF_CAUSE_OF_DEATH_AND_CREMATIONS_SCOTLAND

CORONAVIRUS_INFORMATION_RELATING_TO_FOOD_SUPPLY_CHAINS_FINANCIAL_PENALTIES

CORONAVIRUS_TEMPORARY_CLOSURE_OF_EDUCATIONAL_INSTITUTIONS_AND_CHILDCARE_PREMISES

TRAINING_AND_CHILDCARE

CORONAVIRUS_POSTPONEMENT_OF_ELECTIONS_SCOTLAND

CORONAVIRUS_FAILURE_TO_PUBLISH_REPORTS_ON_THE_NON_DEVOLVED_PROVISIONS_OF_CORONAVIRUS_ACT2020

CORONAVIRUS_TEMPORARY_REGISTRATION_OF_SOCIAL_WORKERS_SCOTLAND

CORONAVIRUS_FREEDOM_OF_INFORMATION_EXTENSIONS_SCOTLAND

CORONAVIRUS_REPORTING_OF_STATUTORY_DUTIES_SCOTLAND

CORONAVIRUS_SERIOUS_AND_IMMINENT_THREAT_DECLARATION

CLEAN_AIR

CONTROL_OF_POLLUTION

ENVIRONMENTAL_PROTECTION

COAST_PROTECTION

NATIONAL_PARKS_AND_ACCESS_TO_THE_COUNTRYSIDE

WILDLIFE_AND_COUNTRYSIDE

HARBOURS

FLOOD_PREVENTION

WATER_RESOURCES

WATER_INDUSTRY

LAND_DRAINAGE

NATURAL_MINERAL_WATERS

FISHERIES

VETERINARY_MEDICINES

CORN_RETURNS_NOTICE_CODE_NO_LONGER_IN_SERVICE

ANIMAL_HEALTH

FORESTRY_AND_PLANT_HEALTH

DAIRY_PRODUCE_QUOTAS_REGULATIONS_NOTICE_CODE_NO_LONGER_IN_SERVICE

GAS

COAL

ELECTRICITY

POST_OFFICE

TELECOMMUNICATIONS

ELECTRONIC_COMMUNICATIONS

OTHER_NOTICES

MORATORIUM_COMING_INTO_FORCE

MORATORIUM_COMING_TO_AN_END

RE_USE_OF_A_PROHIBITED_NAME

CROSS_BORDER_INSOLVENCIES

OVERSEAS_TERRITORIES_AND_DEPENDENCIES

NOTICE_OF_INTENDED_DIVIDEND

NOTICE_OF_DIVIDEND

OTHER_CORPORATE_INSOLVENCY_NOTICES

QUALIFYING_DECISION_PROCEDURE

APPOINTMENT_OF_ADMINISTRATORS

ADMINISTRATION_ORDERS

MEETINGS_OF_CREDITORS_ADMINISTRATION

NOTICES_TO_MEMBERS

DEEMED_CONSENT_ADMINISTRATION

APPOINTMENT_OF_ADMINISTRATIVE_RECEIVERS

MEETINGS_OF_CREDITORS_RECEIVERSHIP

APPOINTMENT_OF_RECEIVERS

DEEMED_CONSENT_ADMINISTRATIVE_RECEIVERSHIP

RESOLUTION_FOR_WINDING_UP

APPOINTMENT_OF_LIQUIDATORS

NOTICES_TO_CREDITORS

ANNUAL_LIQUIDATION_MEETINGS

FINAL_MEETINGS_MEMBERS_WINDING_UP

RESOLUTION_FOR_CREDITORS_WINDING_UP

MEETINGS_OF_CREDITORS_WINDING_UP

APPOINTMENT_OF_LIQUIDATORS_CREDITORS_WINDING_UP

ANNUAL_LIQUIDATION_MEETINGS_CREDITORS_WINDING_UP

FINAL_MEETINGS_CREDITORS_WINDING_UP

NOTICE_TO_CREDITORS

DEEMED_CONSENT_CVL

PETITIONS_TO_WIND_UP_COMPANIES

PETITIONS_TO_WIND_UP_PARTNERSHIPS

WINDING_UP_ORDER_COMPANIES

WINDING_UP_ORDER_PARTNERSHIPS

APPOINTMENT_OF_LIQUIDATORS_WINDING_UP_BY_COURT

MEETINGS_OF_CREDITORS

NOTICE_OF_INTENDED_DIVIDEND_WINDING_UP_BY_COURT

NOTICE_OF_DIVIDEND_WINDING_UP_BY_COURT

FINAL_MEETINGS_WINDING_UP_BY_COURT

RELEASE_OF_LIQUIDATOR

NOTICE_TO_CREDITORS_WINDING_UP_BY_COURT

DISMISSAL_OF_WINDING_UP_PETITION

SERVICE_OF_PETITION

ANNUAL_MEETING

PUBLIC_EXAMINATIONS

DEEMED_CONSENT_WINDING_UP_BY_THE_COURT

STATUTORY_DEMANDS

SUBSTITUTED_SERVICE_OF_PETITION

BANKRUPTCY_ORDERS

BANKRUPTCY_ORDERS_PARTNERSHIPS

ADMINISTRATION_ORDERS_PERSONAL_INSOLVENCY

AMENDMENT_OF_TITLE_OF_PROCEEDINGS

APPOINTMENT_OF_TRUSTEES

NOTICES_TO_CREDITORS_PERSONAL_INSOLVENCY

NOTICE_OF_INTENDED_DIVIDEND_PERSONAL_INSOLVENCY

NOTICE_OF_DIVIDEND_PERSONAL_INSOLVENCY

FINAL_MEETINGS_PERSONAL_INSOLVENCY

ANNULMENT_OF_PROCEEDINGS

APPLICATIONS_FOR_DISCHARGE

RELEASE_OF_TRUSTEES

DISCHARGE_ORDERS

OR_RESCINDING_ORDERS

REVOKING

TRUST_DEEDS

SATISFACTION_OF_TRUST_DEED_NOTICE_CODE_NO_LONGER_IN_SERVICE

DEEMED_CONSENT_BANKRUPTCY

RECALL_OF_SEQUESTRATION

SECTION52_BC_SEQUESTRATIONS_UNDERLYING_LEGISLATION_REPEALED_IN2014_NOTICE_CODE_NO_LONGER_IN_SERVICE

MEETING_OF_CREDITORS_PERSONAL_INSOLVENCY

PUBLIC_EXAMINATIONS_PERSONAL_INSOLVENCY

QUALIFYING_DECISION_PROCEDURE_PERSONAL_INSOLVENCY

COMPANIES_RESTORED_TO_THE_REGISTER

PRE_EMPTION_OFFERS_TO_SHAREHOLDERS

REDEMPTION_OR_PURCHASE_OF_OWN_SHARES_OUT_OF_CAPITAL

NOTICE_OF_DISCLAIMER

NOTICES_UNDER_THE_TRUSTEE_ACT1925

INSURANCE_COMPANIES

EMPLOYMENT_AGENCIES_NOTICE_CODE_NO_LONGER_IN_SERVICE

INSOLVENCY_PRACTITIONER_APPLICATIONS

COMPANY_DIRECTOR_DISQUALIFICATION_ORDER

COMPANIES_REMOVED_FROM_THE_REGISTER

REDUCTION_OF_CAPITAL

COMPANY_DOCUMENTS

EUROPEAN_ECONOMIC_INTEREST_GROUPING

MEETING_OF_CREDITORS

PETITIONS_TO_TRANSFER_BUSINESS

TAKEOVER_OFFERS

CHANGE_IN_THE_MEMBERS_OF_A_PARTNERSHIP

DISSOLUTION_OF_PARTNERSHIP

STATEMENT_BY_GENERAL_PARTNER

FRIENDLY_SOCIETIES

INDUSTRIAL_AND_PROVIDENT_SOCIETIES

BUILDING_SOCIETIES

CO_OPERATIVE_AND_COMMUNITY_BENEFIT_SOCIETIES

CHANGES_OF_NAME

NEXT_OF_KIN

DECEASED_ESTATES

UNCLAIMED_ESTATES

COMPETITION

POINTS_OF_LIGHT
Example
"UNKNOWN"
Types

NoticeCodeTypeOperationFilterInput

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

NoticeOfCorrectionOrDispute

Fields
Field Name Description
date - DateTime!
text - String!
type - String!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "date": "2007-12-03T10:15:30Z",
  "text": "xyz789",
  "type": "xyz789",
  "person": PersonalDetails,
  "associationType": "xyz789",
  "matchesApplicantName": true,
  "matchesApplicantDob": false
}
Types

Notification

Fields
Field Name Description
id - Int!
notificationType - Int!
portfolioId - Int!
portfolio - Portfolio
Example
{
  "id": 123,
  "notificationType": 987,
  "portfolioId": 123,
  "portfolio": Portfolio
}
Types

NotificationEventEnum

Values
Enum Value Description

SPAM_REPORT

DROPPED

BOUNCE

CLICK

OPEN

DELIVERED

DEFERRED

PROCESSED
Example
"SPAM_REPORT"
Types

NotificationEventEnumOperationFilterInput

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

NotificationFilterInput

Fields
Input Field Description
and - [NotificationFilterInput!]
or - [NotificationFilterInput!]
id - IntOperationFilterInput
notificationType - IntOperationFilterInput
portfolioId - IntOperationFilterInput
portfolio - PortfolioFilterInput
Example
{
  "and": [NotificationFilterInput],
  "or": [NotificationFilterInput],
  "id": IntOperationFilterInput,
  "notificationType": IntOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "portfolio": PortfolioFilterInput
}
Types

NotificationHistory

Fields
Field Name Description
portfolioEventId - Int!
createdDate - DateTime!
portfolioId - Int!
portfolio - Portfolio
Example
{
  "portfolioEventId": 123,
  "createdDate": "2007-12-03T10:15:30Z",
  "portfolioId": 987,
  "portfolio": Portfolio
}
Types

NotificationHistoryFilterInput

Fields
Input Field Description
and - [NotificationHistoryFilterInput!]
or - [NotificationHistoryFilterInput!]
portfolioEventId - IntOperationFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
portfolioId - IntOperationFilterInput
portfolio - PortfolioFilterInput
Example
{
  "and": [NotificationHistoryFilterInput],
  "or": [NotificationHistoryFilterInput],
  "portfolioEventId": IntOperationFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "portfolio": PortfolioFilterInput
}
Types

NotificationTypeEnum

Values
Enum Value Description

EMAIL

SMS
Example
"EMAIL"
Types

NotificationTypeEnumOperationFilterInput

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

NullableOfCheckTypeEnumOperationFilterInput

Fields
Input Field Description
eq - CheckTypeEnum
neq - CheckTypeEnum
in - [CheckTypeEnum]
nin - [CheckTypeEnum]
Example
{
  "eq": "KNOW_YOUR_CLIENT",
  "neq": "KNOW_YOUR_CLIENT",
  "in": ["KNOW_YOUR_CLIENT"],
  "nin": ["KNOW_YOUR_CLIENT"]
}
Types

NullableOfCompanyRatingOperationFilterInput

Fields
Input Field Description
eq - CompanyRating
neq - CompanyRating
in - [CompanyRating]
nin - [CompanyRating]
Example
{
  "eq": "THREE_RED_FLAGS",
  "neq": "THREE_RED_FLAGS",
  "in": ["THREE_RED_FLAGS"],
  "nin": ["THREE_RED_FLAGS"]
}
Types

NullableOfCompanyReportReasonCodeOperationFilterInput

Fields
Input Field Description
eq - CompanyReportReasonCode
neq - CompanyReportReasonCode
in - [CompanyReportReasonCode]
nin - [CompanyReportReasonCode]
Example
{
  "eq": "CREDIT_DECISION",
  "neq": "CREDIT_DECISION",
  "in": ["CREDIT_DECISION"],
  "nin": ["CREDIT_DECISION"]
}
Types

NullableOfCountryCodeOperationFilterInput

Fields
Input Field Description
eq - CountryCode
neq - CountryCode
in - [CountryCode]
nin - [CountryCode]
Example
{"eq": "AFG", "neq": "AFG", "in": ["AFG"], "nin": ["AFG"]}
Types

NullableOfCurrencyCodeOperationFilterInput

Fields
Input Field Description
eq - CurrencyCode
neq - CurrencyCode
in - [CurrencyCode]
nin - [CurrencyCode]
Example
{"eq": "AED", "neq": "AED", "in": ["AED"], "nin": ["AED"]}
Types

NullableOfEventOperationFilterInput

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

NullableOfFileExportSelectionTypeOperationFilterInput

Fields
Input Field Description
eq - FileExportSelectionType
neq - FileExportSelectionType
in - [FileExportSelectionType]
nin - [FileExportSelectionType]
Example
{
  "eq": "ALL_COLUMNS",
  "neq": "ALL_COLUMNS",
  "in": ["ALL_COLUMNS"],
  "nin": ["ALL_COLUMNS"]
}
Types

NullableOfOrderedCompanyRatingOperationFilterInput

Fields
Input Field Description
eq - OrderedCompanyRating
neq - OrderedCompanyRating
in - [OrderedCompanyRating]
nin - [OrderedCompanyRating]
Example
{
  "eq": "BUSINESS_DISCONTINUED",
  "neq": "BUSINESS_DISCONTINUED",
  "in": ["BUSINESS_DISCONTINUED"],
  "nin": ["BUSINESS_DISCONTINUED"]
}
Types

NullableOfOverriddenStatusTypeOperationFilterInput

Fields
Input Field Description
eq - OverriddenStatusType
neq - OverriddenStatusType
in - [OverriddenStatusType]
nin - [OverriddenStatusType]
Example
{"eq": "PASS", "neq": "PASS", "in": ["PASS"], "nin": ["PASS"]}
Types

NullableOfRfaRatingOperationFilterInput

Fields
Input Field Description
eq - RfaRating
neq - RfaRating
in - [RfaRating]
nin - [RfaRating]
Example
{
  "eq": "THREE_RED_FLAGS",
  "neq": "THREE_RED_FLAGS",
  "in": ["THREE_RED_FLAGS"],
  "nin": ["THREE_RED_FLAGS"]
}
Types

OpenClosedAccounts

Fields
Field Name Description
open - Int!
closed - Int!
Example
{"open": 123, "closed": 987}
Types

Operators

Values
Enum Value Description

GREATER_THAN

LESS_THAN

GREATER_THAN_OR_EQUAL

LESS_THAN_OR_EQUAL

EQUAL

RANGE

LESS_THAN_ON_LAST_DAY_OF_MONTH
Example
"GREATER_THAN"
Types

OrderedCompanyRating

Values
Enum Value Description

BUSINESS_DISCONTINUED

DISSOLVED

STRIKE_OFF

INSOLVENT

NOT_TRADING

NA

GOLD

SILVER

BRONZE

AMBER

ONE_RED_FLAG

TWO_RED_FLAGS

THREE_RED_FLAGS

PRE_INSOLVENCY

UNKNOWN
Example
"BUSINESS_DISCONTINUED"
Types

OrganisationalStructure

Fields
Field Name Description
corporateStructure - [CorporateEntity]
beneficialOwners - [BeneficialOwner]
beneficialOwnerGraph - BeneficialOwnerGraph
people - [Person]
shareholders - [Shareholder]
Example
{
  "corporateStructure": [CorporateEntity],
  "beneficialOwners": [BeneficialOwner],
  "beneficialOwnerGraph": BeneficialOwnerGraph,
  "people": [Person],
  "shareholders": [Shareholder]
}
Types

Outcome

Description

Summarises outcome of the check.

Fields
Field Name Description
checkId - Int! The check Id.
currentResult - ResultEnum! The overall check result. Returns lowest result of all available PSAM/AML/IDV results. Overrides take precedence.
psamResult - ResultEnum!
idvResult - ResultEnum!
amlResult - ResultEnum!
currentStatus - CheckStatusType! Current status of the check.
statusHistory - [CheckStatus] History of statuses the check has been through in its lifecycle.
verificationStatuses - [Verification] Individual Verification Breakdown - start and completion dates, and whether started and completed
Example
{
  "checkId": 987,
  "currentResult": "NOT_AVAILABLE",
  "psamResult": "NOT_AVAILABLE",
  "idvResult": "NOT_AVAILABLE",
  "amlResult": "NOT_AVAILABLE",
  "currentStatus": "CREATED",
  "statusHistory": [CheckStatus],
  "verificationStatuses": [Verification]
}
Types

OverriddenStatusType

Values
Enum Value Description

PASS

FAIL
Example
"PASS"
Types

PDFMeta

Fields
Field Name Description
companyName - String
companyNumber - String
countryCode - account_CountryCode!
Example
{
  "companyName": "xyz789",
  "companyNumber": "abc123",
  "countryCode": "AFG"
}
Types

PDFMetaFilterInput

Fields
Input Field Description
and - [PDFMetaFilterInput!]
or - [PDFMetaFilterInput!]
companyName - StringOperationFilterInput
companyNumber - StringOperationFilterInput
countryCode - CountryCodeOperationFilterInput
Example
{
  "and": [PDFMetaFilterInput],
  "or": [PDFMetaFilterInput],
  "companyName": StringOperationFilterInput,
  "companyNumber": StringOperationFilterInput,
  "countryCode": CountryCodeOperationFilterInput
}
Types

PDFMetaInput

Fields
Input Field Description
companyName - String
companyNumber - String
countryCode - account_CountryCode!
Example
{
  "companyName": "xyz789",
  "companyNumber": "abc123",
  "countryCode": "AFG"
}
Types

POSC

Fields
Field Name Description
id - Int!
companyno - String
address - String
principal_office_address - String
postcode - String
name - String
birthdate - String
nationality - String
country_of_residence - String
kind - String
natures_of_control - String
notified_on - String
ceased_on - String
is_sanctioned - Boolean!
statement - String
identification_country_registered - String
identification_legal_authority - String
identification_legal_form - String
identification_place_registered - String
identification_registeration_number - String
timestamp - Int!
Example
{
  "id": 987,
  "companyno": "abc123",
  "address": "xyz789",
  "principal_office_address": "abc123",
  "postcode": "xyz789",
  "name": "xyz789",
  "birthdate": "abc123",
  "nationality": "xyz789",
  "country_of_residence": "xyz789",
  "kind": "abc123",
  "natures_of_control": "abc123",
  "notified_on": "abc123",
  "ceased_on": "abc123",
  "is_sanctioned": false,
  "statement": "xyz789",
  "identification_country_registered": "abc123",
  "identification_legal_authority": "xyz789",
  "identification_legal_form": "abc123",
  "identification_place_registered": "xyz789",
  "identification_registeration_number": "abc123",
  "timestamp": 987
}
Types

POSCFilterInput

Fields
Input Field Description
and - [POSCFilterInput!]
or - [POSCFilterInput!]
id - IntOperationFilterInput
companyno - StringOperationFilterInput
address - StringOperationFilterInput
principal_office_address - StringOperationFilterInput
postcode - StringOperationFilterInput
name - StringOperationFilterInput
birthdate - StringOperationFilterInput
nationality - StringOperationFilterInput
country_of_residence - StringOperationFilterInput
kind - StringOperationFilterInput
natures_of_control - StringOperationFilterInput
notified_on - StringOperationFilterInput
ceased_on - StringOperationFilterInput
is_sanctioned - BooleanOperationFilterInput
statement - StringOperationFilterInput
identification_country_registered - StringOperationFilterInput
identification_legal_authority - StringOperationFilterInput
identification_legal_form - StringOperationFilterInput
identification_place_registered - StringOperationFilterInput
identification_registeration_number - StringOperationFilterInput
timestamp - IntOperationFilterInput
Example
{
  "and": [POSCFilterInput],
  "or": [POSCFilterInput],
  "id": IntOperationFilterInput,
  "companyno": StringOperationFilterInput,
  "address": StringOperationFilterInput,
  "principal_office_address": StringOperationFilterInput,
  "postcode": StringOperationFilterInput,
  "name": StringOperationFilterInput,
  "birthdate": StringOperationFilterInput,
  "nationality": StringOperationFilterInput,
  "country_of_residence": StringOperationFilterInput,
  "kind": StringOperationFilterInput,
  "natures_of_control": StringOperationFilterInput,
  "notified_on": StringOperationFilterInput,
  "ceased_on": StringOperationFilterInput,
  "is_sanctioned": BooleanOperationFilterInput,
  "statement": StringOperationFilterInput,
  "identification_country_registered": StringOperationFilterInput,
  "identification_legal_authority": StringOperationFilterInput,
  "identification_legal_form": StringOperationFilterInput,
  "identification_place_registered": StringOperationFilterInput,
  "identification_registeration_number": StringOperationFilterInput,
  "timestamp": IntOperationFilterInput
}
Types

Paydex

Fields
Field Name Description
overallPaymentBehaviour - String
highestNowOwing - Float
percentOfTradeWithinTerms - Float
totalTradeExperiences - Int
largestHighCredit - Float
averageHighCredit - Float
highestPastDue - Float
totalUnfavourableComments - Int
largestHighCreditUnfavourable - Float
totalPlacedInCollections - Int
largestHighCreditCollections - Float
tradePaymentScore - Float
industryMedian - Float
threeMonthTradePaymentScore - Float
currency - CurrencyCode
Example
{
  "overallPaymentBehaviour": "abc123",
  "highestNowOwing": 987.65,
  "percentOfTradeWithinTerms": 123.45,
  "totalTradeExperiences": 987,
  "largestHighCredit": 987.65,
  "averageHighCredit": 987.65,
  "highestPastDue": 123.45,
  "totalUnfavourableComments": 987,
  "largestHighCreditUnfavourable": 987.65,
  "totalPlacedInCollections": 987,
  "largestHighCreditCollections": 987.65,
  "tradePaymentScore": 987.65,
  "industryMedian": 123.45,
  "threeMonthTradePaymentScore": 987.65,
  "currency": "AED"
}
Types

PeopleCollectionSegment

Description

A segment of a collection.

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

PercentileAggregationInput

Fields
Input Field Description
field - CompanyNumericField
percents - [Float!]
Example
{"field": "DIRECTORS_AGE_YEARS", "percents": [123.45]}
Types

PercentileRankAggregationInput

Fields
Input Field Description
field - CompanyNumericField
values - [Float!]
Example
{"field": "DIRECTORS_AGE_YEARS", "values": [123.45]}
Types

Person

Fields
Field Name Description
id - String
premises - String
type - PersonRecordType!
source - String
title - String
forenames - String
surname - String
full_name - String
honours - String
careof - String
pobox - String
address_line_1 - String
address_line_2 - String
locality - String
county - String
country - String
occupation - String
nationality - String
country_of_residence - String
postcode - String
dob - DateTime
dob_partial - Boolean
company_id - Int!
director - DirectorPerson
insolvency - InsolvencyPerson
posc - PoscPerson
timestamp - Int!
relevance - Float
Example
{
  "id": "abc123",
  "premises": "abc123",
  "type": "DIRECTOR",
  "source": "abc123",
  "title": "xyz789",
  "forenames": "abc123",
  "surname": "xyz789",
  "full_name": "xyz789",
  "honours": "abc123",
  "careof": "abc123",
  "pobox": "abc123",
  "address_line_1": "abc123",
  "address_line_2": "abc123",
  "locality": "abc123",
  "county": "xyz789",
  "country": "xyz789",
  "occupation": "abc123",
  "nationality": "abc123",
  "country_of_residence": "abc123",
  "postcode": "xyz789",
  "dob": "2007-12-03T10:15:30Z",
  "dob_partial": true,
  "company_id": 987,
  "director": DirectorPerson,
  "insolvency": InsolvencyPerson,
  "posc": PoscPerson,
  "timestamp": 123,
  "relevance": 123.45
}
Types

PersonAddressV2

Description

Relationship between a person and their addresses

Fields
Field Name Description
personId - UUID! Person identifier
addressId - UUID! Address identifier
type - String Type of address (e.g., residential, business)
isPrimary - Boolean Whether this is the primary address
createdAt - DateTime When this address relationship was created
person - PersonV2 Associated person
address - AddressV2 Associated address
Example
{
  "personId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "addressId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "type": "xyz789",
  "isPrimary": false,
  "createdAt": "2007-12-03T10:15:30Z",
  "person": PersonV2,
  "address": AddressV2
}
Types

PersonFilterInput

Fields
Input Field Description
and - [PersonFilterInput!]
or - [PersonFilterInput!]
id - StringOperationFilterInput
premises - StringOperationFilterInput
type - PersonRecordTypeOperationFilterInput
source - StringOperationFilterInput
title - StringOperationFilterInput
forenames - StringOperationFilterInput
surname - StringOperationFilterInput
full_name - StringOperationFilterInput
honours - StringOperationFilterInput
careof - StringOperationFilterInput
pobox - StringOperationFilterInput
address_line_1 - StringOperationFilterInput
address_line_2 - StringOperationFilterInput
locality - StringOperationFilterInput
county - StringOperationFilterInput
country - StringOperationFilterInput
occupation - StringOperationFilterInput
nationality - StringOperationFilterInput
country_of_residence - StringOperationFilterInput
postcode - StringOperationFilterInput
dob - DateTimeOperationFilterInput
dob_partial - BooleanOperationFilterInput
company_id - IntOperationFilterInput
director - DirectorPersonFilterInput
insolvency - InsolvencyPersonFilterInput
posc - PoscPersonFilterInput
timestamp - IntOperationFilterInput
relevance - FloatOperationFilterInput
Example
{
  "and": [PersonFilterInput],
  "or": [PersonFilterInput],
  "id": StringOperationFilterInput,
  "premises": StringOperationFilterInput,
  "type": PersonRecordTypeOperationFilterInput,
  "source": StringOperationFilterInput,
  "title": StringOperationFilterInput,
  "forenames": StringOperationFilterInput,
  "surname": StringOperationFilterInput,
  "full_name": StringOperationFilterInput,
  "honours": StringOperationFilterInput,
  "careof": StringOperationFilterInput,
  "pobox": StringOperationFilterInput,
  "address_line_1": StringOperationFilterInput,
  "address_line_2": StringOperationFilterInput,
  "locality": StringOperationFilterInput,
  "county": StringOperationFilterInput,
  "country": StringOperationFilterInput,
  "occupation": StringOperationFilterInput,
  "nationality": StringOperationFilterInput,
  "country_of_residence": StringOperationFilterInput,
  "postcode": StringOperationFilterInput,
  "dob": DateTimeOperationFilterInput,
  "dob_partial": BooleanOperationFilterInput,
  "company_id": IntOperationFilterInput,
  "director": DirectorPersonFilterInput,
  "insolvency": InsolvencyPersonFilterInput,
  "posc": PoscPersonFilterInput,
  "timestamp": IntOperationFilterInput,
  "relevance": FloatOperationFilterInput
}
Types

PersonRecordType

Values
Enum Value Description

DIRECTOR

INSOLVENCY

POSC

SHAREHOLDER

PROPRIETOR
Example
"DIRECTOR"
Types

PersonRecordTypeOperationFilterInput

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

PersonSearch

Fields
Field Name Description
id - String
type - PersonRecordType
source - String
title - String
premises - String
forenames - String
surname - String
full_name - String
honours - String
careof - String
pobox - String
address_line_1 - String
address_line_2 - String
locality - String
county - String
country - String
occupation - String
nationality - String
country_of_residence - String
postcode - String
dob - Date
dob_partial - Boolean
director - DirectorPerson
insolvency - InsolvencyPerson
company_id - Int!
posc - PoscPerson
timestamp - Int!
company - CompanySearch
Example
{
  "id": "abc123",
  "type": "DIRECTOR",
  "source": "abc123",
  "title": "xyz789",
  "premises": "abc123",
  "forenames": "abc123",
  "surname": "xyz789",
  "full_name": "xyz789",
  "honours": "abc123",
  "careof": "abc123",
  "pobox": "abc123",
  "address_line_1": "xyz789",
  "address_line_2": "abc123",
  "locality": "abc123",
  "county": "xyz789",
  "country": "abc123",
  "occupation": "xyz789",
  "nationality": "abc123",
  "country_of_residence": "xyz789",
  "postcode": "abc123",
  "dob": "2007-12-03",
  "dob_partial": false,
  "director": DirectorPerson,
  "insolvency": InsolvencyPerson,
  "company_id": 987,
  "posc": PoscPerson,
  "timestamp": 987,
  "company": CompanySearch
}
Types

PersonSearchFilterInput

Fields
Input Field Description
and - [PersonSearchFilterInput!]
or - [PersonSearchFilterInput!]
id - StringOperationFilterInput
premises - StringOperationFilterInput
type - PersonRecordTypeOperationFilterInput
source - StringOperationFilterInput
title - StringOperationFilterInput
forenames - StringOperationFilterInput
surname - StringOperationFilterInput
full_name - StringOperationFilterInput
honours - StringOperationFilterInput
careof - StringOperationFilterInput
pobox - StringOperationFilterInput
address_line_1 - StringOperationFilterInput
address_line_2 - StringOperationFilterInput
locality - StringOperationFilterInput
county - StringOperationFilterInput
country - StringOperationFilterInput
occupation - StringOperationFilterInput
nationality - StringOperationFilterInput
country_of_residence - StringOperationFilterInput
postcode - StringOperationFilterInput
dob - DateTimeOperationFilterInput
dob_partial - BooleanOperationFilterInput
company_id - IntOperationFilterInput
director - DirectorPersonFilterInput
insolvency - InsolvencyPersonFilterInput
posc - PoscPersonFilterInput
timestamp - IntOperationFilterInput
relevance - FloatOperationFilterInput
Example
{
  "and": [PersonSearchFilterInput],
  "or": [PersonSearchFilterInput],
  "id": StringOperationFilterInput,
  "premises": StringOperationFilterInput,
  "type": PersonRecordTypeOperationFilterInput,
  "source": StringOperationFilterInput,
  "title": StringOperationFilterInput,
  "forenames": StringOperationFilterInput,
  "surname": StringOperationFilterInput,
  "full_name": StringOperationFilterInput,
  "honours": StringOperationFilterInput,
  "careof": StringOperationFilterInput,
  "pobox": StringOperationFilterInput,
  "address_line_1": StringOperationFilterInput,
  "address_line_2": StringOperationFilterInput,
  "locality": StringOperationFilterInput,
  "county": StringOperationFilterInput,
  "country": StringOperationFilterInput,
  "occupation": StringOperationFilterInput,
  "nationality": StringOperationFilterInput,
  "country_of_residence": StringOperationFilterInput,
  "postcode": StringOperationFilterInput,
  "dob": DateTimeOperationFilterInput,
  "dob_partial": BooleanOperationFilterInput,
  "company_id": IntOperationFilterInput,
  "director": DirectorPersonFilterInput,
  "insolvency": InsolvencyPersonFilterInput,
  "posc": PoscPersonFilterInput,
  "timestamp": IntOperationFilterInput,
  "relevance": FloatOperationFilterInput
}
Types

PersonSearchSortInput

Fields
Input Field Description
id - SortEnumType
premises - SortEnumType
type - SortEnumType
source - SortEnumType
title - SortEnumType
forenames - SortEnumType
surname - SortEnumType
full_name - SortEnumType
honours - SortEnumType
careof - SortEnumType
pobox - SortEnumType
address_line_1 - SortEnumType
address_line_2 - SortEnumType
locality - SortEnumType
county - SortEnumType
country - SortEnumType
occupation - SortEnumType
nationality - SortEnumType
country_of_residence - SortEnumType
postcode - SortEnumType
dob - SortEnumType
dob_partial - SortEnumType
company_id - SortEnumType
director - DirectorPersonSortInput
insolvency - InsolvencyPersonSortInput
posc - PoscPersonSortInput
timestamp - SortEnumType
relevance - SortEnumType
Example
{
  "id": "ASC",
  "premises": "ASC",
  "type": "ASC",
  "source": "ASC",
  "title": "ASC",
  "forenames": "ASC",
  "surname": "ASC",
  "full_name": "ASC",
  "honours": "ASC",
  "careof": "ASC",
  "pobox": "ASC",
  "address_line_1": "ASC",
  "address_line_2": "ASC",
  "locality": "ASC",
  "county": "ASC",
  "country": "ASC",
  "occupation": "ASC",
  "nationality": "ASC",
  "country_of_residence": "ASC",
  "postcode": "ASC",
  "dob": "ASC",
  "dob_partial": "ASC",
  "company_id": "ASC",
  "director": DirectorPersonSortInput,
  "insolvency": InsolvencyPersonSortInput,
  "posc": PoscPersonSortInput,
  "timestamp": "ASC",
  "relevance": "ASC"
}
Types

PersonV2

Description

A person in the v2 system

Fields
Field Name Description
id - UUID! Unique person identifier
firstName - String Person's first name
middleName - String Person's middle name
lastName - String Person's last name
mobileNumber - String Person's mobile number
email - String Person's email address
dateOfBirth - String Person's date of birth
gender - String Person's gender
title - String Person's title
createdAt - DateTime When the person record was created
updatedAt - DateTime When the person record was last updated
personAddresses - [PersonAddressV2] Addresses associated with this person
checkId - UUID
phone - String
nationality - String
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "firstName": "xyz789",
  "middleName": "abc123",
  "lastName": "xyz789",
  "mobileNumber": "xyz789",
  "email": "abc123",
  "dateOfBirth": "abc123",
  "gender": "abc123",
  "title": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "personAddresses": [PersonAddressV2],
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "phone": "xyz789",
  "nationality": "xyz789",
  "check": CheckV2
}
Types

PersonalDetails

Fields
Field Name Description
title - String
firstName - String
middleName - String
lastName - String
dateOfBirth - DateTime
Example
{
  "title": "xyz789",
  "firstName": "xyz789",
  "middleName": "abc123",
  "lastName": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z"
}
Types

PersonalDetailsInput

Fields
Input Field Description
title - String
firstName - String!
middleName - String
lastName - String!
dateOfBirth - DateTime
Example
{
  "title": "xyz789",
  "firstName": "abc123",
  "middleName": "abc123",
  "lastName": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z"
}
Types

PersonsWithSignificantControl

Fields
Field Name Description
kind - String
notified_on - DateTime
name - String
natures_of_control - [String]
registration_number - String
legal_authority - String
place_registered - String
legal_form - String
country_registered - String
premises - String
address_line_1 - String
address_line_2 - String
locality - String
region - String
country - String
postal_code - String
nationality - String
Example
{
  "kind": "xyz789",
  "notified_on": "2007-12-03T10:15:30Z",
  "name": "xyz789",
  "natures_of_control": ["abc123"],
  "registration_number": "abc123",
  "legal_authority": "xyz789",
  "place_registered": "xyz789",
  "legal_form": "abc123",
  "country_registered": "xyz789",
  "premises": "abc123",
  "address_line_1": "abc123",
  "address_line_2": "xyz789",
  "locality": "abc123",
  "region": "xyz789",
  "country": "abc123",
  "postal_code": "xyz789",
  "nationality": "abc123"
}
Types

PhoneVerificationResult

Description

A phone account verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique phone account verification result identifier
checkId - UUID! Associated check identifier
vendor - String Vendor used for phone account verification
vendorReference - String Reference from the phone verification provider
vendorDecision - String Decision from the phone verification provider
mobileNumber - String Mobile number that was verified
landlineNumber - String Landline number that was verified
status - String Status of the phone account verification
confidenceScore - Float Confidence score of the verification
rawResponse - String Raw vendor response (JSON)
createdAt - DateTime When the phone account verification result was created
verifiedAt - DateTime When the verification was completed
checks - [PhoneVerificationResultCheckV2] Phone verification checks
countryCode - String
updatedAt - DateTime
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "vendor": "xyz789",
  "vendorReference": "xyz789",
  "vendorDecision": "abc123",
  "mobileNumber": "xyz789",
  "landlineNumber": "abc123",
  "status": "xyz789",
  "confidenceScore": 987.65,
  "rawResponse": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "verifiedAt": "2007-12-03T10:15:30Z",
  "checks": [PhoneVerificationResultCheckV2],
  "countryCode": "abc123",
  "updatedAt": "2007-12-03T10:15:30Z",
  "check": CheckV2
}
Types

PhoneVerificationResultCheckFieldV2

Description

A field within a check of a phone verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique field identifier
phoneVerificationResultCheckId - UUID! Associated phone verification result check identifier
fieldType - String Type of field
fieldResult - String Result for this field
createdAt - DateTime When the field was created
updatedAt - DateTime When the field was last updated
phoneVerificationResultCheck - PhoneVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "phoneVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldType": "xyz789",
  "fieldResult": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "phoneVerificationResultCheck": PhoneVerificationResultCheckV2
}
Types

PhoneVerificationResultCheckItemV2

Description

An item within a check of a phone verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique item identifier
phoneVerificationResultCheckId - UUID! Associated phone verification result check identifier
itemType - String Type of item (match, mismatch, comment, nomatch)
providerCode - String Provider code for this item
description - String Item description
createdAt - DateTime When the item was created
updatedAt - DateTime When the item was last updated
phoneVerificationResultCheck - PhoneVerificationResultCheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "phoneVerificationResultCheckId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "itemType": "abc123",
  "providerCode": "xyz789",
  "description": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "phoneVerificationResultCheck": PhoneVerificationResultCheckV2
}
Types

PhoneVerificationResultCheckV2

Description

A check within a phone verification result in the v2 system

Fields
Field Name Description
id - UUID! Unique check identifier
PhoneVerificationResultId - UUID! Associated phone account verification result identifier
providerCheckId - String Provider check identifier
name - String Check name
description - String Check description
createdAt - DateTime When the check was created
updatedAt - DateTime When the check was last updated
items - [PhoneVerificationResultCheckItemV2] Phone verification check items
fields - [PhoneVerificationResultCheckFieldV2] Phone verification check fields
phoneVerificationResult - PhoneVerificationResult
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "PhoneVerificationResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "providerCheckId": "xyz789",
  "name": "abc123",
  "description": "xyz789",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "items": [PhoneVerificationResultCheckItemV2],
  "fields": [PhoneVerificationResultCheckFieldV2],
  "phoneVerificationResult": PhoneVerificationResult
}
Types

Portfolio

Fields
Field Name Description
description - String Description
name - String Name
isPrivate - Boolean! IsPrivate
accountId - String AccountId
accountEmail - String AccountEmail
portfolioType - PortfolioType! Type of portfolio
id - Int! Id
notifications - [Notification] Notification
notificationHistory - [NotificationHistory] NotificationHistory
triggerEvents - [TriggerEvent] TriggerEvents
portfolioEvents - [PortfolioEvent] PortfolioEvents
Arguments
order - [PortfolioEventSortInput!]
lastEventTime - DateTime LastEventTime
lastEventType - Event LastEventType
lastCompanyId - Int LastCompanyId
lastNotifiedEvent - Int! LastNotifiedEvent
portfolioRecipients - [PortfolioRecipients] PortfolioRecipients
totalCompaniesCount - Int Total number of companies in portfolio
Example
{
  "description": "abc123",
  "name": "xyz789",
  "isPrivate": true,
  "accountId": "abc123",
  "accountEmail": "xyz789",
  "portfolioType": "NONE",
  "id": 123,
  "notifications": [Notification],
  "notificationHistory": [NotificationHistory],
  "triggerEvents": [TriggerEvent],
  "portfolioEvents": [PortfolioEvent],
  "lastEventTime": "2007-12-03T10:15:30Z",
  "lastEventType": "NA",
  "lastCompanyId": 987,
  "lastNotifiedEvent": 123,
  "portfolioRecipients": [PortfolioRecipients],
  "totalCompaniesCount": 987
}
Types

PortfolioCompanyCountFilterInput

Fields
Input Field Description
and - [PortfolioCompanyCountFilterInput!]
or - [PortfolioCompanyCountFilterInput!]
portfolioId - IntOperationFilterInput
count - LongOperationFilterInput
Example
{
  "and": [PortfolioCompanyCountFilterInput],
  "or": [PortfolioCompanyCountFilterInput],
  "portfolioId": IntOperationFilterInput,
  "count": LongOperationFilterInput
}
Types

PortfolioCompanyCountSortInput

Fields
Input Field Description
portfolioId - SortEnumType
count - SortEnumType
Example
{"portfolioId": "ASC", "count": "ASC"}
Types

PortfolioEvent

Fields
Field Name Description
eventId - Event! EventType
id - Int! Id
companyId - Int CompanyId
portfolio - Portfolio Portfolio
eventDate - DateTime! EventDate
notes - String Notes
company - CompanySearch
Example
{
  "eventId": "NA",
  "id": 123,
  "companyId": 123,
  "portfolio": Portfolio,
  "eventDate": "2007-12-03T10:15:30Z",
  "notes": "abc123",
  "company": CompanySearch
}
Types

PortfolioEventCountFilterInput

Fields
Input Field Description
and - [PortfolioEventCountFilterInput!]
or - [PortfolioEventCountFilterInput!]
portfolioId - IntOperationFilterInput
lastNotifiedEvent - IntOperationFilterInput
count - LongOperationFilterInput
Example
{
  "and": [PortfolioEventCountFilterInput],
  "or": [PortfolioEventCountFilterInput],
  "portfolioId": IntOperationFilterInput,
  "lastNotifiedEvent": IntOperationFilterInput,
  "count": LongOperationFilterInput
}
Types

PortfolioEventFilterInput

Fields
Input Field Description
and - [PortfolioEventFilterInput!]
or - [PortfolioEventFilterInput!]
id - IntOperationFilterInput
companyId - IntOperationFilterInput
eventId - EventOperationFilterInput
notes - StringOperationFilterInput
portfolioId - IntOperationFilterInput
eventDate - portfolio_DateTimeOperationFilterInput
portfolio - PortfolioFilterInput
eventType - EventTypeFilterInput
companyPortfolio - CompanyPortfolioFilterInput
Example
{
  "and": [PortfolioEventFilterInput],
  "or": [PortfolioEventFilterInput],
  "id": IntOperationFilterInput,
  "companyId": IntOperationFilterInput,
  "eventId": EventOperationFilterInput,
  "notes": StringOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "eventDate": portfolio_DateTimeOperationFilterInput,
  "portfolio": PortfolioFilterInput,
  "eventType": EventTypeFilterInput,
  "companyPortfolio": CompanyPortfolioFilterInput
}
Types

PortfolioEventSortInput

Fields
Input Field Description
id - SortEnumType
companyId - SortEnumType
eventId - SortEnumType
notes - SortEnumType
portfolioId - SortEnumType
eventDate - SortEnumType
portfolio - PortfolioSortInput
eventType - EventTypeSortInput
companyPortfolio - CompanyPortfolioSortInput
Example
{
  "id": "ASC",
  "companyId": "ASC",
  "eventId": "ASC",
  "notes": "ASC",
  "portfolioId": "ASC",
  "eventDate": "ASC",
  "portfolio": PortfolioSortInput,
  "eventType": EventTypeSortInput,
  "companyPortfolio": CompanyPortfolioSortInput
}
Types

PortfolioEventsCollectionSegment

Description

A segment of a collection.

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

PortfolioFilterInput

Fields
Input Field Description
and - [PortfolioFilterInput!]
or - [PortfolioFilterInput!]
id - IntOperationFilterInput
userId - StringOperationFilterInput
name - StringOperationFilterInput
accountId - StringOperationFilterInput
accountEmail - StringOperationFilterInput
description - StringOperationFilterInput
createDate - portfolio_DateTimeOperationFilterInput
isPrivate - BooleanOperationFilterInput
reportScheduleTime - StringOperationFilterInput
isActive - BooleanOperationFilterInput
lastEventTime - portfolio_DateTimeOperationFilterInput
lastEventType - NullableOfEventOperationFilterInput
lastCompanyId - IntOperationFilterInput
lastNotifiedEvent - IntOperationFilterInput
portfolioType - PortfolioTypeOperationFilterInput
companyCount - PortfolioCompanyCountFilterInput
companyPortfolios - ListFilterInputTypeOfCompanyPortfolioFilterInput
notifications - ListFilterInputTypeOfNotificationFilterInput
notificationHistory - ListFilterInputTypeOfNotificationHistoryFilterInput
triggerEvents - ListFilterInputTypeOfTriggerEventFilterInput
portfolioEvents - ListFilterInputTypeOfPortfolioEventFilterInput
portfolioRecipients - ListFilterInputTypeOfPortfolioRecipientsFilterInput
Example
{
  "and": [PortfolioFilterInput],
  "or": [PortfolioFilterInput],
  "id": IntOperationFilterInput,
  "userId": StringOperationFilterInput,
  "name": StringOperationFilterInput,
  "accountId": StringOperationFilterInput,
  "accountEmail": StringOperationFilterInput,
  "description": StringOperationFilterInput,
  "createDate": portfolio_DateTimeOperationFilterInput,
  "isPrivate": BooleanOperationFilterInput,
  "reportScheduleTime": StringOperationFilterInput,
  "isActive": BooleanOperationFilterInput,
  "lastEventTime": portfolio_DateTimeOperationFilterInput,
  "lastEventType": NullableOfEventOperationFilterInput,
  "lastCompanyId": IntOperationFilterInput,
  "lastNotifiedEvent": IntOperationFilterInput,
  "portfolioType": PortfolioTypeOperationFilterInput,
  "companyCount": PortfolioCompanyCountFilterInput,
  "companyPortfolios": ListFilterInputTypeOfCompanyPortfolioFilterInput,
  "notifications": ListFilterInputTypeOfNotificationFilterInput,
  "notificationHistory": ListFilterInputTypeOfNotificationHistoryFilterInput,
  "triggerEvents": ListFilterInputTypeOfTriggerEventFilterInput,
  "portfolioEvents": ListFilterInputTypeOfPortfolioEventFilterInput,
  "portfolioRecipients": ListFilterInputTypeOfPortfolioRecipientsFilterInput
}
Types

PortfolioRecipientInput

Fields
Input Field Description
recipients - [RecipientInput]
portfolioId - Int!
Example
{"recipients": [RecipientInput], "portfolioId": 987}
Types

PortfolioRecipients

Fields
Field Name Description
id - Int!
portfolioId - Int!
recipientEmail - String
portfolio - Portfolio
Example
{
  "id": 123,
  "portfolioId": 123,
  "recipientEmail": "abc123",
  "portfolio": Portfolio
}
Types

PortfolioRecipientsFilterInput

Fields
Input Field Description
and - [PortfolioRecipientsFilterInput!]
or - [PortfolioRecipientsFilterInput!]
id - IntOperationFilterInput
portfolioId - IntOperationFilterInput
recipientEmail - StringOperationFilterInput
portfolio - PortfolioFilterInput
Example
{
  "and": [PortfolioRecipientsFilterInput],
  "or": [PortfolioRecipientsFilterInput],
  "id": IntOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "recipientEmail": StringOperationFilterInput,
  "portfolio": PortfolioFilterInput
}
Types

PortfolioSortInput

Fields
Input Field Description
id - SortEnumType
userId - SortEnumType
name - SortEnumType
accountId - SortEnumType
accountEmail - SortEnumType
description - SortEnumType
createDate - SortEnumType
isPrivate - SortEnumType
reportScheduleTime - SortEnumType
isActive - SortEnumType
lastEventTime - SortEnumType
lastEventType - SortEnumType
lastCompanyId - SortEnumType
lastNotifiedEvent - SortEnumType
portfolioType - SortEnumType
companyCount - PortfolioCompanyCountSortInput
Example
{
  "id": "ASC",
  "userId": "ASC",
  "name": "ASC",
  "accountId": "ASC",
  "accountEmail": "ASC",
  "description": "ASC",
  "createDate": "ASC",
  "isPrivate": "ASC",
  "reportScheduleTime": "ASC",
  "isActive": "ASC",
  "lastEventTime": "ASC",
  "lastEventType": "ASC",
  "lastCompanyId": "ASC",
  "lastNotifiedEvent": "ASC",
  "portfolioType": "ASC",
  "companyCount": PortfolioCompanyCountSortInput
}
Types

PortfolioType

Values
Enum Value Description

NONE

DOMESTIC

INTERNATIONAL

DOMESTIC_AND_INTERNATIONAL
Example
"NONE"
Types

PortfolioTypeOperationFilterInput

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

PortfoliosCollectionSegment

Description

A segment of a collection.

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

PoscPerson

Fields
Field Name Description
company_number - String
is_sanctioned - Boolean
kind - String
natures_of_control - String
identification_country_registered - String
identification_legal_authority - String
identification_legal_form - String
identification_place_registered - String
identification_registration_number - String
notified_on - DateTime
ceased_on - DateTime
company - CompanySearch
Example
{
  "company_number": "abc123",
  "is_sanctioned": false,
  "kind": "abc123",
  "natures_of_control": "abc123",
  "identification_country_registered": "abc123",
  "identification_legal_authority": "abc123",
  "identification_legal_form": "abc123",
  "identification_place_registered": "xyz789",
  "identification_registration_number": "xyz789",
  "notified_on": "2007-12-03T10:15:30Z",
  "ceased_on": "2007-12-03T10:15:30Z",
  "company": CompanySearch
}
Types

PoscPersonFilterInput

Fields
Input Field Description
and - [PoscPersonFilterInput!]
or - [PoscPersonFilterInput!]
company_number - StringOperationFilterInput
is_sanctioned - BooleanOperationFilterInput
kind - StringOperationFilterInput
natures_of_control - StringOperationFilterInput
identification_country_registered - StringOperationFilterInput
identification_legal_authority - StringOperationFilterInput
identification_legal_form - StringOperationFilterInput
identification_place_registered - StringOperationFilterInput
identification_registration_number - StringOperationFilterInput
notified_on - DateTimeOperationFilterInput
ceased_on - DateTimeOperationFilterInput
Example
{
  "and": [PoscPersonFilterInput],
  "or": [PoscPersonFilterInput],
  "company_number": StringOperationFilterInput,
  "is_sanctioned": BooleanOperationFilterInput,
  "kind": StringOperationFilterInput,
  "natures_of_control": StringOperationFilterInput,
  "identification_country_registered": StringOperationFilterInput,
  "identification_legal_authority": StringOperationFilterInput,
  "identification_legal_form": StringOperationFilterInput,
  "identification_place_registered": StringOperationFilterInput,
  "identification_registration_number": StringOperationFilterInput,
  "notified_on": DateTimeOperationFilterInput,
  "ceased_on": DateTimeOperationFilterInput
}
Types

PoscPersonSortInput

Fields
Input Field Description
company_number - SortEnumType
is_sanctioned - SortEnumType
kind - SortEnumType
natures_of_control - SortEnumType
identification_country_registered - SortEnumType
identification_legal_authority - SortEnumType
identification_legal_form - SortEnumType
identification_place_registered - SortEnumType
identification_registration_number - SortEnumType
notified_on - SortEnumType
ceased_on - SortEnumType
Example
{
  "company_number": "ASC",
  "is_sanctioned": "ASC",
  "kind": "ASC",
  "natures_of_control": "ASC",
  "identification_country_registered": "ASC",
  "identification_legal_authority": "ASC",
  "identification_legal_form": "ASC",
  "identification_place_registered": "ASC",
  "identification_registration_number": "ASC",
  "notified_on": "ASC",
  "ceased_on": "ASC"
}
Types

PoscSummary

Fields
Field Name Description
total_current - Int!
total_previous - Int!
Example
{"total_current": 987, "total_previous": 987}
Types

PreviousSearchRecord

Fields
Field Name Description
searchDate - DateTime!
companyName - String
companyType - String!
singleSearchApplicant - Boolean!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "searchDate": "2007-12-03T10:15:30Z",
  "companyName": "xyz789",
  "companyType": "abc123",
  "singleSearchApplicant": false,
  "person": PersonalDetails,
  "associationType": "xyz789",
  "matchesApplicantName": true,
  "matchesApplicantDob": false
}
Types

Profit_Loss

Fields
Field Name Description
profit_loss_id - Long!
account_date - DateTime
no_weeks - Long
consolidated - String
currency - String
turnover - Long
cost_of_sales - Long
gross_profit - Long
operating_profit - Long
non_trading_income - Long
interest_payable - Long
pre_tax_profit - Long
taxation - Long
post_tax_profit - Long
dividends - Long
retained_profit - Long
value_added - Long
audit_fee - Long
director_renum - Long
non_audit_fee - Long
employees - Long
companies_company_id - Int!
ebitda - Long
Example
{
  "profit_loss_id": {},
  "account_date": "2007-12-03T10:15:30Z",
  "no_weeks": {},
  "consolidated": "abc123",
  "currency": "xyz789",
  "turnover": {},
  "cost_of_sales": {},
  "gross_profit": {},
  "operating_profit": {},
  "non_trading_income": {},
  "interest_payable": {},
  "pre_tax_profit": {},
  "taxation": {},
  "post_tax_profit": {},
  "dividends": {},
  "retained_profit": {},
  "value_added": {},
  "audit_fee": {},
  "director_renum": {},
  "non_audit_fee": {},
  "employees": {},
  "companies_company_id": 987,
  "ebitda": {}
}
Types

Profit_LossFilterInput

Fields
Input Field Description
and - [Profit_LossFilterInput!]
or - [Profit_LossFilterInput!]
profit_loss_id - LongOperationFilterInput
account_date - DateTimeOperationFilterInput
no_weeks - LongOperationFilterInput
consolidated - StringOperationFilterInput
currency - StringOperationFilterInput
turnover - LongOperationFilterInput
cost_of_sales - LongOperationFilterInput
gross_profit - LongOperationFilterInput
operating_profit - LongOperationFilterInput
non_trading_income - LongOperationFilterInput
interest_payable - LongOperationFilterInput
pre_tax_profit - LongOperationFilterInput
taxation - LongOperationFilterInput
post_tax_profit - LongOperationFilterInput
dividends - LongOperationFilterInput
retained_profit - LongOperationFilterInput
value_added - LongOperationFilterInput
audit_fee - LongOperationFilterInput
director_renum - LongOperationFilterInput
non_audit_fee - LongOperationFilterInput
employees - LongOperationFilterInput
companies_company_id - IntOperationFilterInput
ebitda - LongOperationFilterInput
Example
{
  "and": [Profit_LossFilterInput],
  "or": [Profit_LossFilterInput],
  "profit_loss_id": LongOperationFilterInput,
  "account_date": DateTimeOperationFilterInput,
  "no_weeks": LongOperationFilterInput,
  "consolidated": StringOperationFilterInput,
  "currency": StringOperationFilterInput,
  "turnover": LongOperationFilterInput,
  "cost_of_sales": LongOperationFilterInput,
  "gross_profit": LongOperationFilterInput,
  "operating_profit": LongOperationFilterInput,
  "non_trading_income": LongOperationFilterInput,
  "interest_payable": LongOperationFilterInput,
  "pre_tax_profit": LongOperationFilterInput,
  "taxation": LongOperationFilterInput,
  "post_tax_profit": LongOperationFilterInput,
  "dividends": LongOperationFilterInput,
  "retained_profit": LongOperationFilterInput,
  "value_added": LongOperationFilterInput,
  "audit_fee": LongOperationFilterInput,
  "director_renum": LongOperationFilterInput,
  "non_audit_fee": LongOperationFilterInput,
  "employees": LongOperationFilterInput,
  "companies_company_id": IntOperationFilterInput,
  "ebitda": LongOperationFilterInput
}
Types

PsamCategory

Description

A PSAM category

Fields
Field Name Description
id - UUID! Unique PSAM category identifier
name - String Name of the PSAM category
description - String Description of the PSAM category
psamMatchCategories - [PsamMatchCategory!]
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "name": "abc123",
  "description": "xyz789",
  "psamMatchCategories": [PsamMatchCategory]
}
Types

PsamCheckResult

Description

PSAM check result for a check

Fields
Field Name Description
id - UUID! Unique identifier for the PSAM check result
checkId - UUID ID of the associated check
status - String Overall status of the PSAM check
matchCount - Int Number of matches found
createdAt - DateTime When the PSAM check result was created
updatedAt - DateTime When the PSAM check result was last updated
vendor - String Vendor used for PSAM check
rawResponse - String Raw vendor response (JSON)
psamMatches - [PsamMatch] PSAM matches found
providerSearchId - String
check - CheckV2
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "checkId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "status": "abc123",
  "matchCount": 123,
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "vendor": "abc123",
  "rawResponse": "abc123",
  "psamMatches": [PsamMatch],
  "providerSearchId": "xyz789",
  "check": CheckV2
}
Types

PsamMatch

Description

A PSAM match found during screening

Fields
Field Name Description
id - UUID! Unique PSAM match identifier
psamCheckResultId - UUID Associated PSAM check result identifier
matchStatus - String Status of the match
riskLevel - String Risk level of the match
isWhitelisted - Boolean Whether this match is whitelisted
sourceId - String Source identifier
entityId - String Entity identifier
entityType - String Type of entity
name - String Name of the matched entity
dateOfBirth - DateTime Date of birth of the matched entity
nationality - String Nationality of the matched entity
country - String Country of the matched entity
matchScore - Float Match confidence score
aka - [String] Also known as information
matchTypes - [String] Match types
psamMatchAssociates - [PsamMatchAssociates] Associates associated with the PSAM match
psamMatchAssets - [PsamMatchAssets] Assets associated with the PSAM match
psamMatchPositions - [PsamMatchPosition] Positions associated with the PSAM match
psamMatchAddresses - [PsamMatchAddress] Addresses associated with the PSAM match
psamMatchDetails - [PsamMatchDetail] Details of the PSAM match
psamMatchCategories - [PsamMatchCategory] Categories associated with the PSAM match
psamMatchSources - [PsamMatchSource] Sources associated with the PSAM match
psamMatchMedia - [PsamMatchMedia] Media associated with the PSAM match
psamMatchSanctionDetails - [PsamMatchSanctionDetail] Sanction details associated with the PSAM match
psamMatchTypeDetails - [PsamMatchTypeDetail] Type details associated with the PSAM match
psamCheckResult - PsamCheckResult
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamCheckResultId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "matchStatus": "xyz789",
  "riskLevel": "xyz789",
  "isWhitelisted": false,
  "sourceId": "abc123",
  "entityId": "abc123",
  "entityType": "xyz789",
  "name": "xyz789",
  "dateOfBirth": "2007-12-03T10:15:30Z",
  "nationality": "xyz789",
  "country": "xyz789",
  "matchScore": 987.65,
  "aka": ["xyz789"],
  "matchTypes": ["xyz789"],
  "psamMatchAssociates": [PsamMatchAssociates],
  "psamMatchAssets": [PsamMatchAssets],
  "psamMatchPositions": [PsamMatchPosition],
  "psamMatchAddresses": [PsamMatchAddress],
  "psamMatchDetails": [PsamMatchDetail],
  "psamMatchCategories": [PsamMatchCategory],
  "psamMatchSources": [PsamMatchSource],
  "psamMatchMedia": [PsamMatchMedia],
  "psamMatchSanctionDetails": [PsamMatchSanctionDetail],
  "psamMatchTypeDetails": [PsamMatchTypeDetail],
  "psamCheckResult": PsamCheckResult
}
Types

PsamMatchAddress

Description

Address information for a PSAM match

Fields
Field Name Description
fullAddress - String Full address
country - String Country of the address
Example
{
  "fullAddress": "abc123",
  "country": "xyz789"
}
Types

PsamMatchAssets

Description

Assets associated with a PSAM match

Fields
Field Name Description
id - UUID! Unique asset identifier
psamMatchId - UUID Associated PSAM match identifier
url - String URL of the asset
type - String Type of the asset
source - String Source of the asset
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "url": "abc123",
  "type": "abc123",
  "source": "xyz789",
  "psamMatch": PsamMatch
}
Types

PsamMatchAssociates

Description

Associates associated with a PSAM match

Fields
Field Name Description
id - UUID! Unique associate identifier
psamMatchId - UUID Associated PSAM match identifier
name - String Name of the associate
type - String Type of the associate
comment - String Comment about the associate
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "name": "abc123",
  "type": "xyz789",
  "comment": "abc123",
  "psamMatch": PsamMatch
}
Types

PsamMatchCategory

Description

Category association for a PSAM match

Fields
Field Name Description
psamCategory - PsamCategory Associated PSAM category
psamMatchId - UUID!
psamCategoryId - UUID!
psamMatch - PsamMatch
Example
{
  "psamCategory": PsamCategory,
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamCategoryId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatch": PsamMatch
}
Types

PsamMatchDetail

Description

Detail information about a PSAM match

Fields
Field Name Description
id - UUID! Unique PSAM match detail identifier
psamMatchId - UUID Associated PSAM match identifier
fieldName - String Name of the field that was matched
matchedValue - String Value that was matched
matchType - String Type of match
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "fieldName": "xyz789",
  "matchedValue": "abc123",
  "matchType": "abc123",
  "psamMatch": PsamMatch
}
Types

PsamMatchMedia

Description

Media associated with a PSAM match

Fields
Field Name Description
id - UUID! Unique PSAM match media identifier
psamMatchId - UUID Associated PSAM match identifier
title - String Title of the media
url - String URL to the media content
contentSummary - String Summary of the media content
publishedAt - DateTime When the media was published
sourceName - String Name of the media source
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "title": "abc123",
  "url": "abc123",
  "contentSummary": "xyz789",
  "publishedAt": "2007-12-03T10:15:30Z",
  "sourceName": "abc123",
  "psamMatch": PsamMatch
}
Types

PsamMatchPosition

Description

Position information for a PSAM match

Fields
Field Name Description
country - String Country of the position
position - String Position title or role
Example
{
  "country": "xyz789",
  "position": "abc123"
}
Types

PsamMatchSanctionDetail

Description

Sanction details for a PSAM match

Fields
Field Name Description
id - UUID! Unique sanction detail identifier
psamMatchId - UUID! Associated PSAM match identifier
program - String Sanction program (e.g., 'SDN', 'UK Russia Regs')
listName - String Name of the sanction list (e.g., 'OFAC SDN', 'UK HMT Consolidated')
listReferenceNo - String Vendor/list UID if provided
sanctionType - String Type of sanctioned entity (PERSON, ENTITY, VESSEL, AIRCRAFT)
measures - String Sanction measures as JSON (e.g., ['ASSET_FREEZE','TRAVEL_BAN'])
url - String URL to the sanction listing
countryCodes - String Country codes associated with the sanction
listingStartDate - DateTime When the sanction listing started
listingEndDate - DateTime When the sanction listing ended (if applicable)
lastUpdated - DateTime When the listing was last updated
identifiers - String Entity identifiers as JSON (passports, tax IDs, IMO, etc.)
addresses - String Structured addresses array as JSON
createdAt - DateTime! When this record was created
updatedAt - DateTime! When this record was last updated
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "program": "abc123",
  "listName": "abc123",
  "listReferenceNo": "xyz789",
  "sanctionType": "abc123",
  "measures": "xyz789",
  "url": "abc123",
  "countryCodes": "xyz789",
  "listingStartDate": "2007-12-03T10:15:30Z",
  "listingEndDate": "2007-12-03T10:15:30Z",
  "lastUpdated": "2007-12-03T10:15:30Z",
  "identifiers": "xyz789",
  "addresses": "abc123",
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "psamMatch": PsamMatch
}
Types

PsamMatchSource

Description

Source association for a PSAM match

Fields
Field Name Description
psamSource - PsamSource Associated PSAM source
psamMatchId - UUID!
psamSourceId - UUID!
psamMatch - PsamMatch
Example
{
  "psamSource": PsamSource,
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamSourceId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatch": PsamMatch
}
Types

PsamMatchTypeDetail

Description

Type details for a PSAM match

Fields
Field Name Description
id - UUID! Unique type detail identifier
psamMatchId - UUID! Associated PSAM match identifier
field - String Field name (e.g., 'name', 'dateOfBirth', 'nationality')
type - String Type of match (e.g., 'exact_match', 'partial_match', 'fuzzy_match')
detail - String Detailed description of the match type
matchTypes - [String] Match types as JSON array (e.g., ['exact', 'partial'])
createdAt - DateTime! When this record was created
updatedAt - DateTime! When this record was last updated
psamMatch - PsamMatch
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "psamMatchId": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "field": "abc123",
  "type": "xyz789",
  "detail": "abc123",
  "matchTypes": ["xyz789"],
  "createdAt": "2007-12-03T10:15:30Z",
  "updatedAt": "2007-12-03T10:15:30Z",
  "psamMatch": PsamMatch
}
Types

PsamResult

Fields
Field Name Description
result - ResultEnum!
details - AmlResult
Example
{"result": "NOT_AVAILABLE", "details": AmlResult}
Types

PsamSource

Description

A PSAM source

Fields
Field Name Description
id - UUID! Unique PSAM source identifier
name - String Name of the PSAM source
url - String URL of the PSAM source
sourceType - String Type of the PSAM source
psamMatchSources - [PsamMatchSource] PSAM match sources associated with this source
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "name": "xyz789",
  "url": "abc123",
  "sourceType": "abc123",
  "psamMatchSources": [PsamMatchSource]
}
Types

RangeAggregationInput

Fields
Input Field Description
field - CompanyField
ranges - [RangeInput]
Example
{"field": "DIRECTORS_AGE_YEARS", "ranges": [RangeInput]}
Types

RangeInput

Fields
Input Field Description
key - String
from - Float!
to - Float!
Example
{
  "key": "xyz789",
  "from": 987.65,
  "to": 987.65
}
Types

RatingBreakdown

Fields
Field Name Description
threshold - Float
criteria_name - String
operator - Operators!
output - Float
range_end - Float
range_start - Float
result - Float
scorecard_name - String
value - Float
Example
{
  "threshold": 987.65,
  "criteria_name": "abc123",
  "operator": "GREATER_THAN",
  "output": 123.45,
  "range_end": 123.45,
  "range_start": 987.65,
  "result": 123.45,
  "scorecard_name": "abc123",
  "value": 987.65
}
Types

RatingBreakdownResult

Fields
Field Name Description
previous_rating - RfaRating
score - Float!
rating - RfaRating!
breakdown - [RatingBreakdown]
Example
{
  "previous_rating": "THREE_RED_FLAGS",
  "score": 123.45,
  "rating": "THREE_RED_FLAGS",
  "breakdown": [RatingBreakdown]
}
Types

Rating_historyCollectionSegment

Description

A segment of a collection.

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

RatioAnalysis

Fields
Field Name Description
liquidity_ratio - Decimal
profit_capital_employed - Decimal
current_ratio - Decimal
profit_sales - Decimal
interest_pre_interest_profit - Decimal
profit_total_assets - Decimal
profit_shareholder_funds - Decimal
turnover_total_assets - Decimal
turnover_fixed_assets - Decimal
working_capital_turnover - Decimal
total_debt_net_worth - Decimal
shareholders_funds_total_assets - Decimal
long_term_debt_net_worth - Decimal
total_debt_working_capital - Decimal
average_employee_remuneration - Decimal
wages_sales - Decimal
profit_per_employee - Decimal
sales_per_employee - Decimal
capital_employed_per_employee - Decimal
total_fixed_assets_per_employee - Decimal
total_assets_per_employee - Decimal
creditors_debtors - Decimal
debtors_total_assets - Decimal
current_liabilities_stocks - Decimal
export_sales - Decimal
sales_audit_fees - Decimal
total_assets_audit_fees - Decimal
account_date - DateTime
Example
{
  "liquidity_ratio": Decimal,
  "profit_capital_employed": Decimal,
  "current_ratio": Decimal,
  "profit_sales": Decimal,
  "interest_pre_interest_profit": Decimal,
  "profit_total_assets": Decimal,
  "profit_shareholder_funds": Decimal,
  "turnover_total_assets": Decimal,
  "turnover_fixed_assets": Decimal,
  "working_capital_turnover": Decimal,
  "total_debt_net_worth": Decimal,
  "shareholders_funds_total_assets": Decimal,
  "long_term_debt_net_worth": Decimal,
  "total_debt_working_capital": Decimal,
  "average_employee_remuneration": Decimal,
  "wages_sales": Decimal,
  "profit_per_employee": Decimal,
  "sales_per_employee": Decimal,
  "capital_employed_per_employee": Decimal,
  "total_fixed_assets_per_employee": Decimal,
  "total_assets_per_employee": Decimal,
  "creditors_debtors": Decimal,
  "debtors_total_assets": Decimal,
  "current_liabilities_stocks": Decimal,
  "export_sales": Decimal,
  "sales_audit_fees": Decimal,
  "total_assets_audit_fees": Decimal,
  "account_date": "2007-12-03T10:15:30Z"
}
Types

RatioAnalysisFilterInput

Fields
Input Field Description
and - [RatioAnalysisFilterInput!]
or - [RatioAnalysisFilterInput!]
liquidity_ratio - DecimalOperationFilterInput
profit_capital_employed - DecimalOperationFilterInput
current_ratio - DecimalOperationFilterInput
profit_sales - DecimalOperationFilterInput
interest_pre_interest_profit - DecimalOperationFilterInput
profit_total_assets - DecimalOperationFilterInput
profit_shareholder_funds - DecimalOperationFilterInput
turnover_total_assets - DecimalOperationFilterInput
turnover_fixed_assets - DecimalOperationFilterInput
working_capital_turnover - DecimalOperationFilterInput
total_debt_net_worth - DecimalOperationFilterInput
shareholders_funds_total_assets - DecimalOperationFilterInput
long_term_debt_net_worth - DecimalOperationFilterInput
total_debt_working_capital - DecimalOperationFilterInput
average_employee_remuneration - DecimalOperationFilterInput
wages_sales - DecimalOperationFilterInput
profit_per_employee - DecimalOperationFilterInput
sales_per_employee - DecimalOperationFilterInput
capital_employed_per_employee - DecimalOperationFilterInput
total_fixed_assets_per_employee - DecimalOperationFilterInput
total_assets_per_employee - DecimalOperationFilterInput
creditors_debtors - DecimalOperationFilterInput
debtors_total_assets - DecimalOperationFilterInput
current_liabilities_stocks - DecimalOperationFilterInput
export_sales - DecimalOperationFilterInput
sales_audit_fees - DecimalOperationFilterInput
total_assets_audit_fees - DecimalOperationFilterInput
account_date - DateTimeOperationFilterInput
Example
{
  "and": [RatioAnalysisFilterInput],
  "or": [RatioAnalysisFilterInput],
  "liquidity_ratio": DecimalOperationFilterInput,
  "profit_capital_employed": DecimalOperationFilterInput,
  "current_ratio": DecimalOperationFilterInput,
  "profit_sales": DecimalOperationFilterInput,
  "interest_pre_interest_profit": DecimalOperationFilterInput,
  "profit_total_assets": DecimalOperationFilterInput,
  "profit_shareholder_funds": DecimalOperationFilterInput,
  "turnover_total_assets": DecimalOperationFilterInput,
  "turnover_fixed_assets": DecimalOperationFilterInput,
  "working_capital_turnover": DecimalOperationFilterInput,
  "total_debt_net_worth": DecimalOperationFilterInput,
  "shareholders_funds_total_assets": DecimalOperationFilterInput,
  "long_term_debt_net_worth": DecimalOperationFilterInput,
  "total_debt_working_capital": DecimalOperationFilterInput,
  "average_employee_remuneration": DecimalOperationFilterInput,
  "wages_sales": DecimalOperationFilterInput,
  "profit_per_employee": DecimalOperationFilterInput,
  "sales_per_employee": DecimalOperationFilterInput,
  "capital_employed_per_employee": DecimalOperationFilterInput,
  "total_fixed_assets_per_employee": DecimalOperationFilterInput,
  "total_assets_per_employee": DecimalOperationFilterInput,
  "creditors_debtors": DecimalOperationFilterInput,
  "debtors_total_assets": DecimalOperationFilterInput,
  "current_liabilities_stocks": DecimalOperationFilterInput,
  "export_sales": DecimalOperationFilterInput,
  "sales_audit_fees": DecimalOperationFilterInput,
  "total_assets_audit_fees": DecimalOperationFilterInput,
  "account_date": DateTimeOperationFilterInput
}
Types

Recipient

Fields
Field Name Description
recipientEmail - String
isActive - Boolean!
Example
{
  "recipientEmail": "xyz789",
  "isActive": false
}
Types

RecipientInput

Fields
Input Field Description
recipientEmail - String
isActive - Boolean!
Example
{
  "recipientEmail": "xyz789",
  "isActive": false
}
Types

RefreshCredentialsInput

Description

Refresh details

Fields
Input Field Description
refreshToken - String Refresh token
Example
{"refreshToken": "abc123"}
Types

RegistrationNumber

Fields
Field Name Description
registrationNo - String
description - String
registrationClassDescription - String
registrationLocation - String
isPreferredRegistrationNumber - Boolean!
Example
{
  "registrationNo": "abc123",
  "description": "abc123",
  "registrationClassDescription": "abc123",
  "registrationLocation": "abc123",
  "isPreferredRegistrationNumber": true
}
Types

ReportLimit

Fields
Field Name Description
billingRegion - BillingRegion!
limit - Int!
Example
{"billingRegion": "REST_OF_WORLD", "limit": 987}
Types

RequestedBy

Fields
Field Name Description
name - String!
email - String!
Example
{
  "name": "xyz789",
  "email": "xyz789"
}
Types

ResultEnum

Values
Enum Value Description

NOT_AVAILABLE

ERROR

FAIL

REFER

PASS

OVERRIDDEN_PASS

OVERRIDDEN_FAIL
Example
"NOT_AVAILABLE"
Types

ResultValue

Fields
Field Name Description
type - ResultValueType!
result - TabulationResultEnum!
Example
{"type": "ADDRESS", "result": "ERROR"}
Types

ResultValueType

Values
Enum Value Description

ADDRESS

DATE_OF_BIRTH

FORENAME

SURNAME

DOCUMENT
Example
"ADDRESS"
Types

RfaRating

Values
Enum Value Description

THREE_RED_FLAGS

TWO_RED_FLAGS

ONE_RED_FLAG

BRONZE

SILVER

GOLD

NOT_TRADING

INSOLVENT

STRIKE_OFF

DISSOLVED

PRE_INSOLVENT

NEWLY_INCORPORATED

PROVISIONAL_TWO_RED_FLAGS

PROVISIONAL_ONE_RED_FLAG

PROVISIONAL_BRONZE

PROVISIONAL_SILVER

INACTIVE
Example
"THREE_RED_FLAGS"
Types

RiskOverviewItem

Fields
Field Name Description
value - String
reason - String
identifier - String
fullDescription - String
category - String
field - String
addressLink - String
Example
{
  "value": "abc123",
  "reason": "xyz789",
  "identifier": "xyz789",
  "fullDescription": "xyz789",
  "category": "xyz789",
  "field": "xyz789",
  "addressLink": "xyz789"
}
Types

RollingRegisterRecord

Fields
Field Name Description
supplyDate - DateTime!
recordType - String!
seniority - String!
person - PersonalDetails!
associationType - String!
matchesApplicantName - Boolean!
matchesApplicantDob - Boolean!
Example
{
  "supplyDate": "2007-12-03T10:15:30Z",
  "recordType": "abc123",
  "seniority": "xyz789",
  "person": PersonalDetails,
  "associationType": "xyz789",
  "matchesApplicantName": true,
  "matchesApplicantDob": false
}
Types

SIC07

Fields
Field Name Description
code - String
description - String
division - String
division_description - String
priority - String
section - String
section_description - String
sic_class - String
sic_class_description - String
source - String
sub_class - String
sub_class_description - String
Example
{
  "code": "abc123",
  "description": "xyz789",
  "division": "xyz789",
  "division_description": "xyz789",
  "priority": "xyz789",
  "section": "abc123",
  "section_description": "abc123",
  "sic_class": "xyz789",
  "sic_class_description": "xyz789",
  "source": "xyz789",
  "sub_class": "xyz789",
  "sub_class_description": "abc123"
}
Types

SIC07FilterInput

Fields
Input Field Description
and - [SIC07FilterInput!]
or - [SIC07FilterInput!]
code - StringOperationFilterInput
description - StringOperationFilterInput
division - StringOperationFilterInput
division_description - StringOperationFilterInput
priority - StringOperationFilterInput
section - StringOperationFilterInput
section_description - StringOperationFilterInput
sic_class - StringOperationFilterInput
sic_class_description - StringOperationFilterInput
source - StringOperationFilterInput
sub_class - StringOperationFilterInput
sub_class_description - StringOperationFilterInput
Example
{
  "and": [SIC07FilterInput],
  "or": [SIC07FilterInput],
  "code": StringOperationFilterInput,
  "description": StringOperationFilterInput,
  "division": StringOperationFilterInput,
  "division_description": StringOperationFilterInput,
  "priority": StringOperationFilterInput,
  "section": StringOperationFilterInput,
  "section_description": StringOperationFilterInput,
  "sic_class": StringOperationFilterInput,
  "sic_class_description": StringOperationFilterInput,
  "source": StringOperationFilterInput,
  "sub_class": StringOperationFilterInput,
  "sub_class_description": StringOperationFilterInput
}
Types

ScoreData

Fields
Field Name Description
value - Int!
scoreLabel - String!
positive - Boolean!
Example
{
  "value": 123,
  "scoreLabel": "abc123",
  "positive": false
}
Types

SearchType

Values
Enum Value Description

DIRECTOR

QUOTATION

INDIVIDUAL

PERSONNEL
Example
"DIRECTOR"
Types

ServiceAnnouncement

Description

Service announcement

Fields
Field Name Description
id - String Id
title - String Title
details - String Details
type - TypeOfServiceAnnouncement! Type
creationDate - DateTime! Date query created
Example
{
  "id": "abc123",
  "title": "abc123",
  "details": "abc123",
  "type": "SERVICE_ALERT",
  "creationDate": "2007-12-03T10:15:30Z"
}
Types

ServiceAnnouncementSortInput

Fields
Input Field Description
id - SortEnumType
title - SortEnumType
creationDate - SortEnumType
details - SortEnumType
type - SortEnumType
Example
{
  "id": "ASC",
  "title": "ASC",
  "creationDate": "ASC",
  "details": "ASC",
  "type": "ASC"
}
Types

Sex

Values
Enum Value Description

UNSPECIFIED

MALE

FEMALE
Example
"UNSPECIFIED"
Types

SexOperationFilterInput

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

Shareholder

Fields
Field Name Description
company_flag - String
title - String
first_name - String
surname - String
shareholder_class - String
share_quantity - Float
share_value - Decimal!
Example
{
  "company_flag": "abc123",
  "title": "xyz789",
  "first_name": "abc123",
  "surname": "xyz789",
  "shareholder_class": "xyz789",
  "share_quantity": 123.45,
  "share_value": Decimal
}
Types

ShareholderFilterInput

Fields
Input Field Description
and - [ShareholderFilterInput!]
or - [ShareholderFilterInput!]
company_flag - StringOperationFilterInput
title - StringOperationFilterInput
first_name - StringOperationFilterInput
surname - StringOperationFilterInput
shareholder_class - StringOperationFilterInput
share_quantity - FloatOperationFilterInput
share_value - DecimalOperationFilterInput
Example
{
  "and": [ShareholderFilterInput],
  "or": [ShareholderFilterInput],
  "company_flag": StringOperationFilterInput,
  "title": StringOperationFilterInput,
  "first_name": StringOperationFilterInput,
  "surname": StringOperationFilterInput,
  "shareholder_class": StringOperationFilterInput,
  "share_quantity": FloatOperationFilterInput,
  "share_value": DecimalOperationFilterInput
}
Types

SignInCredentialsInput

Description

Sign in details

Fields
Input Field Description
userName - String User name / email
password - String Password
Example
{
  "userName": "xyz789",
  "password": "abc123"
}
Types

SignInResponse

Description

Sign in token details

Fields
Field Name Description
accessToken - String Access token
refreshToken - String Refresh token
expiresInSeconds - Int! Expiry time in seconds of the access token
Example
{
  "accessToken": "abc123",
  "refreshToken": "abc123",
  "expiresInSeconds": 987
}
Types

SmsConfiguration

Fields
Field Name Description
alphaNumericSenderId - String
accountId - String
messagingServiceId - String
account - Account
Example
{
  "alphaNumericSenderId": "abc123",
  "accountId": "xyz789",
  "messagingServiceId": "abc123",
  "account": Account
}
Types

SmsConfigurationFilterInput

Fields
Input Field Description
and - [SmsConfigurationFilterInput!]
or - [SmsConfigurationFilterInput!]
accountId - StringOperationFilterInput
alphaNumericSenderId - StringOperationFilterInput
messagingServiceId - StringOperationFilterInput
account - AccountFilterInput
Example
{
  "and": [SmsConfigurationFilterInput],
  "or": [SmsConfigurationFilterInput],
  "accountId": StringOperationFilterInput,
  "alphaNumericSenderId": StringOperationFilterInput,
  "messagingServiceId": StringOperationFilterInput,
  "account": AccountFilterInput
}
Types

SmsConfigurationSortInput

Fields
Input Field Description
accountId - SortEnumType
alphaNumericSenderId - SortEnumType
messagingServiceId - SortEnumType
account - AccountSortInput
Example
{
  "accountId": "ASC",
  "alphaNumericSenderId": "ASC",
  "messagingServiceId": "ASC",
  "account": AccountSortInput
}
Types

SortEnumType

Values
Enum Value Description

ASC

DESC
Example
"ASC"
Types

SourceKey

Values
Enum Value Description

RFA

CREDIT_SAFE

DN_B

RFA_DUNS
Example
"RFA"
Types

SourceKeyOperationFilterInput

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

StatType

Values
Enum Value Description

TOTAL_CHECKS

PENDING_CHECKS

TIME_TAKEN_SECONDS
Example
"TOTAL_CHECKS"
Types

StatisticDetail

Description

Account statistics.

Fields
Field Name Description
change - Int! Velocity of change.
name - String Name of change.
value - Int! Value of change.
type - StatType! Type of statistic.
Example
{
  "change": 987,
  "name": "abc123",
  "value": 987,
  "type": "TOTAL_CHECKS"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

StringOperationFilterInput

Fields
Input Field Description
and - [StringOperationFilterInput!]
or - [StringOperationFilterInput!]
eq - String
neq - String
contains - String
ncontains - String
in - [String]
nin - [String]
startsWith - String
nstartsWith - String
endsWith - String
nendsWith - String
Example
{
  "and": [StringOperationFilterInput],
  "or": [StringOperationFilterInput],
  "eq": "abc123",
  "neq": "abc123",
  "contains": "abc123",
  "ncontains": "abc123",
  "in": ["abc123"],
  "nin": ["xyz789"],
  "startsWith": "abc123",
  "nstartsWith": "xyz789",
  "endsWith": "xyz789",
  "nendsWith": "xyz789"
}
Types

SubjectAddress

Fields
Field Name Description
name - String
number - String
street - String!
street2 - String
postCode - String!
town - String
district - String
county - String
country - String
timeAtAddress - String
Example
{
  "name": "abc123",
  "number": "xyz789",
  "street": "abc123",
  "street2": "xyz789",
  "postCode": "abc123",
  "town": "abc123",
  "district": "abc123",
  "county": "xyz789",
  "country": "abc123",
  "timeAtAddress": "abc123"
}
Types

SubjectAddressInput

Fields
Input Field Description
number - String!
street - String!
town - String
postCode - String!
timeAtAddress - String How long the subject has been at this address in ISO8601 Duration format, e.g. 'P5Y3M22D'. For more details see: https://en.wikipedia.org/wiki/ISO_8601#Durations
Example
{
  "number": "xyz789",
  "street": "xyz789",
  "town": "xyz789",
  "postCode": "abc123",
  "timeAtAddress": "xyz789"
}
Types

SubmittedData

Description

What was submited to generate this check.

Fields
Field Name Description
sex - Sex! Sex of user being checked.
title - Title! Title 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 Date of birth of user being checked.
email - String Email of user being checked.
landlineNumber - String Land line phone number of user being checked.
mobileNumber - String Mobile phone number of user being checked.
countryOfResidence - account_CountryCode! ISO Alpha-3 reference of country of residence of user being checked.
checkOptions - CheckOptions Options passed to generate the check.
checkAuthor - User Author who created the check.
identityDocuments - [CheckDetailIdentityDocument] Identity documents provided (i.e., passport, driving license, national insurance).
addresses - [CheckDetailAddress] Addresses provided to check.
Example
{
  "sex": "UNSPECIFIED",
  "title": "UNSPECIFIED",
  "firstName": "xyz789",
  "middleName": "xyz789",
  "lastName": "abc123",
  "dateOfBirth": "2007-12-03T10:15:30Z",
  "email": "xyz789",
  "landlineNumber": "xyz789",
  "mobileNumber": "abc123",
  "countryOfResidence": "AFG",
  "checkOptions": CheckOptions,
  "checkAuthor": User,
  "identityDocuments": [CheckDetailIdentityDocument],
  "addresses": [CheckDetailAddress]
}
Types

TabulationResultEnum

Values
Enum Value Description

ERROR

PASS

REFER

FAIL

NO_MATCH

NOT_INCLUDED
Example
"ERROR"
Types

TermsAggregationInput

Fields
Input Field Description
field - CompanyField
size - Int!
Example
{"field": "DIRECTORS_AGE_YEARS", "size": 123}
Types

Title

Values
Enum Value Description

UNSPECIFIED

MR

MRS

MASTER

MISS

MS

DOCTOR
Example
"UNSPECIFIED"
Types

TitleOperationFilterInput

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

TriggerEvent

Fields
Field Name Description
id - Int!
eventId - Event!
isImmediate - Boolean!
portfolioId - Int!
portfolio - Portfolio
eventType - EventType
Example
{
  "id": 987,
  "eventId": "NA",
  "isImmediate": true,
  "portfolioId": 987,
  "portfolio": Portfolio,
  "eventType": EventType
}
Types

TriggerEventFilterInput

Fields
Input Field Description
and - [TriggerEventFilterInput!]
or - [TriggerEventFilterInput!]
id - IntOperationFilterInput
eventId - EventOperationFilterInput
isImmediate - BooleanOperationFilterInput
portfolioId - IntOperationFilterInput
portfolio - PortfolioFilterInput
eventType - EventTypeFilterInput
Example
{
  "and": [TriggerEventFilterInput],
  "or": [TriggerEventFilterInput],
  "id": IntOperationFilterInput,
  "eventId": EventOperationFilterInput,
  "isImmediate": BooleanOperationFilterInput,
  "portfolioId": IntOperationFilterInput,
  "portfolio": PortfolioFilterInput,
  "eventType": EventTypeFilterInput
}
Types

TriggerEventInput

Fields
Input Field Description
triggerEvents - [TriggersInput]
portfolioId - Int!
Example
{"triggerEvents": [TriggersInput], "portfolioId": 123}
Types

Triggers

Fields
Field Name Description
eventId - Event!
isImmediate - Boolean!
isActive - Boolean!
Example
{"eventId": "NA", "isImmediate": false, "isActive": false}
Types

TriggersInput

Fields
Input Field Description
eventId - Event!
isImmediate - Boolean!
isActive - Boolean!
Example
{"eventId": "NA", "isImmediate": false, "isActive": true}
Types

TypeOfServiceAnnouncement

Values
Enum Value Description

SERVICE_ALERT

PRODUCT_ANNOUNCEMENT
Example
"SERVICE_ALERT"
Types

UUID

Example
"52057ee7-6edf-4066-9f92-e147e3c1505e"
Types

UkCheckRequestInput

Fields
Input Field Description
checkType - UkCheckTypeEnum!
reference - String
bulkReference - String
options - CheckOptionsInputType
checkBranding - CheckBrandingInput
checkDetail - CheckDetailInput
accountId - String
isMonitored - Boolean!
userEmail - String
Example
{
  "checkType": "IDV",
  "reference": "xyz789",
  "bulkReference": "abc123",
  "options": CheckOptionsInputType,
  "checkBranding": CheckBrandingInput,
  "checkDetail": CheckDetailInput,
  "accountId": "xyz789",
  "isMonitored": false,
  "userEmail": "abc123"
}
Types

UkCheckType

Description

UK ID Check Result

Fields
Field Name Description
submittedData - SubmittedData
checkDetails - Details
notifications - [CheckNotification]
outcome - Outcome
idv - IdvResult
aml - AmlTabulatedResult
psam - PsamResult
notes - [Note]
id - Int! Unique Identifier for UK ID Check Result
Example
{
  "submittedData": SubmittedData,
  "checkDetails": Details,
  "notifications": [CheckNotification],
  "outcome": Outcome,
  "idv": IdvResult,
  "aml": AmlTabulatedResult,
  "psam": PsamResult,
  "notes": [Note],
  "id": 987
}
Types

UkCheckTypeDetail

Fields
Field Name Description
checkType - UkCheckTypeEnum!
description - String
Example
{
  "checkType": "IDV",
  "description": "abc123"
}
Types

UkCheckTypeEnum

Values
Enum Value Description

IDV

AML

PSAM

IDV_PSAM

AML_PSAM

IDV_AML_PSAM

DOCUMENT_CHECK_AML_PSAM
Example
"IDV"
Types

User

Description

User

Fields
Field Name Description
id - String User ID
email - String User email
name - String User name
givenNames - String Given name
surname - String Surname
activeAccount - Account
roles - [UserRole] User Roles
Example
{
  "id": "abc123",
  "email": "abc123",
  "name": "abc123",
  "givenNames": "abc123",
  "surname": "abc123",
  "activeAccount": Account,
  "roles": [UserRole]
}
Types

UserFilterInput

Fields
Input Field Description
and - [UserFilterInput!]
or - [UserFilterInput!]
email - StringOperationFilterInput
name - StringOperationFilterInput
givenNames - StringOperationFilterInput
surname - StringOperationFilterInput
activeAccountId - StringOperationFilterInput
activeAccount - AccountFilterInput
accounts - ListFilterInputTypeOfAccountFilterInput
checks - ListFilterInputTypeOfCheckFilterInput
roles - ListFilterInputTypeOfUserRoleFilterInput
notes - ListFilterInputTypeOfNoteFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
Example
{
  "and": [UserFilterInput],
  "or": [UserFilterInput],
  "email": StringOperationFilterInput,
  "name": StringOperationFilterInput,
  "givenNames": StringOperationFilterInput,
  "surname": StringOperationFilterInput,
  "activeAccountId": StringOperationFilterInput,
  "activeAccount": AccountFilterInput,
  "accounts": ListFilterInputTypeOfAccountFilterInput,
  "checks": ListFilterInputTypeOfCheckFilterInput,
  "roles": ListFilterInputTypeOfUserRoleFilterInput,
  "notes": ListFilterInputTypeOfNoteFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput
}
Types

UserQueriesCollectionSegment

Description

A segment of a collection.

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

UserQuery

Description

User query

Fields
Field Name Description
id - UUID! Account Id
accountId - String Account Id
userId - String User email
queryName - String Query name
queryValue - String Query
variables - String Variables
createdDate - DateTime! Date query created
Example
{
  "id": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "accountId": "abc123",
  "userId": "xyz789",
  "queryName": "xyz789",
  "queryValue": "abc123",
  "variables": "xyz789",
  "createdDate": "2007-12-03T10:15:30Z"
}
Types

UserQueryFilterInput

Fields
Input Field Description
and - [UserQueryFilterInput!]
or - [UserQueryFilterInput!]
id - UuidOperationFilterInput
queryName - StringOperationFilterInput
queryValue - StringOperationFilterInput
variables - StringOperationFilterInput
createdDate - portfolio_DateTimeOperationFilterInput
rowsExported - IntOperationFilterInput
Example
{
  "and": [UserQueryFilterInput],
  "or": [UserQueryFilterInput],
  "id": UuidOperationFilterInput,
  "queryName": StringOperationFilterInput,
  "queryValue": StringOperationFilterInput,
  "variables": StringOperationFilterInput,
  "createdDate": portfolio_DateTimeOperationFilterInput,
  "rowsExported": IntOperationFilterInput
}
Types

UserQuerySortInput

Fields
Input Field Description
id - SortEnumType
accountId - SortEnumType
userId - SortEnumType
queryName - SortEnumType
queryValue - SortEnumType
variables - SortEnumType
createdDate - SortEnumType
rowsExported - SortEnumType
Example
{
  "id": "ASC",
  "accountId": "ASC",
  "userId": "ASC",
  "queryName": "ASC",
  "queryValue": "ASC",
  "variables": "ASC",
  "createdDate": "ASC",
  "rowsExported": "ASC"
}
Types

UserRole

Description

User Role

Fields
Field Name Description
type - UserRoleType! Role type
Example
{"type": "ADMINISTRATOR"}
Types

UserRoleFilterInput

Fields
Input Field Description
and - [UserRoleFilterInput!]
or - [UserRoleFilterInput!]
userEmail - StringOperationFilterInput
type - UserRoleTypeOperationFilterInput
user - UserFilterInput
account - AccountFilterInput
accountId - StringOperationFilterInput
Example
{
  "and": [UserRoleFilterInput],
  "or": [UserRoleFilterInput],
  "userEmail": StringOperationFilterInput,
  "type": UserRoleTypeOperationFilterInput,
  "user": UserFilterInput,
  "account": AccountFilterInput,
  "accountId": StringOperationFilterInput
}
Types

UserRoleType

Values
Enum Value Description

ADMINISTRATOR

ACCOUNT_USER
Example
"ADMINISTRATOR"
Types

UserRoleTypeOperationFilterInput

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

UserSearchType

Fields
Field Name Description
id - String User ID
email - String User Email
name - String User name
givenNames - String Given name
surname - String Surname
Example
{
  "id": "abc123",
  "email": "abc123",
  "name": "abc123",
  "givenNames": "abc123",
  "surname": "abc123"
}
Types

UserSortInput

Fields
Input Field Description
email - SortEnumType
name - SortEnumType
givenNames - SortEnumType
surname - SortEnumType
activeAccountId - SortEnumType
activeAccount - AccountSortInput
createdDate - SortEnumType
Example
{
  "email": "ASC",
  "name": "ASC",
  "givenNames": "ASC",
  "surname": "ASC",
  "activeAccountId": "ASC",
  "activeAccount": AccountSortInput,
  "createdDate": "ASC"
}
Types

UuidOperationFilterInput

Fields
Input Field Description
eq - UUID
neq - UUID
in - [UUID]
nin - [UUID]
gt - UUID
ngt - UUID
gte - UUID
ngte - UUID
lt - UUID
nlt - UUID
lte - UUID
nlte - UUID
Example
{
  "eq": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "neq": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "in": [
    "52057ee7-6edf-4066-9f92-e147e3c1505e"
  ],
  "nin": [
    "52057ee7-6edf-4066-9f92-e147e3c1505e"
  ],
  "gt": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "ngt": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "gte": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "ngte": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "lt": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "nlt": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "lte": "52057ee7-6edf-4066-9f92-e147e3c1505e",
  "nlte": "52057ee7-6edf-4066-9f92-e147e3c1505e"
}
Types

Verification

Fields
Field Name Description
id - Int!
checkId - Int!
check - Check
startedDate - DateTime
completedDate - DateTime
isCompleted - Boolean!
isStarted - Boolean!
type - VerificationType!
Example
{
  "id": 987,
  "checkId": 123,
  "check": Check,
  "startedDate": "2007-12-03T10:15:30Z",
  "completedDate": "2007-12-03T10:15:30Z",
  "isCompleted": true,
  "isStarted": false,
  "type": "ADDRESS"
}
Types

VerificationFilterInput

Fields
Input Field Description
and - [VerificationFilterInput!]
or - [VerificationFilterInput!]
id - IntOperationFilterInput
checkId - IntOperationFilterInput
check - CheckFilterInput
startedDate - portfolio_DateTimeOperationFilterInput
completedDate - portfolio_DateTimeOperationFilterInput
isCompleted - BooleanOperationFilterInput
isStarted - BooleanOperationFilterInput
type - VerificationTypeOperationFilterInput
Example
{
  "and": [VerificationFilterInput],
  "or": [VerificationFilterInput],
  "id": IntOperationFilterInput,
  "checkId": IntOperationFilterInput,
  "check": CheckFilterInput,
  "startedDate": portfolio_DateTimeOperationFilterInput,
  "completedDate": portfolio_DateTimeOperationFilterInput,
  "isCompleted": BooleanOperationFilterInput,
  "isStarted": BooleanOperationFilterInput,
  "type": VerificationTypeOperationFilterInput
}
Types

VerificationInput

Description

Verification Types

Fields
Input Field Description
type - VerificationType! Type of verification.
Example
{"type": "ADDRESS"}
Types

VerificationLinkResponse

Fields
Field Name Description
reference - String
message - String
verificationRequestUrl - String
verificationStartUrl - String
Example
{
  "reference": "abc123",
  "message": "xyz789",
  "verificationRequestUrl": "xyz789",
  "verificationStartUrl": "abc123"
}
Types

VerificationResult

Fields
Field Name Description
result - String
Example
{"result": "xyz789"}
Types

VerificationType

Values
Enum Value Description

ADDRESS

PEPS_AND_SANCTIONS

DIGITAL_ID

DOCUMENT_CHECK_AML

DOCUMENT_CHECK_ENHANCED_AML

NEGATIVE_MEDIA

PEPS_AND_SANCTIONS_UPDATE

AML
Example
"ADDRESS"
Types

VerificationTypeOperationFilterInput

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

WebHook

Description

WebHook

Fields
Field Name Description
id - Int! WebHook ID
url - String Url to call
Example
{"id": 123, "url": "abc123"}
Types

WebHookFilterInput

Fields
Input Field Description
and - [WebHookFilterInput!]
or - [WebHookFilterInput!]
id - IntOperationFilterInput
accountId - StringOperationFilterInput
url - StringOperationFilterInput
account - AccountFilterInput
Example
{
  "and": [WebHookFilterInput],
  "or": [WebHookFilterInput],
  "id": IntOperationFilterInput,
  "accountId": StringOperationFilterInput,
  "url": StringOperationFilterInput,
  "account": AccountFilterInput
}
Types

account_CountryCode

Values
Enum Value Description

AFG

ALB

DZA

ASM

AND

AGO

AIA

ATA

ATG

ARG

ARM

ABW

AUS

AUT

AZE

BHS

BHR

BGD

BRB

BLR

BEL

BLZ

BEN

BMU

BTN

BOL

BIH

BWA

BVT

BRA

IOT

BRN

BGR

BFA

BDI

CPV

KHM

CMR

CAN

CYM

CAF

TCD

CHL

CHN

CXR

CCK

COL

COM

COG

COD

COK

CRI

CIV

HRV

CUB

CYP

CZE

DNK

DJI

DMA

DOM

ECU

EGY

SLV

GNQ

ERI

EST

SWZ

ETH

FLK

FRO

FJI

FIN

FRA

GUF

PYF

ATF

GAB

GMB

GEO

DEU

GHA

GIB

GRC

GRL

GRD

GLP

GUM

GTM

GGY

GIN

GNB

GUY

HTI

HMD

VAT

HND

HKG

HUN

ISL

IND

IDN

IRN

IRQ

IRL

IMN

ISR

ITA

JAM

JPN

JEY

JOR

KAZ

KEN

KIR

PRK

KOR

KWT

KGZ

LAO

LVA

LBN

LSO

LBR

LBY

LIE

LTU

LUX

MAC

MDG

MWI

MYS

MDV

MLI

MLT

MHL

MTQ

MRT

MUS

MYT

MEX

FSM

MDA

MCO

MNG

MNE

MSR

MAR

MOZ

MMR

NAM

NRU

NPL

NLD

NCL

NZL

NIC

NER

NGA

NIU

NFK

MNP

MKD

NOR

OMN

PAK

PLW

PSE

PAN

PNG

PRY

PER

PHL

PCN

POL

PRT

PRI

QAT

REU

ROU

RUS

RWA

BLM

SHN

KNA

LCA

MAF

SPM

VCT

WSM

SMR

STP

SAU

SEN

SRB

SYC

SLE

SGP

SVK

SVN

SLB

SOM

ZAF

SGS

SSD

ESP

LKA

SDN

SUR

SJM

SWE

CHE

SYR

TWN

TJK

TZA

THA

TLS

TGO

TKL

TON

TTO

TUN

TUR

TKM

TCA

TUV

UGA

UKR

ARE

GBR

USA

UMI

URY

UZB

VUT

VEN

VNM

VGB

VIR

WLF

ESH

YEM

ZMB

ZWE

ALA
Example
"AFG"
Types

company_EventType

Values
Enum Value Description

NA

BUSINESS_ADDRESS_AMENDED

CCJ_SATISFIED

CCJ_NEW

COMPANY_RESTORATION

ACC_REF_DATE_CHANGE

REG_NAME_CHANGE

REG_ADDRESS_CHANGE

DISSOLUTION_FIRST_GAZETTE

DISSOLUTION_0

DISSOLUTION_9

GAZETTE_ADMIN_ORDER

GAZETTE_RECEIVER_APPOINTED

GAZETTE_BANKRUPTCY_ORDER

GAZETTE_CVA

GAZETTE_COMPANY_DISSOLVED

GAZETTE_PARTNERSHIP_DISSOLUTION

GAZETTE_HIGH_COURT_WRIT

GAZETTE_JOINT_ADMINISTRATORS_APPOINTED

GAZETTE_LIQUIDATOR_APPOINTED

GAZETTE_RECEIVER_LAND_PROPERTY

GAZETTE_CREDITORS_MEETING

GAZETTE_PETITION_DISMISSED

GAZETTE_WINDING_UP_PETITION

GAZETTE_PETITION_ADJOURNED

GAZETTE_PETITION_WITHDRAWN

GAZETTE_RECEIVER_MANAGER_APPOINTED

GAZETTE_RECEIVER_MANAGER_CEASING

GAZETTE_STRIKING_OFF_NOTICE_DISMISSED

GAZETTE_STRIKING_OFF_SUSPENDED

GAZETTE_STRIKING_OFF_APPLICATION

GAZETTE_STRIKING_OFF_NOTICE

GAZETTE_STRIKING_OFF_WITHDRAWN

GAZETTE_TRUST_DEED

GAZETTE_UNADVERTISED_PETITION_TO_WIND_UP

GAZETTE_VOLUNTARY_ARRANGEMENT_IN_DEFAULT

GAZETTE_VOLUNTARY_WINDING_UP

GAZETTE_WINDING_UP_ORDER_RESCINDED

GAZETTE_WINDING_UP_ORDER

MORTGAGE_AMENDMENT

SATISFIED_MORTGAGE

NEW_MORTGAGE

LATE_ACCOUNTS

SHAREHOLDER_ADDED

OFFICER_ADDED

OFFICER_RESIGNED

ACCOUNTS_ADDED

PAYMENT_TREND_CHANGE

CCJ_NEW_PROBABLE_MATCH

CCJ_NEW_POSSIBLE_MATCH

IMMINENT_COURT_HEARING

CREDIT_SCORE_INCREASE

CREDIT_SCORE_DECREASE

CREDIT_SCORE_CHANGE_20_POINTS

REVENUE_DROP_GT_10_PERCENT

COMPANY_INCORPORATED

CREDITOR_SERVICES

PRELIMINARY_NOTICE_OF_CREDITOR_ARRANGEMENT

COMPANY_RESTORATION_COURT_ORDER

COMPANY_RESTORATION_ADMINISTRATIVE_RESTORATION

LIQUIDITY_RATIO_DROP_GT_10_PERCENT

COHO_STATEMENT_OF_AFFAIRS

ASSET_VALUE_INCREASE_BY_GT_15_PERCENT

VOLUNTARY_DISSOLUTION_APPLICATION_SUSPENDED

LSE_PROFIT_WARNING

DEBT_EBITDA_RATIO

PRE_INSOLVENCY

CREDITOR_CLAIM_1_YEAR_WORKING_CAPITAL_GT_0_4

CREDITOR_CLAIM_1_YEAR_NET_WORTH_GT_0_4

RFA_RATING_CHANGE

GAZETTE_ANNUAL_LIQUIDATION_MEETINGS

GAZETTE_DEEMED_CONSENT

GAZETTE_FINAL_MEETINGS

GAZETTE_NOTICES_TO_MEMBERS

GAZETTE_NOTICE_OF_DIVIDEND

GAZETTE_NOTICE_OF_INTENDED_DIVIDEND

GAZETTE_NOTICE_TO_CREDITORS

GAZETTE_RESOLUTION_FOR_WINDING_UP

GAZETTE_SERVICE_OF_PETITION

POSC_CHANGE

HMCOURTS_NOTICE_INTENTION_APPOINT_ADMINISTRATOR

HMCOURTS_NOTICE_APPOINT_ADMINISTRATOR

HMCOURTS_ADMINISTRATION_APPLICATION

HMCOURTS_CVA

HMCOURTS_WINDING_UP_PETITION

HMCOURTS_INITIAL_STAGE_WINDING_UP_PETITION

HMCOURTS_WINDING_UP_PETITION_WITHDRAWN

RFA_RATING_RECLASSIFICATION

FAILURE_PROBABILITY_CHANGED

HMCOURTS_MORATORIUM_COMING_INTO_FORCE

ACCOUNTS_OVERDUE

CREDIT_LIMIT_INCREASED

CREDIT_LIMIT_DECREASED
Example
"NA"
Types

portfolio_DateTimeOperationFilterInput

Fields
Input Field Description
eq - DateTime
neq - DateTime
in - [DateTime]
nin - [DateTime]
gt - DateTime
ngt - DateTime
gte - DateTime
ngte - DateTime
lt - DateTime
nlt - DateTime
lte - DateTime
nlte - DateTime
Example
{
  "eq": "2007-12-03T10:15:30Z",
  "neq": "2007-12-03T10:15:30Z",
  "in": ["2007-12-03T10:15:30Z"],
  "nin": ["2007-12-03T10:15:30Z"],
  "gt": "2007-12-03T10:15:30Z",
  "ngt": "2007-12-03T10:15:30Z",
  "gte": "2007-12-03T10:15:30Z",
  "ngte": "2007-12-03T10:15:30Z",
  "lt": "2007-12-03T10:15:30Z",
  "nlt": "2007-12-03T10:15:30Z",
  "lte": "2007-12-03T10:15:30Z",
  "nlte": "2007-12-03T10:15:30Z"
}
Documentation by Anvil SpectaQL