@adyen/kyc-components/dist/types/api/legalEntity/useLegalEntity.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 { SkipToken } from '@tanstack/preact-query';
import type { ExistingLegalEntity } from '../../core/models/api/legal-entity';
import type { QueryOptions } from '../types';
/**
 * Variables:
 * * `legalEntityId`
 */
export type QueryKeyLegalEntity = ['legalEntity', string];
export declare const ROOT_LE: unique symbol;
/**
 * Retrieves a given legal entity.
 *
 * @param id can be:
 * * a specific LE id
 * * or `ROOT_LE` if you want the root LE without knowing its ID
 * * or `skipToken` as a way to type-safely disable the query
 */
export declare const useLegalEntity: (id: string | typeof ROOT_LE | SkipToken, options?: Omit<QueryOptions<ExistingLegalEntity>, "enabled">) => {
    refetch: (options?: import("@tanstack/preact-query").RefetchOptions) => Promise<import("@tanstack/preact-query").QueryObserverResult<{
        documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
        entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
        individual?: import("../../core/models/api/individual").Individual | undefined;
        organization?: import("../../core/models/api/organization").Organization | undefined;
        soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
        trust?: import("../../core/models/api/trust").Trust | undefined;
        unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
        capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
        problems?: import("../../core/models/api/problem").Problem[] | undefined;
        transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
        trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
        id: string;
        type: import("../../core/models/api/legal-entity-type").LegalEntityType;
    }, Error>>;
    isLoading: boolean;
    isError: boolean;
    data: {
        documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
        entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
        individual?: import("../../core/models/api/individual").Individual | undefined;
        organization?: import("../../core/models/api/organization").Organization | undefined;
        soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
        trust?: import("../../core/models/api/trust").Trust | undefined;
        unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
        capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
        problems?: import("../../core/models/api/problem").Problem[] | undefined;
        transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
        trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
        id: string;
        type: import("../../core/models/api/legal-entity-type").LegalEntityType;
    } | undefined;
};
export declare const useLegalEntities: (ids: string[], options?: QueryOptions<ExistingLegalEntity>) => (import("@tanstack/preact-query").QueryObserverLoadingErrorResult<{
    documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
    entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
    individual?: import("../../core/models/api/individual").Individual | undefined;
    organization?: import("../../core/models/api/organization").Organization | undefined;
    soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
    trust?: import("../../core/models/api/trust").Trust | undefined;
    unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
    capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
    problems?: import("../../core/models/api/problem").Problem[] | undefined;
    transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
    trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
    id: string;
    type: import("../../core/models/api/legal-entity-type").LegalEntityType;
}, Error> | import("@tanstack/preact-query").QueryObserverLoadingResult<{
    documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
    entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
    individual?: import("../../core/models/api/individual").Individual | undefined;
    organization?: import("../../core/models/api/organization").Organization | undefined;
    soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
    trust?: import("../../core/models/api/trust").Trust | undefined;
    unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
    capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
    problems?: import("../../core/models/api/problem").Problem[] | undefined;
    transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
    trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
    id: string;
    type: import("../../core/models/api/legal-entity-type").LegalEntityType;
}, Error> | import("@tanstack/preact-query").QueryObserverPendingResult<{
    documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
    entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
    individual?: import("../../core/models/api/individual").Individual | undefined;
    organization?: import("../../core/models/api/organization").Organization | undefined;
    soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
    trust?: import("../../core/models/api/trust").Trust | undefined;
    unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
    capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
    problems?: import("../../core/models/api/problem").Problem[] | undefined;
    transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
    trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
    id: string;
    type: import("../../core/models/api/legal-entity-type").LegalEntityType;
}, Error> | import("@tanstack/preact-query").QueryObserverPlaceholderResult<{
    documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
    entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
    individual?: import("../../core/models/api/individual").Individual | undefined;
    organization?: import("../../core/models/api/organization").Organization | undefined;
    soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
    trust?: import("../../core/models/api/trust").Trust | undefined;
    unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
    capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
    problems?: import("../../core/models/api/problem").Problem[] | undefined;
    transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
    trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
    id: string;
    type: import("../../core/models/api/legal-entity-type").LegalEntityType;
}, Error> | import("@tanstack/preact-query").DefinedUseQueryResult<{
    documentDetails?: import("../../core/models/api/document").DocumentDetail[] | undefined;
    entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[] | undefined;
    individual?: import("../../core/models/api/individual").Individual | undefined;
    organization?: import("../../core/models/api/organization").Organization | undefined;
    soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor | undefined;
    trust?: import("../../core/models/api/trust").Trust | undefined;
    unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership | undefined;
    capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>> | undefined;
    problems?: import("../../core/models/api/problem").Problem[] | undefined;
    transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[] | undefined;
    trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[] | undefined;
    id: string;
    type: import("../../core/models/api/legal-entity-type").LegalEntityType;
}, Error>)[];