@adyen/kyc-components 1.3.0 → 1.3.2

package/dist/types/src/core/core.d.ts

@@ -0,0 +1,30 @@
+import { CoreOptions } from './types';
+import { ComponentMap } from '../components';
+declare class Core {
+    options: CoreOptions;
+    components: any[];
+    modules: any;
+    static readonly version: {
+        version: string;
+        revision: string;
+        branch: string;
+        buildId: string;
+    };
+    constructor(coreOptions: CoreOptions);
+    create<Name extends keyof ComponentMap>(formName: Name, options: any): ComponentMap[Name];
+    createForm<Name extends keyof ComponentMap>(formName: Name, options: any): ComponentMap[Name];
+    /**
+     * Updates global configurations, resets the internal state and remounts each element.
+     * @param options - props to update
+     * @returns this - the element instance
+     */
+    update: (options: any) => this;
+    updateLocale: (options: any) => this;
+    /**
+     * Remove the reference of a component
+     * @param component - reference to the component to be removed
+     * @returns this - the element instance
+     */
+    remove: (component: any) => this;
+}
+export default Core;

package/dist/types/src/core/core.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/src/core/errorMapping.d.ts

@@ -0,0 +1,3 @@
+import { RemediationCode } from './models/errors/remediation';
+import RemediationActionContext from './models/errors/remediation-action-context';
+export declare const remediationActionMappings: Partial<Record<RemediationCode, RemediationActionContext[]>>;

package/dist/types/src/core/hooks/useDataset.d.ts

@@ -0,0 +1,5 @@
+import { DataSet } from '../models/api/data-set';
+export declare function useDataset(datasetIdentifier: string, skip?: boolean): {
+    dataset: DataSet;
+    loaded: boolean;
+};

package/dist/types/src/core/models/api/address.d.ts

@@ -0,0 +1,18 @@
+export default interface Address {
+    city?: string;
+    country?: string;
+    postalCode?: string;
+    stateOrProvince?: string;
+    street?: string;
+    street2?: string;
+}
+export interface AddressLoqate {
+    description: string;
+    highlight: string;
+    id: string;
+    text: string;
+    type: string;
+}
+export interface AddressResponse {
+    results?: AddressLoqate[];
+}

package/dist/types/src/core/models/api/attachment.d.ts

@@ -0,0 +1,5 @@
+export default interface Attachment {
+    content: string;
+    pageType?: string;
+    pageName?: string;
+}

package/dist/types/src/core/models/api/capability.d.ts

@@ -0,0 +1,9 @@
+import { VerificationStatus } from './verification-status';
+import { Problem } from './problem';
+export default interface Capability {
+    enabled: string;
+    requested: string;
+    allowed: string;
+    problems: Problem[];
+    verificationStatus: VerificationStatus;
+}

package/dist/types/src/core/models/api/company-types-value.d.ts

@@ -0,0 +1,10 @@
+export declare enum CompanyTypesValue {
+    PRIVATE_COMPANY = "privateCompany",
+    PUBLIC_COMPANY = "listedPublicCompany",
+    UNLISTED_PUBLIC_COMPANY = "unlistedPublicCompany",
+    INCORPORATED_PARTNERSHIP = "partnershipIncorporated",
+    INCORPORATED_ASSOCIATION = "associationIncorporated",
+    GOVERNMENTAL_ORGANIZATION = "governmentalOrganization",
+    NON_PROFIT_OR_CHARITABLE = "nonProfit",
+    SOLE_PROPRIETORSHIP = "soleProprietorship"
+}

package/dist/types/src/core/models/api/configuration.d.ts

@@ -0,0 +1,17 @@
+import { TaskTypes } from '../../../components/TaskList/types';
+import { CountryBankVerificationVendors } from "../../../components/BankVerification/types";
+export default interface Configuration {
+    matchingScenario: {
+        NATURAL_PERSON?: string;
+        COMPANY?: string;
+    };
+    requiredFields?: {
+        payout?: {
+            currency: string;
+            bankStatementRequirement?: 'OPTIONAL' | 'REQUIRED';
+            fields: [];
+        };
+    };
+    taskList?: TaskTypes[];
+    bankVerificationProviders?: CountryBankVerificationVendors;
+}

