UNPKG

@adyen/kyc-components

Version:

`adyen-kyc-components` provides the required pieces to build an onboarding flow based on a legal entity. To onboard and verify users, you need to create a user interface (UI) to collect user data. To speed up building your integration, Adyen offers onboar

431 lines (430 loc) 27.5 kB
import type { ExistingLegalEntity } from '../../core/models/api/legal-entity'; import type { QueryOptions } from '../types'; /** * Without id, this returns the root legal entity * With id it will return a child of the root (unless root is passed in) */ export declare const useLegalEntity: (id?: string, options?: QueryOptions<ExistingLegalEntity>) => { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; error: Error; isError: true; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: true; isSuccess: false; isPlaceholderData: false; status: "error"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; } | { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; error: null; isError: false; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: false; status: "success"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; } | { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; error: Error; isError: true; isPending: false; isLoading: false; isLoadingError: true; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "error"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; } | { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; error: null; isError: false; isPending: true; isLoading: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "pending"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; } | { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; error: null; isError: false; isPending: true; isLoadingError: false; isRefetchError: false; isSuccess: false; isPlaceholderData: false; status: "pending"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isLoading: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; } | { data: { documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }; isError: false; error: null; isPending: false; isLoading: false; isLoadingError: false; isRefetchError: false; isSuccess: true; isPlaceholderData: true; status: "success"; dataUpdatedAt: number; errorUpdatedAt: number; failureCount: number; failureReason: Error; errorUpdateCount: number; isFetched: boolean; isFetchedAfterMount: boolean; isFetching: boolean; isInitialLoading: boolean; isPaused: boolean; isRefetching: boolean; isStale: boolean; refetch: (options?: import("@tanstack/query-core").RefetchOptions) => Promise<import("@tanstack/query-core").QueryObserverResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>>; fetchStatus: import("@tanstack/query-core").FetchStatus; promise: Promise<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }>; }; export declare const useLegalEntities: (ids: string[], options?: QueryOptions<ExistingLegalEntity>) => import("@tanstack/react-query").DefinedUseQueryResult<{ documentDetails?: import("../../core/models/api/documentDetail").DocumentDetail[]; entityAssociations?: import("../../core/models/api/legal-entity-association").LegalEntityAssociation[]; individual?: import("../../core/models/api/individual").Individual; organization?: import("../../core/models/api/organization").Organization; soleProprietorship?: import("../../core/models/api/sole-proprietor").SoleProprietor; trust?: import("../../core/models/api/trust").Trust; unincorporatedPartnership?: import("../../core/models/api/unincorporated-partnership").UnincorporatedPartnership; capabilities?: Partial<Record<import("../../core/models/api/capability").CapabilityName, import("../../core/models/api/capability").Capability>>; problems?: import("../../core/models/api/problem").Problem[]; transferInstruments?: import("../../core/models/api/transfer-instrument").TransferInstrumentOverview[]; trustedFields?: import("../../core/models/api/legal-entity").LegalEntityTrustedFields[]; id: string; type: import("../../core/models/api/legal-entity-type").LegalEntityType; }, Error>[];