@adyen/kyc-components/dist/types/api/companySearch/useCompanySearch.d.ts

This guide assumes that you have already an account with Adyen. A legalEntity needs to be created, and you need to have a `legalEntityId` to instatiate a Component.

import type { UserEvents } from '../../core/user-events';
import type { QueryOptions } from '../types';
import type { CompanySearchRequest, CompanySearchResponse } from './companySearch.types';
export type QueryKeyCompanySearch = ['companySearch', CompanySearchRequest];
/**
 * Supports querying declaratively (`useCompanySearch` hook) and imperatively
 * (`queryClient.fetchQuery()`) with the same config, ensuring no deviation occurs
 * between the two types.
 */
export declare const companySearchQueryOptions: (rootLegalEntityId: string, baseUrl: string, data: CompanySearchRequest, userEvents: UserEvents, options?: QueryOptions<CompanySearchResponse>) => import("@tanstack/preact-query").OmitKeyof<import("@tanstack/preact-query").UseQueryOptions<{
    provider: import("./companySearch.contract").components["schemas"]["Provider"];
    results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
}, Error, {
    provider: import("./companySearch.contract").components["schemas"]["Provider"];
    results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
}, import("../queryKeys").QueryKey>, "queryFn"> & {
    queryFn?: import("@tanstack/preact-query").QueryFunction<{
        provider: import("./companySearch.contract").components["schemas"]["Provider"];
        results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
    }, import("../queryKeys").QueryKey, never> | undefined;
} & {
    queryKey: ([] & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../termsOfService/useAcceptedTermsOfService").QueryKeyAcceptedTermsOfService & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../address/useAddressCleanse").QueryKeyAddressCleanse & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../uiAnalytics/useAnalyticsSession").QueryKeyAnalyticsSession & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../transferInstruments/transferInstruments.types").QueryKeyBankVerificationProviders & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../businessLines/useBusinessLines").QueryKeyBusinessLines & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../check/useCheck").QueryKeyCheckAsAService & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../companyDataSet/handleCompanyDataset").QueryKeyCompanyDataset & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (QueryKeyCompanySearch & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../documents/useDocument").QueryKeyDocument & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../documents/useDocuments").QueryKeyDocuments & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../documentValidation/useDocumentValidate").QueryKeyDocumentValidation & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../idNowProvider/useIdNowProvider").QueryKeyIdNowProviderIdentificationStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../idNowProvider/useIdNowProvider").QueryKeyIdNowProviderStartIdentification & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../idVerificationProviders/useIdVerificationToken").QueryKeyIdVerificationToken & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../industryCodes/useIndustryCodes").QueryKeyIndustryCodes & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../invitations/useInvitationStatus").QueryKeyInvitationStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../invitedEntity/useInvitedEntityAssociationData").QueryKeyInvitedEntityAssociationData & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../legalEntity/useLegalEntity").QueryKeyLegalEntity & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../datasets/useLegalForms").QueryKeyLegalForms & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../datasets/useNaceCodes").QueryKeyNaceCodes & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../onboardingStatus/useOnboardingStatus").QueryKeyOnboardingStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../openId/useOpenIdAuthorizationLink").QueryKeyOpenIdAuthorizationLink & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../pci/usePciQuestionnaireList").QueryKeyPciQuestionnaireList & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../pci/usePciStatus").QueryKeyPciStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../pci/usePciTemplate").QueryKeyPciTemplate & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../providersConfiguration/useProviderStatus").QueryKeyProvidersStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../address/useRetrieveAddress").QueryKeyRetrieveAddress & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../configurations/useScenarios").QueryKeyScenarios & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../address/useSearchAddress").QueryKeySearchAddress & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../datasets/useSourceOfFundsTypes").QueryKeySourceOfFundsTypes & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../configurations/useSupportedCountries").QueryKeySupportedCountries & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../taskStatus/useTaskStatus").QueryKeyTaskStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../configurations/useTaskTypes").QueryKeyTaskTypes & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../taxClassification/useTaxClassification").QueryKeyTaxClassification & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../termsOfService/useTermsOfService").QueryKeyTermsOfService & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../termsOfService/useTermsOfServiceAcceptanceInfos").QueryKeyTermsOfServiceAcceptanceInfos & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../termsOfService/useTermsOfServiceStatus").QueryKeyTermsOfServiceStatus & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../toggles/useToggles").QueryKeyToggles & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../transferInstruments/useTransferInstrument").QueryKeyTransferInstrument & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../transferInstruments/useTransferInstruments").QueryKeyTransferInstruments & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../transferInstruments/useUpdateTrustedTransferInstrument").QueryKeyTrustedTransferInstrument & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../validation/useValidatePhoneNumber").QueryKeyValidatePhoneNumber & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../tinVerification/useVerifyTin").QueryKeyVerifyTin & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../configurations/useVersionConfiguration").QueryKeyVersionConfiguration & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    }) | (import("../invitedEntity/useInvitedEntityRootCapabilities").QueryKeyInvitedEntityRootCapabilities & {
        [dataTagSymbol]: {
            provider: import("./companySearch.contract").components["schemas"]["Provider"];
            results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
        };
        [dataTagErrorSymbol]: Error;
    });
};
export declare const useCompanySearch: (data: CompanySearchRequest, options?: QueryOptions<CompanySearchResponse>) => import("@tanstack/preact-query").UseQueryResult<{
    provider: import("./companySearch.contract").components["schemas"]["Provider"];
    results: import("./companySearch.contract").components["schemas"]["ProviderAgnosticSearchCompanyResult"][];
}, Error>;