package/dist/types/src/core/models/api/contracts.d.ts

@@ -0,0 +1,82 @@
+export interface PciTemplateRequest {
+    language: string;
+}
+export interface PciTemplateResponse extends PciTemplateRequest {
+    pciTemplateReferences: PciTemplateReferences;
+    content: string;
+}
+export interface PciQuestionnaires {
+    data: Array<PciQuestionnaire>;
+}
+export interface PciQuestionnaire {
+    id: string;
+    createdAt: string;
+    validUntil: string;
+}
+export interface DownloadPci extends PciQuestionnaire {
+    content: string;
+}
+export interface SignedBy {
+    signedBy: string;
+    pciTemplateReferences: PciTemplateReferences;
+}
+export interface PciTemplateReferences {
+    pciTemplateReferences: Array<string>;
+}
+export interface PciQuestionnaireIds {
+    ids: Array<string>;
+}
+export interface PciStatus {
+    signingRequired: string | boolean;
+    hasDocuments?: boolean;
+}
+export interface ServiceAgreementRequest {
+    type: string;
+    language: string;
+}
+export interface ServiceAgreementResponse extends ServiceAgreementRequest {
+    id: string;
+    termsOfServiceDocumentId: string;
+    document: string;
+}
+export interface ServiceAgreementSignRequest {
+    acceptedBy: string;
+}
+export interface ServiceAgreementSignResponse extends ServiceAgreementSignRequest {
+    id: string;
+    language: string;
+    termsOfServiceDocumentId: string;
+    type: string;
+}
+export interface ServiceAgreementStatus {
+    termsOfServiceTypes: Array<string>;
+}
+export interface AddressRequest {
+    country: string;
+    text: string;
+    container?: string;
+}
+export interface Address {
+    city?: string;
+    country?: string;
+    postalCode?: string;
+    stateOrProvince?: string;
+    street?: string;
+    houseNumberOrName?: string;
+}
+export interface AddressItem {
+    description: string;
+    highlight: string;
+    id: string;
+    text: string;
+    type: string;
+}
+export interface AddressResponse {
+    results: Array<AddressItem>;
+}
+export interface BankVerificationVendorsResponse {
+    vendors?: Array<{
+        name?: string;
+        redirectUrl?: string;
+    }>;
+}

package/dist/types/src/core/models/api/data-set.d.ts

@@ -0,0 +1,5 @@
+export declare type DataSet = DataSetItem[];
+export interface DataSetItem {
+    id: string;
+    name: string;
+}

package/dist/types/src/core/models/api/decision-maker-type.d.ts

@@ -0,0 +1,5 @@
+export declare enum DecisionMakerType {
+    CONTROLLING_PERSON = "uboThroughControl",
+    OWNER = "uboThroughOwnership",
+    SIGNATORY = "signatory"
+}

package/dist/types/src/core/models/api/document.d.ts

@@ -0,0 +1,25 @@
+import Attachment from './attachment';
+export default interface Document {
+    attachments: Attachment[];
+    description: string;
+    id?: string;
+    number?: string;
+    owner: {
+        id: string;
+        type: string;
+    };
+    type: DocumentType;
+}
+export declare enum DocumentType {
+    BANK_STATEMENT = "bankStatement",
+    DRIVERS_LICENSE = "driversLicense",
+    IDENTITY_CARD = "identityCard",
+    NATIONAL_ID_NUMBER = "nationalIdNumber",
+    PASSPORT = "passport",
+    PROOF_OF_ADDRESS = "proofOfAddress",
+    PROOF_OF_NATIONAL_ID_NUMBER = "proofOfNationalIdNumber",
+    PROOF_OF_RESIDENCY = "proofOfResidency",
+    REGISTRATION_DOCUMENT = "registrationDocument",
+    VAT_DOCUMENT = "vatDocument",
+    CONSTITUTIONAL_DOCUMENT = "constitutionalDocument"
+}

