@adyen/kyc-components 1.6.2 → 2.1.0

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

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

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

@@ -1,5 +1,5 @@
 import { EntityType } from './entity-type';
-import VerificationError from './verification-error';
+import { VerificationError } from './verification-error';
 export interface Problem {
     entity: {
         id: string;

package/dist/types/core/models/api/review.d.ts

@@ -0,0 +1,3 @@
+export interface ReviewCompletion {
+    confirmedAt: string;
+}

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

@@ -1,6 +1,6 @@
-import Address from './address';
-import { VatAbsenceReason, TaxInformation } from './organization';
-export default interface SoleProprietor {
+import { Address } from './address';
+import { TaxInformation, VatAbsenceReason } from './organization';
+export interface SoleProprietor {
     name: string;
     doingBusinessAs: string;
     countryOfGoverningLaw: string;

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

@@ -1,25 +1,37 @@
-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;
-    }[];
+import { DocumentDetail } from './documentDetail';
+export interface BankAccount {
+    accountNumber: string;
+    accountType: string;
+    bankBicSwift: string;
+    bankCode?: string;
+    bankName: string;
+    branchCode: string;
+    checkCode?: string;
+    bankCity?: string;
+    countryCode: string;
+    currencyCode: string;
+    iban?: string;
+    realLastFour?: string;
+    virtualAccountNumber?: boolean;
+    trustedSource?: boolean;
+}
+export interface TransferInstrumentOverview {
+    id: string;
+    accountIdentifier: string;
+    realLastFour?: string;
+    trustedSource?: boolean;
+}
+export interface TransferInstrument {
+    id: string;
     legalEntityId: string;
+    bankAccount: BankAccount;
     type: TransferInstrumentType;
-    id?: string;
+    documentDetails?: DocumentDetail[];
 }
 export declare enum TransferInstrumentType {
     BANK_ACCOUNT = "bankAccount",
     RECURRING_DETAIL = "recurringDetail"
 }
+export declare function isTransferInstrument(account: TransferInstrument | TransferInstrumentOverview): account is TransferInstrument;
+export declare const isInstantVerifiedAccount: (account: TransferInstrument | TransferInstrumentOverview) => boolean;
+export declare const getMaskedAccountNumber: ({ accountIdentifier, realLastFour, }: TransferInstrumentOverview) => string;

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

@@ -1,7 +1,8 @@
-export declare enum TrustMemberType {
+export declare enum TrustMemberTypes {
     DEFINED_BENEFICIARY = "definedBeneficiary",
+    UNDEFINED_BENEFICIARY = "undefinedBeneficiary",
     PROTECTOR = "protector",
-    SECONDARY_TRUSTEE = "secondaryTrustee",
-    SETTLOR = "settlor",
-    UBO_THROUGH_OWNERSHIP = "uboThroughOwnership"
+    TRUSTEE = "trustee",
+    SETTLOR = "settlor"
 }
+export type TrustMemberType = `${TrustMemberTypes}`;

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

@@ -1,14 +1,20 @@
-import Address from './address';
+import { Address } from './address';
+import { TaxInformation, VatAbsenceReason } from './organization';
 import { TrustTypes } from './trust-types-value';
-import { VatAbsenceReason } from './organization';
-export default interface Trust {
+export interface Trust {
     name: string;
-    doingBusinessAs: string;
-    type: TrustTypes;
+    doingBusinessAs?: string;
+    type?: TrustTypes;
     countryOfGoverningLaw: string;
-    vatNumber: string;
-    vatAbsenceReason: VatAbsenceReason;
-    registrationNumber: string;
+    vatNumber?: string;
+    vatAbsenceReason?: VatAbsenceReason;
+    taxInformation?: TaxInformation[];
+    registrationNumber?: string;
     registeredAddress: Address;
-    principalPlaceOfBusiness: Address;
+    principalPlaceOfBusiness?: Address;
+    undefinedBeneficiaryInfo?: UndefinedBeneficiaryInfo[];
+}
+export interface UndefinedBeneficiaryInfo {
+    description: string;
+    reference: string;
 }

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

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

package/dist/types/core/models/api/verify-id-number.d.ts

@@ -0,0 +1,14 @@
+import type { CountryCode } from '../country-code';
+export interface VerifyIdNumberRequest {
+    name: {
+        firstName: string;
+        lastName: string;
+    };
+    countryCode: CountryCode;
+    idNumber: string;
+}
+export interface VerifyIdNumberResponse {
+    status: number;
+    verified: string;
+    errorCode: string;
+}

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

@@ -1,10 +1,11 @@
-import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
-import { CountryConfig } from './country-config';
 import { TranslationKey } from '../../language/types';
+import { CompanyTypesValue } from './api/company-types-value';
+import { CountryConfig } from './country-config';
+import { ScenarioFields, ScenarioFieldSettings } from './scenario-fields';
 interface CompanyTypeModel {
-    id: string;
+    id: CompanyTypesValue;
     name: TranslationKey;
-    description: string;
+    description: TranslationKey;
 }
 export declare const companyBase: {
     [key: string]: ScenarioFieldSettings;

package/dist/types/core/models/country-code.d.ts

@@ -0,0 +1,249 @@
+export declare const enum CountryCodes {
+    Afghanistan = "AF",
+    AlandIslands = "AX",
+    Albania = "AL",
+    Algeria = "DZ",
+    AmericanSamoa = "AS",
+    Andorra = "AD",
+    Angola = "AO",
+    Anguilla = "AI",
+    Antarctica = "AQ",
+    AntiguaAndBarbuda = "AG",
+    Argentina = "AR",
+    Armenia = "AM",
+    Aruba = "AW",
+    Australia = "AU",
+    Austria = "AT",
+    Azerbaijan = "AZ",
+    Bahamas = "BS",
+    Bahrain = "BH",
+    Bangladesh = "BD",
+    Barbados = "BB",
+    Belarus = "BY",
+    Belgium = "BE",
+    Belize = "BZ",
+    Benin = "BJ",
+    Bermuda = "BM",
+    Bhutan = "BT",
+    Bolivia = "BO",
+    BonaireSintEustatiusSaba = "BQ",
+    BosniaAndHerzegovina = "BA",
+    Botswana = "BW",
+    BouvetIsland = "BV",
+    Brazil = "BR",
+    BritishIndianOceanTerritory = "IO",
+    BruneiDarussalam = "BN",
+    Bulgaria = "BG",
+    BurkinaFaso = "BF",
+    Burundi = "BI",
+    Cambodia = "KH",
+    Cameroon = "CM",
+    Canada = "CA",
+    CapeVerde = "CV",
+    CaymanIslands = "KY",
+    CentralAfricanRepublic = "CF",
+    Chad = "TD",
+    Chile = "CL",
+    China = "CN",
+    ChristmasIsland = "CX",
+    CocosKeelingIslands = "CC",
+    Colombia = "CO",
+    Comoros = "KM",
+    Congo = "CG",
+    CongoDemocraticRepublic = "CD",
+    CookIslands = "CK",
+    CostaRica = "CR",
+    CoteDIvoire = "CI",
+    Croatia = "HR",
+    Cuba = "CU",
+    Curacao = "CW",
+    Cyprus = "CY",
+    CzechRepublic = "CZ",
+    Denmark = "DK",
+    Djibouti = "DJ",
+    Dominica = "DM",
+    DominicanRepublic = "DO",
+    Ecuador = "EC",
+    Egypt = "EG",
+    ElSalvador = "SV",
+    EquatorialGuinea = "GQ",
+    Eritrea = "ER",
+    Estonia = "EE",
+    Ethiopia = "ET",
+    FalklandIslands = "FK",
+    FaroeIslands = "FO",
+    Fiji = "FJ",
+    Finland = "FI",
+    France = "FR",
+    FrenchGuiana = "GF",
+    FrenchPolynesia = "PF",
+    FrenchSouthernTerritories = "TF",
+    Gabon = "GA",
+    Gambia = "GM",
+    Georgia = "GE",
+    Germany = "DE",
+    Ghana = "GH",
+    Gibraltar = "GI",
+    Greece = "GR",
+    Greece_ISO_639_1 = "EL",
+    Greenland = "GL",
+    Grenada = "GD",
+    Guadeloupe = "GP",
+    Guam = "GU",
+    Guatemala = "GT",
+    Guernsey = "GG",
+    Guinea = "GN",
+    GuineaBissau = "GW",
+    Guyana = "GY",
+    Haiti = "HT",
+    HeardIslandMcdonaldIslands = "HM",
+    HolySeeVaticanCityState = "VA",
+    Honduras = "HN",
+    HongKong = "HK",
+    Hungary = "HU",
+    Iceland = "IS",
+    India = "IN",
+    Indonesia = "ID",
+    Iran = "IR",
+    Iraq = "IQ",
+    Ireland = "IE",
+    IsleOfMan = "IM",
+    Israel = "IL",
+    Italy = "IT",
+    Jamaica = "JM",
+    Japan = "JP",
+    Jersey = "JE",
+    Jordan = "JO",
+    Kazakhstan = "KZ",
+    Kenya = "KE",
+    Kiribati = "KI",
+    Korea = "KR",
+    KoreaDemocraticPeoplesRepublic = "KP",
+    Kuwait = "KW",
+    Kyrgyzstan = "KG",
+    LaoPeoplesDemocraticRepublic = "LA",
+    Latvia = "LV",
+    Lebanon = "LB",
+    Lesotho = "LS",
+    Liberia = "LR",
+    LibyanArabJamahiriya = "LY",
+    Liechtenstein = "LI",
+    Lithuania = "LT",
+    Luxembourg = "LU",
+    Macao = "MO",
+    Macedonia = "MK",
+    Madagascar = "MG",
+    Malawi = "MW",
+    Malaysia = "MY",
+    Maldives = "MV",
+    Mali = "ML",
+    Malta = "MT",
+    MarshallIslands = "MH",
+    Martinique = "MQ",
+    Mauritania = "MR",
+    Mauritius = "MU",
+    Mayotte = "YT",
+    Mexico = "MX",
+    Micronesia = "FM",
+    Moldova = "MD",
+    Monaco = "MC",
+    Mongolia = "MN",
+    Montenegro = "ME",
+    Montserrat = "MS",
+    Morocco = "MA",
+    Mozambique = "MZ",
+    Myanmar = "MM",
+    Namibia = "NA",
+    Nauru = "NR",
+    Nepal = "NP",
+    Netherlands = "NL",
+    NewCaledonia = "NC",
+    NewZealand = "NZ",
+    Nicaragua = "NI",
+    Niger = "NE",
+    Nigeria = "NG",
+    Niue = "NU",
+    NorfolkIsland = "NF",
+    NorthernMarianaIslands = "MP",
+    Norway = "NO",
+    Oman = "OM",
+    Pakistan = "PK",
+    Palau = "PW",
+    PalestinianTerritory = "PS",
+    Panama = "PA",
+    PapuaNewGuinea = "PG",
+    Paraguay = "PY",
+    Peru = "PE",
+    Philippines = "PH",
+    Pitcairn = "PN",
+    Poland = "PL",
+    Portugal = "PT",
+    PuertoRico = "PR",
+    Qatar = "QA",
+    Reunion = "RE",
+    Romania = "RO",
+    RussianFederation = "RU",
+    Rwanda = "RW",
+    SaintHelena = "SH",
+    SaintKittsAndNevis = "KN",
+    SaintLucia = "LC",
+    SaintPierreAndMiquelon = "PM",
+    SaintVincentAndGrenadines = "VC",
+    Samoa = "WS",
+    SanMarino = "SM",
+    SaoTomeAndPrincipe = "ST",
+    SaudiArabia = "SA",
+    Senegal = "SN",
+    Serbia = "RS",
+    Seychelles = "SC",
+    SierraLeone = "SL",
+    Singapore = "SG",
+    Slovakia = "SK",
+    Slovenia = "SI",
+    SolomonIslands = "SB",
+    Somalia = "SO",
+    SouthAfrica = "ZA",
+    SouthGeorgiaAndSandwichIsl = "GS",
+    Spain = "ES",
+    SriLanka = "LK",
+    Sudan = "SD",
+    Suriname = "SR",
+    SvalbardAndJanMayen = "SJ",
+    Swaziland = "SZ",
+    Sweden = "SE",
+    Switzerland = "CH",
+    SyrianArabRepublic = "SY",
+    Taiwan = "TW",
+    Tajikistan = "TJ",
+    Tanzania = "TZ",
+    Thailand = "TH",
+    TimorLeste = "TL",
+    Togo = "TG",
+    Tokelau = "TK",
+    Tonga = "TO",
+    TrinidadAndTobago = "TT",
+    Tunisia = "TN",
+    Turkey = "TR",
+    Turkmenistan = "TM",
+    TurksAndCaicosIslands = "TC",
+    Tuvalu = "TV",
+    Uganda = "UG",
+    Ukraine = "UA",
+    UnitedArabEmirates = "AE",
+    UnitedKingdom = "GB",
+    UnitedStates = "US",
+    UnitedStatesOutlyingIslands = "UM",
+    Uruguay = "UY",
+    Uzbekistan = "UZ",
+    Vanuatu = "VU",
+    Venezuela = "VE",
+    Vietnam = "VN",
+    VirginIslandsBritish = "VG",
+    VirginIslandsUS = "VI",
+    WallisAndFutuna = "WF",
+    WesternSahara = "EH",
+    Yemen = "YE",
+    Zambia = "ZM",
+    Zimbabwe = "ZW"
+}
+export type CountryCode = `${CountryCodes}`;

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

@@ -1,9 +1,8 @@
 import { TranslationKey } from '../../language/types';
-export declare type CountryConfig = {
-    [key: string]: {
-        [key: string]: CountryFieldConfig;
-    };
-};
+import { CountryCode } from './country-code';
+export type CountryConfig = Partial<Record<CountryCode, {
+    [field: string]: CountryFieldConfig;
+}>>;
 export interface CountryFieldConfig {
     label?: TranslationKey;
     placeholder?: TranslationKey;

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

@@ -1,5 +1,5 @@
-import { DecisionMakerType } from './api/decision-maker-type';
 import { TranslationKey } from '../../language/types';
+import { DecisionMakerType } from './api/decision-maker-type';
 /**
  *
  * When providing DECISION_MAKER_REQUIREMENTS per country - keep in mind that you need to specify rules for each role individually even if you have a mixed rule between them.
@@ -47,5 +47,9 @@ export interface DecisionMakerRequirement {
     max: number;
 }
 export declare const getDecisionMakerRequirements: (country: string) => readonly DecisionMakerRequirement[];
-export declare function getAvailableDecisionMakerRoleTypes(country: string): DecisionMakerType[];
+export declare function getAvailableDecisionMakerRoleTypes(country: string): {
+    roleType: DecisionMakerType;
+    min: number;
+    max: number;
+}[];
 export declare const getDecisionMakerDescriptionMap: (country: string) => Record<DecisionMakerType, TranslationKey>;

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

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

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

@@ -1,8 +1,10 @@
+import { TaskStatus } from '../../../components/TaskList/types';
+import { EntityType } from '../api/entity-type';
+import { LegalEntityType } from '../api/legal-entity-type';
+import { VerificationError } from '../api/verification-error';
 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 = {
+export type EntityProblems = {
     verificationErrors: {
         [formId: string]: FormVerificationErrors;
     };
@@ -11,7 +13,9 @@ export declare type EntityProblems = {
     missingData: VerificationError[];
     validationErrors?: {
         [formId: string]: {
-            [fieldName: string]: any;
+            [fieldName: string]: boolean;
         };
     };
+    entityType?: LegalEntityType | EntityType.BANK_ACCOUNT;
+    isReviewRequired?: boolean;
 };

package/dist/types/core/models/errors/error-message.d.ts

@@ -1,7 +1,7 @@
 import { TranslationKey } from '../../../language/types';
-export declare type ErrorCode = Extract<TranslationKey, `errorMessage_${string}`> extends `errorMessage_${infer R}` ? R : never;
+export type ErrorCode = Extract<TranslationKey, `errorMessage_${string}`> extends `errorMessage_${infer R}` ? R : never;
 export interface ErrorMessage {
     code: ErrorCode;
     errorMessage: string;
-    remediationMessages?: Array<string>;
+    remediationMessages?: string[];
 }

package/dist/types/core/models/errors/form-verification-errors.d.ts

@@ -1,3 +1,3 @@
-import { Remediation } from './remediation';
 import { ErrorCode } from './error-message';
-export declare type FormVerificationErrors = Partial<Record<ErrorCode, Partial<Record<ErrorCode, Remediation[]>>>>;
+import { Remediation } from './remediation';
+export type FormVerificationErrors = Partial<Record<ErrorCode, Partial<Record<ErrorCode, Remediation[]>>>>;

package/dist/types/core/models/errors/maintenance-mode-error.d.ts

@@ -0,0 +1,7 @@
+export interface MaintenanceModeError {
+    message: string;
+    messageCode: 'maintenanceMode';
+    reference: string;
+    statusCode: 503;
+}
+export declare const isMaintenanceModeError: (error: Error | undefined) => boolean;

package/dist/types/core/models/errors/remediation-action-context.d.ts

@@ -1,4 +1,4 @@
-export default interface RemediationActionContext {
+export interface RemediationActionContext {
     key: string;
     type?: string[];
 }

package/dist/types/core/models/errors/remediation.d.ts

@@ -1,7 +1,7 @@
 import { TranslationKey } from '../../../language/types';
-export declare type RemediationCode = Extract<TranslationKey, `remediationMessage_${string}`> extends `remediationMessage_${infer R}` ? R : never;
+export type RemediationCode = Extract<TranslationKey, `remediationMessage_${string}`> extends `remediationMessage_${infer R}` ? R : never;
 export interface Remediation {
     code: RemediationCode;
     forms: string[];
-    fields: string[];
+    fields?: string[];
 }

package/dist/types/core/models/errors/validation-error.d.ts

@@ -12,3 +12,8 @@ export interface ValidationError {
     invalidFields: InvalidField[];
     errorCode: string;
 }
+export declare const isValidationError: (error: Error | undefined) => boolean;
+export interface ValidationResponse {
+    invalidFields: InvalidField[];
+    valid: boolean;
+}

package/dist/types/core/models/field-configurations.d.ts

@@ -1,8 +1,8 @@
-import { ScenarioFieldSettings } from './scenario-fields';
 import { CountryFieldConfig } from './country-config';
+import { ScenarioFieldSettings } from './scenario-fields';
 interface FieldConfiguration<FieldType> extends ScenarioFieldSettings<FieldType>, CountryFieldConfig {
 }
-declare type FieldConfigurations<FormSchema> = {
+export type FieldConfigurations<FormSchema> = {
     [key in keyof FormSchema]: FieldConfiguration<FormSchema[key]>;
 };
-export default FieldConfigurations;
+export {};

package/dist/types/core/models/form-labels.d.ts

@@ -1,4 +1,4 @@
-export declare type FormLabels = (data: {
+export type FormLabels = (data: {
     [key: string]: any;
 }, country: string) => {
     [key: string]: () => string | null;

package/dist/types/core/models/form-rules.d.ts

@@ -1,20 +1,18 @@
 import { TaskTypes } from '../../components/TaskList/types';
 import { SettingName } from '../Context/SettingsContext/types';
 import { TopLevelDataSchema } from '../Context/StateContext/types';
-interface FormRulesParams<TLDS extends TopLevelDataSchema> {
+import { CountryCode } from './country-code';
+export interface FormRulesParams<TLDS extends TopLevelDataSchema> {
     data: TLDS;
-    country: string;
+    country: CountryCode;
     taskType: TaskTypes;
-    isSettingEnabled: (setting: SettingName) => boolean;
-    requiredFields: {
-        payout?: {
-            currency: string;
-            bankStatementRequirement?: 'OPTIONAL' | 'REQUIRED';
-            fields: [];
-        };
+    isSettingEnabled?: (setting: SettingName) => boolean;
+    requiredFields?: {
+        currency?: string;
+        bankStatementRequirement?: 'OPTIONAL' | 'REQUIRED';
+        fields?: [];
     };
 }
-export declare type FormRules<TLDS extends TopLevelDataSchema> = (params: FormRulesParams<TLDS>) => {
-    [ruleName: string]: () => string | null | boolean;
+export type FormRules<TLDS extends TopLevelDataSchema> = (params: FormRulesParams<TLDS>) => {
+    [ruleName: string]: () => string | boolean | undefined;
 };
-export {};

package/dist/types/core/models/form.d.ts

@@ -1,18 +1,18 @@
 import { TranslationKey } from '../../language/types';
-export interface Form {
+export interface FormModel {
     formId: string;
     formName: TranslationKey;
-    fields?: Array<any>;
-    isValid?: boolean;
+    fields?: any[];
     hideNavigation?: boolean;
     hideActionBar?: boolean;
-    hasServerValidationErrors?: boolean;
-    verifyForm?(formId?: string): Promise<any>;
+    verifyForm?(formId?: string): Promise<boolean>;
     triggerValidation?(): void;
-    triggerCurrentFormValidation?(): void;
-    isCurrentFormValid?(): boolean;
     customNavigationHandler?(): void;
 }
+export interface FormModelWithValidity extends FormModel {
+    isValid: boolean;
+    hasServerValidationErrors?: boolean;
+}
 export interface FormList {
-    [field: string]: Form;
+    [field: string]: FormModel;
 }

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

@@ -1,7 +1,7 @@
-import IdVerificationData from './api/id-verification-data';
-export default interface IdVerificationStatus {
+import { VerifyIdNumberResponse } from './api/verify-id-number';
+export interface IdVerificationStatus {
     status: string;
-    data: IdVerificationData;
+    data: VerifyIdNumberResponse;
     fieldName: string;
     translationKey?: string;
 }