package/dist/types/src/core/models/api/entity-type.d.ts

@@ -0,0 +1,5 @@
+export declare enum EntityType {
+    BANK_ACCOUNT = "BankAccount",
+    LEGAL_ENTITY = "LegalEntity",
+    DOCUMENTS = "Documents"
+}

package/dist/types/src/core/models/api/id-verification-data.d.ts

@@ -0,0 +1,5 @@
+export default interface IdVerificationData {
+    status: number;
+    verified: string;
+    errorCode: string;
+}

package/dist/types/src/core/models/api/individual.d.ts

@@ -0,0 +1,23 @@
+import Phone from './phone';
+import Address from './address';
+export default interface Individual {
+    birthData?: {
+        dateOfBirth: string;
+    };
+    email?: string;
+    identificationData?: {
+        issuerState?: string;
+        nationalIdExempt: boolean;
+        number?: string;
+        type?: string;
+        cardNumber?: string;
+    };
+    name: {
+        firstName: string;
+        infix?: string;
+        lastName: string;
+    };
+    nationality?: string;
+    phone?: Phone;
+    residentialAddress: Address;
+}

package/dist/types/src/core/models/api/instant-id-verification.d.ts

@@ -0,0 +1,27 @@
+import { OnfidoCaptureSchema } from '../../../components/IdDocumentUpload/types';
+export interface InstantIdVerificationTokenRequest {
+    name: {
+        firstName: string;
+        lastName: string;
+    };
+    country: string;
+    origin: string;
+}
+export interface InstantIdVerificationTokenResponse {
+    id: string;
+    operationStatus: {
+        status: string;
+    };
+    sdkToken: string;
+}
+export interface InstantIdVerificationStartCheckRequest {
+    legalEntityId: string;
+    captureMetadata: OnfidoCaptureSchema;
+}
+export interface InstantIdVerificationStartCheckResponse {
+    checkId: string;
+    operationStatus: {
+        status: string;
+    };
+    reference: string;
+}

package/dist/types/src/core/models/api/legal-entity-association.d.ts

@@ -0,0 +1,12 @@
+import { DecisionMakerType } from './decision-maker-type';
+import { LegalEntityType } from './legal-entity-type';
+import { TrustMemberType } from './trust-member-type';
+export declare type LegalEntityAssociationType = DecisionMakerType | TrustMemberType | LegalEntityType.TRUST | LegalEntityType.SOLE_PROPRIETORSHIP;
+export default interface LegalEntityAssociation {
+    jobTitle?: string;
+    legalEntityId: string;
+    type: LegalEntityAssociationType;
+    name?: string;
+    entityType?: LegalEntityType;
+    associatorId?: string;
+}

package/dist/types/src/core/models/api/legal-entity-type.d.ts

@@ -0,0 +1,6 @@
+export declare enum LegalEntityType {
+    INDIVIDUAL = "individual",
+    ORGANIZATION = "organization",
+    TRUST = "trust",
+    SOLE_PROPRIETORSHIP = "soleProprietorship"
+}

package/dist/types/src/core/models/api/legal-entity.d.ts

@@ -0,0 +1,25 @@
+import LegalEntityAssociation from './legal-entity-association';
+import Individual from './individual';
+import Organization from './organization';
+import Capability from './capability';
+import Trust from './trust';
+import { LegalEntityType } from './legal-entity-type';
+import SoleProprietor from './soleProprietor';
+export default interface LegalEntity {
+    id?: string;
+    documentDetails?: {
+        id: string;
+    }[];
+    entityAssociations?: LegalEntityAssociation[];
+    individual?: Individual;
+    organization?: Organization;
+    soleProprietorship?: SoleProprietor;
+    trust?: Trust;
+    type?: LegalEntityType;
+    capabilities?: {
+        [key: string]: Capability;
+    };
+    transferInstruments?: {
+        id: string;
+    }[];
+}

package/dist/types/src/core/models/api/organization.d.ts

@@ -0,0 +1,30 @@
+import Phone from './phone';
+import Address from './address';
+import { CompanyTypesValue } from './company-types-value';
+export default interface Organization {
+    description?: string;
+    doingBusinessAs?: string;
+    email?: string;
+    legalName: string;
+    phone?: Phone;
+    principalPlaceOfBusiness?: Address;
+    registeredAddress: Address;
+    registrationNumber?: string;
+    stockData?: {
+        marketIdentifier: string;
+        stockNumber: string;
+        tickerSymbol: string;
+    };
+    taxInformation?: TaxInformation[];
+    vatNumber?: string;
+    vatAbsenceReason?: VatAbsenceReason;
+    type?: CompanyTypesValue;
+}
+export declare const vatAbsenceReasons: readonly ["industryExemption", "belowTaxThreshold"];
+export declare type VatAbsenceReason = typeof vatAbsenceReasons[number];
+export declare type TaxInformation = {
+    country: string;
+    number: string;
+    type: TaxInformationType;
+};
+export declare type TaxInformationType = 'SSN' | 'EIN' | 'ITIN' | 'ABN';

package/dist/types/src/core/models/api/phone.d.ts

@@ -0,0 +1,5 @@
+export default interface Phone {
+    countryCode: string;
+    number: string;
+    type: 'mobile' | 'landline' | 'sip' | 'fax';
+}

package/dist/types/src/core/models/api/problem.d.ts

@@ -0,0 +1,13 @@
+import { EntityType } from './entity-type';
+import VerificationError from './verification-error';
+export interface Problem {
+    entity: {
+        id: string;
+        type: EntityType;
+        owner?: {
+            id: string;
+            type: EntityType;
+        };
+    };
+    verificationErrors: VerificationError[];
+}

package/dist/types/src/core/models/api/remediating-action.d.ts

@@ -0,0 +1,4 @@
+export interface RemediatingAction {
+    code: string;
+    message: string;
+}

package/dist/types/src/core/models/api/soleProprietor.d.ts

@@ -0,0 +1,13 @@
+import Address from './address';
+import { VatAbsenceReason, TaxInformation } from './organization';
+export default interface SoleProprietor {
+    name: string;
+    doingBusinessAs: string;
+    countryOfGoverningLaw: string;
+    taxInformation: TaxInformation[];
+    vatNumber: string;
+    vatAbsenceReason: VatAbsenceReason;
+    registrationNumber: string;
+    registeredAddress: Address;
+    principalPlaceOfBusiness: Address;
+}

package/dist/types/src/core/models/api/transfer-instrument.d.ts

@@ -0,0 +1,25 @@
+export default interface TransferInstrument {
+    bankAccount: {
+        accountNumber: string;
+        accountType: string;
+        bankBicSwift: string;
+        bankCode: string;
+        bankName: string;
+        branchCode: string;
+        checkCode: string;
+        bankCity: string;
+        countryCode: string;
+        currencyCode: string;
+        iban: string;
+    };
+    documentDetails?: {
+        id: string;
+    }[];
+    legalEntityId: string;
+    type: TransferInstrumentType;
+    id?: string;
+}
+export declare enum TransferInstrumentType {
+    BANK_ACCOUNT = "bankAccount",
+    RECURRING_DETAIL = "recurringDetail"
+}

package/dist/types/src/core/models/api/trust-member-type.d.ts

@@ -0,0 +1,7 @@
+export declare enum TrustMemberType {
+    DEFINED_BENEFICIARY = "definedBeneficiary",
+    PROTECTOR = "protector",
+    SECONDARY_TRUSTEE = "secondaryTrustee",
+    SETTLOR = "settlor",
+    UBO_THROUGH_OWNERSHIP = "uboThroughOwnership"
+}

package/dist/types/src/core/models/api/trust-types-value.d.ts

@@ -0,0 +1,17 @@
+export declare enum TrustTypes {
+    CASH_MANAGEMENT_TRUST = "cashManagementTrust",
+    CORPORATE_UNIT_TRUST = "corporateUnitTrust",
+    DECEASED_ESTATE = "deceasedEstate",
+    DISCRETIONARY_INVESTMENT_TRUST = "discretionaryInvestmentTrust",
+    DISCRETIONARY_SERVICES_MANAGEMENT_TRUST = "discretionaryServicesManagementTrust",
+    DISCRETIONARY_TRADING_TRUST = "discretionaryTradingTrust",
+    FIRST_HOME_SAVER_ACCOUNTS_TRUST = "firstHomeSaverAccountsTrust",
+    FIXED_TRUST = "fixedTrust",
+    FIXED_UNIT_TRUST = "fixedUnitTrust",
+    HYBRID_TRUST = "hybridTrust",
+    LISTED_PUBLIC_UNIT_TRUST = "listedPublicUnitTrust",
+    OTHER_TRUST = "otherTrust",
+    POOLED_SUPERANNUATION_TRUST = "pooledSuperannuationTrust",
+    PUBLIC_TRADING_TRUST = "publicTradingTrust",
+    UNLISTED_PUBLIC_UNIT_TRUST = "unlistedPublicUnitTrust"
+}

package/dist/types/src/core/models/api/trust.d.ts

@@ -0,0 +1,14 @@
+import Address from './address';
+import { TrustTypes } from './trust-types-value';
+import { VatAbsenceReason } from './organization';
+export default interface Trust {
+    name: string;
+    doingBusinessAs: string;
+    type: TrustTypes;
+    countryOfGoverningLaw: string;
+    vatNumber: string;
+    vatAbsenceReason: VatAbsenceReason;
+    registrationNumber: string;
+    registeredAddress: Address;
+    principalPlaceOfBusiness: Address;
+}

package/dist/types/src/core/models/api/verification-error.d.ts

@@ -0,0 +1,13 @@
+import { RemediationCode } from '../errors/remediation';
+export default interface VerificationError {
+    code: RemediationCode;
+    message: string;
+    type: VeriificationErrorType;
+    subErrors?: VerificationError[];
+    remediatingActions?: VerificationError[];
+}
+export declare enum VeriificationErrorType {
+    DATA_MISSING = "dataMissing",
+    INVALID_INPUT = "invalidInput",
+    PENDING_STATUS = "pendingStatus"
+}

package/dist/types/src/core/models/api/verification-status.d.ts

@@ -0,0 +1,6 @@
+export declare enum VerificationStatus {
+    VALID = "valid",
+    PENDING = "pending",
+    INVALID = "invalid",
+    REJECTED = "rejected"
+}

package/dist/types/src/core/models/company.d.ts

@@ -0,0 +1,18 @@
+import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
+import { CountryConfig } from './country-config';
+import { TranslationKey } from '../../language/types';
+interface CompanyTypeModel {
+    id: string;
+    name: TranslationKey;
+    description: string;
+}
+export declare const companyBase: {
+    [key: string]: ScenarioFieldSettings;
+};
+export declare const taxIdBase: {
+    [key: string]: ScenarioFieldSettings;
+};
+export declare const companyTypes: readonly CompanyTypeModel[];
+export declare const fieldsPerScenario: ScenarioFields<typeof companyBase>;
+export declare const countryConfig: CountryConfig;
+export {};

package/dist/types/src/core/models/country-config.d.ts

@@ -0,0 +1,10 @@
+import { TranslationKey } from '../../language/types';
+export declare type CountryConfig = {
+    [key: string]: {
+        [key: string]: CountryFieldConfig;
+    };
+};
+export interface CountryFieldConfig {
+    label?: TranslationKey;
+    placeholder?: TranslationKey;
+}

package/dist/types/src/core/models/currency.d.ts

@@ -0,0 +1,19 @@
+export declare enum Currency {
+    AUD = "AUD",
+    BGN = "BGN",
+    BRL = "BRL",
+    CAD = "CAD",
+    CHF = "CHF",
+    CZK = "CZK",
+    DKK = "DKK",
+    EUR = "EUR",
+    GBP = "GBP",
+    HUF = "HUF",
+    HRK = "HRK",
+    PLN = "PLN",
+    NOK = "NOK",
+    RON = "RON",
+    SGD = "SGD",
+    SEK = "SEK",
+    USD = "USD"
+}

package/dist/types/src/core/models/decision-maker.d.ts

@@ -0,0 +1,68 @@
+import { DecisionMakerType } from './api/decision-maker-type';
+/**
+ *
+ * When providing DECISION_MAKER_COUNT_RANGE configuration per country - keep in mind that you need to specify rules for each role individually even if you have a mixed rule between them.
+ *
+ * This give us more flexibility to have:
+ * 1- rules for each role
+ * 2- different rules for mixed roles if there's any
+ *
+ * Examples
+ * A- provide at most 4 (controlling person - or - owners) but at least it should have 1 owner ...
+ * B- provide at least 1 (controlling person - or - an owner) but max 4 owners and no max for controlling ...
+ *
+ * @example
+ * let's say we want to write the config for the above [example B] it should look like this:
+ * ```
+ * [
+ *     {
+ *         // === the mixed rule  ===
+ *         roleTypes: [DecisionMakerType.CONTROLLING_PERSON, DecisionMakerType.OWNER],
+ *          min: 1,
+ *          max: Infinity
+ *      },
+ *      {
+ *          // === specify each individually ===
+ *          roleTypes: [DecisionMakerType.OWNER],
+ *          min: 0,
+ *          max: 4
+ *      },
+ *      {
+ *          // === specify each individually ===
+ *          roleTypes: [DecisionMakerType.CONTROLLING_PERSON],
+ *          min: 0,
+ *          max: Infinity
+ *      }
+ * ]
+ * ```
+ *
+ * each of the rules have different max to apply.
+ *
+ * */
+export declare const DEFAULT_DECISION_MAKER_COUNT_RANGE: ({
+    roleTypes: DecisionMakerType[];
+    min: number;
+    max?: undefined;
+} | {
+    roleTypes: DecisionMakerType[];
+    min: number;
+    max: number;
+})[];
+export declare const US_BR_DECISION_MAKER_COUNT_RANGE: {
+    roleTypes: DecisionMakerType[];
+    min: number;
+    max: number;
+}[];
+export declare const getDecisionMakerCountRangeConfig: (country: string) => ({
+    roleTypes: DecisionMakerType[];
+    min: number;
+    max?: undefined;
+} | {
+    roleTypes: DecisionMakerType[];
+    min: number;
+    max: number;
+})[];
+export declare const getDecisionMakerDescriptions: (country: string) => {
+    roleType: DecisionMakerType[];
+    description: string;
+}[];

package/dist/types/src/core/models/errors/capability-problems.d.ts

@@ -0,0 +1,7 @@
+import { EntityType } from '../api/entity-type';
+import { EntityProblems } from './entity-problems';
+export declare type CapabilityProblems = {
+    [entityType in EntityType]: {
+        [entityId: string]: EntityProblems;
+    };
+};

package/dist/types/src/core/models/errors/entity-problems.d.ts

@@ -0,0 +1,17 @@
+import { FormVerificationErrors } from './form-verification-errors';
+import { Remediation, RemediationCode } from './remediation';
+import { TaskStatus } from '../../../components/TaskList/types';
+import VerificationError from '../api/verification-error';
+export declare type EntityProblems = {
+    verificationErrors: {
+        [formId: string]: FormVerificationErrors;
+    };
+    remediationActions: Partial<Record<RemediationCode, Remediation>>;
+    status: TaskStatus;
+    missingData: VerificationError[];
+    validationErrors?: {
+        [formId: string]: {
+            [fieldName: string]: any;
+        };
+    };
+};