From e0d78fa4d9ed4579b0a71f236671f96dc21c8057 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 23 Jul 2024 16:38:32 +0200 Subject: [PATCH] spec release --- json/LegalEntityService-v1.json | 37 +++++- json/LegalEntityService-v2.json | 39 ++++++- json/LegalEntityService-v3.json | 45 ++++++-- yaml/LegalEntityService-v1.yaml | 179 +++++++++++++++++------------ yaml/LegalEntityService-v2.yaml | 191 ++++++++++++++++++------------- yaml/LegalEntityService-v3.yaml | 196 +++++++++++++++++++------------- 6 files changed, 442 insertions(+), 245 deletions(-) diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index 5e956d9..80516c7 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -3522,6 +3522,10 @@ "description" : "The language to be used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The requested format for the Terms of Service document. Default value: JSON.", + "type" : "string" + }, "type" : { "description" : "The type of Terms of Service.\n\nPossible values:\n* **adyenForPlatformsManage**\n* **adyenIssuing**\n* **adyenForPlatformsAdvanced**\n* **adyenCapital**\n* **adyenAccount**\n* **adyenCard**\n* **adyenFranchisee**\n* **adyenPccr**\n\n", "enum" : [ @@ -3559,6 +3563,10 @@ "description" : "The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The format of the Terms of Service document.", + "type" : "string" + }, "termsOfServiceDocumentId" : { "description" : "The unique identifier of the Terms of Service document.", "type" : "string" @@ -3733,7 +3741,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -3768,6 +3776,10 @@ "readOnly" : true, "type" : "string" }, + "relationship" : { + "description" : "The individual's relationship to a legal representative if the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.", + "type" : "string" + }, "settlorExemptionReason" : { "description" : "Defines the Kyc Exemption Reason for a Settlor associated with a trust.\n\nFor example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**.", "items" : { @@ -3777,7 +3789,7 @@ "type" : "array" }, "type" : { - "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", + "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible value for individuals: **legalRepresentative**.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**.\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", "enum" : [ "definedBeneficiary", "director", @@ -3904,7 +3916,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -3954,7 +3966,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4007,7 +4019,7 @@ "type" : "string" }, "settings" : { - "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these values are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\nThe following value is an array of strings in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default and only countries supported by hosted onboarding are allowed.\n\n- **acceptedCountries**: List of countries that the user can select in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe following value is an integer:\n\n- **transferInstrumentLimit**: The maximum number of transfer instruments the user can create.\n\n", + "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The key represents a specific setting.", "$ref" : "#/components/schemas/OnboardingLinkSettings" }, "themeId" : { @@ -4021,51 +4033,66 @@ "additionalProperties" : false, "properties" : { "acceptedCountries" : { + "description" : "The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format.\n\nThe array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).", "items" : { "type" : "string" }, "type" : "array" }, "allowBankAccountFormatSelection" : { + "description" : "Default value: **false**\n\nIndicates if the user can select the format for their payout account (if applicable).", "type" : "boolean" }, "allowIntraRegionCrossBorderPayout" : { + "description" : "Default value: **false**\n\nIndicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.", "type" : "boolean" }, "changeLegalEntityType" : { + "description" : "Default value: **true**\n\nIndicates if the user can change their legal entity type.", "type" : "boolean" }, "editPrefilledCountry" : { + "description" : "Default value: **true**\n\nIndicates if the user can change the country of their legal entity's address, for example the registered address of an organization.", "type" : "boolean" }, "hideOnboardingIntroductionIndividual" : { + "description" : "Default value: **false**\n\nIndicates if the user of the individual legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionOrganization" : { + "description" : "Default value: **false**\n\nIndicates if the user of the organization legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionSoleProprietor" : { + "description" : "Default value: **false**\n\nIndicates if the user of the sole proprietorship legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionTrust" : { + "description" : "Default value: **false**\n\nIndicates if the user of the trust legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "instantBankVerification" : { + "description" : "Default value: **true**\n\nIndicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.", "type" : "boolean" }, "requirePciSignEcomMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.", "type" : "boolean" }, "requirePciSignEcommerce" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.", "type" : "boolean" }, "requirePciSignPos" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.", "type" : "boolean" }, "requirePciSignPosMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.", "type" : "boolean" }, "transferInstrumentLimit" : { + "description" : "The maximum number of transfer instruments the user can create.", "format" : "int32", "type" : "integer" } diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index d652b44..ca01f35 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -3789,6 +3789,10 @@ "description" : "The language to be used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The requested format for the Terms of Service document. Default value: JSON.", + "type" : "string" + }, "type" : { "description" : "The type of Terms of Service.\n\nPossible values:\n* **adyenForPlatformsManage**\n* **adyenIssuing**\n* **adyenForPlatformsAdvanced**\n* **adyenCapital**\n* **adyenAccount**\n* **adyenCard**\n* **adyenFranchisee**\n* **adyenPccr**\n\n", "enum" : [ @@ -3826,6 +3830,10 @@ "description" : "The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The format of the Terms of Service document.", + "type" : "string" + }, "termsOfServiceDocumentId" : { "description" : "The unique identifier of the Terms of Service document.", "type" : "string" @@ -3877,7 +3885,7 @@ "type" : "string" }, "type" : { - "description" : "Type of identity data. For individuals, the `type` value is **nationalIdNumber**. For individuals in these countries, the following types are supported.\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n", + "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber", "enum" : [ "nationalIdNumber", "passport", @@ -4027,7 +4035,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4062,6 +4070,10 @@ "readOnly" : true, "type" : "string" }, + "relationship" : { + "description" : "The individual's relationship to a legal representative if the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.", + "type" : "string" + }, "settlorExemptionReason" : { "description" : "Defines the Kyc Exemption Reason for a Settlor associated with a trust.\n\nFor example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**.", "items" : { @@ -4071,7 +4083,7 @@ "type" : "array" }, "type" : { - "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", + "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible value for individuals: **legalRepresentative**.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**.\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", "enum" : [ "definedBeneficiary", "director", @@ -4219,7 +4231,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4277,7 +4289,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4330,7 +4342,7 @@ "type" : "string" }, "settings" : { - "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these values are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\nThe following value is an array of strings in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default and only countries supported by hosted onboarding are allowed.\n\n- **acceptedCountries**: List of countries that the user can select in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe following value is an integer:\n\n- **transferInstrumentLimit**: The maximum number of transfer instruments the user can create.\n\n", + "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The key represents a specific setting.", "$ref" : "#/components/schemas/OnboardingLinkSettings" }, "themeId" : { @@ -4344,51 +4356,66 @@ "additionalProperties" : false, "properties" : { "acceptedCountries" : { + "description" : "The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format.\n\nThe array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).", "items" : { "type" : "string" }, "type" : "array" }, "allowBankAccountFormatSelection" : { + "description" : "Default value: **false**\n\nIndicates if the user can select the format for their payout account (if applicable).", "type" : "boolean" }, "allowIntraRegionCrossBorderPayout" : { + "description" : "Default value: **false**\n\nIndicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.", "type" : "boolean" }, "changeLegalEntityType" : { + "description" : "Default value: **true**\n\nIndicates if the user can change their legal entity type.", "type" : "boolean" }, "editPrefilledCountry" : { + "description" : "Default value: **true**\n\nIndicates if the user can change the country of their legal entity's address, for example the registered address of an organization.", "type" : "boolean" }, "hideOnboardingIntroductionIndividual" : { + "description" : "Default value: **false**\n\nIndicates if the user of the individual legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionOrganization" : { + "description" : "Default value: **false**\n\nIndicates if the user of the organization legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionSoleProprietor" : { + "description" : "Default value: **false**\n\nIndicates if the user of the sole proprietorship legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionTrust" : { + "description" : "Default value: **false**\n\nIndicates if the user of the trust legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "instantBankVerification" : { + "description" : "Default value: **true**\n\nIndicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.", "type" : "boolean" }, "requirePciSignEcomMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.", "type" : "boolean" }, "requirePciSignEcommerce" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.", "type" : "boolean" }, "requirePciSignPos" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.", "type" : "boolean" }, "requirePciSignPosMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.", "type" : "boolean" }, "transferInstrumentLimit" : { + "description" : "The maximum number of transfer instruments the user can create.", "format" : "int32", "type" : "integer" } diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index 23e07e4..6de6990 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -4023,7 +4023,7 @@ "$ref" : "#/components/schemas/OwnerEntity" }, "type" : { - "description" : "Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.\n\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\n\n* For **trust**, the `type` value can be **constitutionalDocument**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).", + "description" : "Type of document, used when providing an ID number or uploading a document. The possible values depend on the legal entity type.\n\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, **proofOfSignatory**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** or **proofOfRelationship**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\n\n* For **trust**, the `type` value can be **constitutionalDocument**.\n\n* Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).", "enum" : [ "bankStatement", "driversLicense", @@ -4042,7 +4042,8 @@ "liveSelfie", "proofOfIndustry", "constitutionalDocument", - "proofOfFundingOrWealthSource" + "proofOfFundingOrWealthSource", + "proofOfRelationship" ], "type" : "string" } @@ -4225,6 +4226,10 @@ "description" : "The language to be used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The requested format for the Terms of Service document. Default value: JSON.", + "type" : "string" + }, "type" : { "description" : "The type of Terms of Service.\n\nPossible values:\n* **adyenForPlatformsManage**\n* **adyenIssuing**\n* **adyenForPlatformsAdvanced**\n* **adyenCapital**\n* **adyenAccount**\n* **adyenCard**\n* **adyenFranchisee**\n* **adyenPccr**\n\n", "enum" : [ @@ -4262,6 +4267,10 @@ "description" : "The language used for the Terms of Service document, specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.", "type" : "string" }, + "termsOfServiceDocumentFormat" : { + "description" : "The format of the Terms of Service document.", + "type" : "string" + }, "termsOfServiceDocumentId" : { "description" : "The unique identifier of the Terms of Service document.", "type" : "string" @@ -4390,7 +4399,7 @@ "type" : "string" }, "type" : { - "description" : "Type of identity data. For individuals, the `type` value is **nationalIdNumber**. For individuals in these countries, the following types are supported.\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n", + "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber", "enum" : [ "nationalIdNumber", "passport", @@ -4557,7 +4566,7 @@ "type" : "array" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4592,6 +4601,10 @@ "readOnly" : true, "type" : "string" }, + "relationship" : { + "description" : "The individual's relationship to a legal representative if the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.", + "type" : "string" + }, "settlorExemptionReason" : { "description" : "Defines the Kyc Exemption Reason for a Settlor associated with a trust.\n\nFor example, **professionalServiceProvider**, **deceased**, or **contributionBelowThreshold**.", "items" : { @@ -4601,11 +4614,12 @@ "type" : "array" }, "type" : { - "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", + "description" : "Defines the relationship of the legal entity to the current legal entity.\n\nPossible value for individuals: **legalRepresentative**.\n\nPossible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**.\n\nPossible values for sole proprietorships: **soleProprietorship**.\n\nPossible value for trusts: **trust**.\n\nPossible values for trust members: **definedBeneficiary**, **protector**, **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.", "enum" : [ "definedBeneficiary", "director", "immediateParentCompany", + "legalRepresentative", "pciSignatory", "protector", "secondaryTrustee", @@ -4742,7 +4756,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4800,7 +4814,7 @@ "type" : "string" }, "verificationPlan" : { - "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront).", + "description" : "A key-value pair that specifies the verification process for a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification).", "type" : "string" } }, @@ -4935,7 +4949,7 @@ "type" : "string" }, "settings" : { - "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The keys are the settings.\n\nPossible keys:\n\nBy default, these values are set to **true**. Set to **false** to not allow the action.\n\n- **changeLegalEntityType**: The user can change their legal entity type.\n\n- **editPrefilledCountry**: The user can change the country of their legal entity's address, for example the registered address of an organization.\n\nBy default, these values are set to **false**. Set to **true** to allow the action.\n\n- **allowBankAccountFormatSelection**: The user can select the format for their payout account if applicable.\n\n- **allowIntraRegionCrossBorderPayout**: The user can select a payout account in a different EU/EEA country (including Switzerland and the UK) than the country of their legal entity.\n\nBy default, these values are set to **false**. Set the following values to **true** to require the user to sign PCI questionnaires based on their sales channels. The user must sign PCI questionnaires for all relevant sales channels.\n\n- **requirePciSignEcommerce**\n\n- **requirePciSignPos**\n\n- **requirePciSignEcomMoto**\n\n- **requirePciSignPosMoto**\n\nThe following value is an array of strings in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format. The array is empty by default and only countries supported by hosted onboarding are allowed.\n\n- **acceptedCountries**: List of countries that the user can select in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe following value is an integer:\n\n- **transferInstrumentLimit**: The maximum number of transfer instruments the user can create.\n\n", + "description" : "Key-value pairs indicating the settings for the hosted onboarding page. The key represents a specific setting.", "$ref" : "#/components/schemas/OnboardingLinkSettings" }, "themeId" : { @@ -4949,51 +4963,66 @@ "additionalProperties" : false, "properties" : { "acceptedCountries" : { + "description" : "The list of countries the user can choose from in hosted onboarding when `editPrefilledCountry` is allowed.\n\nThe value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code format.\n\nThe array is empty by default, allowing all [countries and regions supported by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).", "items" : { "type" : "string" }, "type" : "array" }, "allowBankAccountFormatSelection" : { + "description" : "Default value: **false**\n\nIndicates if the user can select the format for their payout account (if applicable).", "type" : "boolean" }, "allowIntraRegionCrossBorderPayout" : { + "description" : "Default value: **false**\n\nIndicates if the user can select a payout account in a different EU/EEA location (including Switzerland and the UK) than the location of their legal entity.", "type" : "boolean" }, "changeLegalEntityType" : { + "description" : "Default value: **true**\n\nIndicates if the user can change their legal entity type.", "type" : "boolean" }, "editPrefilledCountry" : { + "description" : "Default value: **true**\n\nIndicates if the user can change the country of their legal entity's address, for example the registered address of an organization.", "type" : "boolean" }, "hideOnboardingIntroductionIndividual" : { + "description" : "Default value: **false**\n\nIndicates if the user of the individual legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionOrganization" : { + "description" : "Default value: **false**\n\nIndicates if the user of the organization legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionSoleProprietor" : { + "description" : "Default value: **false**\n\nIndicates if the user of the sole proprietorship legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "hideOnboardingIntroductionTrust" : { + "description" : "Default value: **false**\n\nIndicates if the user of the trust legal entity type can view the introduction screen.\nThe introduction screen provides brief instructions for the subsequent steps in the hosted onboarding process.", "type" : "boolean" }, "instantBankVerification" : { + "description" : "Default value: **true**\n\nIndicates if the user can initiate the verification process through open banking providers, like Plaid or Tink.", "type" : "boolean" }, "requirePciSignEcomMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **ecomMoto** sales channel type.", "type" : "boolean" }, "requirePciSignEcommerce" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **eCommerce** sales channel type.", "type" : "boolean" }, "requirePciSignPos" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **pos** sales channel type.", "type" : "boolean" }, "requirePciSignPosMoto" : { + "description" : "Default value: **false**\n\nIndicates if the user is required to sign a PCI questionnaires for the **posMoto** sales channel type.", "type" : "boolean" }, "transferInstrumentLimit" : { + "description" : "The maximum number of transfer instruments the user can create.", "format" : "int32", "type" : "integer" } diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index c8445c1..38ef4bb 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -2407,6 +2407,10 @@ components: specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: 'The requested format for the Terms of Service document. Default + value: JSON.' + type: string type: description: 'The type of Terms of Service. @@ -2460,6 +2464,9 @@ components: by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: The format of the Terms of Service document. + type: string termsOfServiceDocumentId: description: The unique identifier of the Terms of Service document. type: string @@ -2626,7 +2633,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - id @@ -2666,6 +2673,10 @@ components: - For **soleProprietorship**, `name`.' readOnly: true type: string + relationship: + description: 'The individual''s relationship to a legal representative if + the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.' + type: string settlorExemptionReason: description: 'Defines the Kyc Exemption Reason for a Settlor associated with a trust. @@ -2681,6 +2692,9 @@ components: legal entity. + Possible value for individuals: **legalRepresentative**. + + Possible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**. @@ -2688,7 +2702,7 @@ components: Possible values for sole proprietorships: **soleProprietorship**. - Possible value for trusts: **trust** + Possible value for trusts: **trust**. Possible values for trust members: **definedBeneficiary**, **protector**, @@ -2831,7 +2845,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string type: object LegalEntityInfoRequiredType: @@ -2876,7 +2890,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - type @@ -2926,73 +2940,8 @@ components: onboarding. type: string settings: - description: 'Key-value pairs indicating the settings for the hosted onboarding - page. The keys are the settings. - - - Possible keys: - - - By default, these values are set to **true**. Set to **false** to not - allow the action. - - - - **changeLegalEntityType**: The user can change their legal entity type. - - - - **editPrefilledCountry**: The user can change the country of their legal - entity''s address, for example the registered address of an organization. - - - By default, these values are set to **false**. Set to **true** to allow - the action. - - - - **allowBankAccountFormatSelection**: The user can select the format - for their payout account if applicable. - - - - **allowIntraRegionCrossBorderPayout**: The user can select a payout - account in a different EU/EEA country (including Switzerland and the UK) - than the country of their legal entity. - - - By default, these values are set to **false**. Set the following values - to **true** to require the user to sign PCI questionnaires based on their - sales channels. The user must sign PCI questionnaires for all relevant - sales channels. - - - - **requirePciSignEcommerce** - - - - **requirePciSignPos** - - - - **requirePciSignEcomMoto** - - - - **requirePciSignPosMoto** - - - The following value is an array of strings in the two-character [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code - format. The array is empty by default and only countries supported by - hosted onboarding are allowed. - - - - **acceptedCountries**: List of countries that the user can select in - hosted onboarding when `editPrefilledCountry` is allowed. - - - The following value is an integer: - - - - **transferInstrumentLimit**: The maximum number of transfer instruments - the user can create. - - - ' + description: Key-value pairs indicating the settings for the hosted onboarding + page. The key represents a specific setting. $ref: '#/components/schemas/OnboardingLinkSettings' themeId: description: The unique identifier of the hosted onboarding theme. @@ -3002,36 +2951,124 @@ components: additionalProperties: false properties: acceptedCountries: + description: 'The list of countries the user can choose from in hosted onboarding + when `editPrefilledCountry` is allowed. + + + The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code format. + + + The array is empty by default, allowing all [countries and regions supported + by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).' items: type: string type: array allowBankAccountFormatSelection: + description: 'Default value: **false** + + + Indicates if the user can select the format for their payout account (if + applicable).' type: boolean allowIntraRegionCrossBorderPayout: + description: 'Default value: **false** + + + Indicates if the user can select a payout account in a different EU/EEA + location (including Switzerland and the UK) than the location of their + legal entity.' type: boolean changeLegalEntityType: + description: 'Default value: **true** + + + Indicates if the user can change their legal entity type.' type: boolean editPrefilledCountry: + description: 'Default value: **true** + + + Indicates if the user can change the country of their legal entity''s + address, for example the registered address of an organization.' type: boolean hideOnboardingIntroductionIndividual: + description: 'Default value: **false** + + + Indicates if the user of the individual legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionOrganization: + description: 'Default value: **false** + + + Indicates if the user of the organization legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionSoleProprietor: + description: 'Default value: **false** + + + Indicates if the user of the sole proprietorship legal entity type can + view the introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionTrust: + description: 'Default value: **false** + + + Indicates if the user of the trust legal entity type can view the introduction + screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean instantBankVerification: + description: 'Default value: **true** + + + Indicates if the user can initiate the verification process through open + banking providers, like Plaid or Tink.' type: boolean requirePciSignEcomMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **ecomMoto** sales channel type.' type: boolean requirePciSignEcommerce: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **eCommerce** sales channel type.' type: boolean requirePciSignPos: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **pos** sales channel type.' type: boolean requirePciSignPosMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **posMoto** sales channel type.' type: boolean transferInstrumentLimit: + description: The maximum number of transfer instruments the user can create. format: int32 type: integer type: object diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index 52cfe5a..797e82a 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -2610,6 +2610,10 @@ components: specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: 'The requested format for the Terms of Service document. Default + value: JSON.' + type: string type: description: 'The type of Terms of Service. @@ -2663,6 +2667,9 @@ components: by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: The format of the Terms of Service document. + type: string termsOfServiceDocumentId: description: The unique identifier of the Terms of Service document. type: string @@ -2728,12 +2735,12 @@ components: description: The number in the document. type: string type: - description: "Type of identity data. For individuals, the `type` value is\ - \ **nationalIdNumber**. For individuals in these countries, the following\ - \ types are supported.\n\n- Australia: **driversLicense**, **passport**\n\ - \n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\ - \n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\ - \ **nationalIdNumber**, **passport** \n\n" + description: "Type of identity data. For individuals, the following types\ + \ are supported:\n\n- Australia: **driversLicense**, **passport**\n\n\ + - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n\ + - New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\ + \ **nationalIdNumber**, **passport** \n\n- All other supported countries:\ + \ **nationalIdNumber" enum: - nationalIdNumber - passport @@ -2859,7 +2866,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - id @@ -2899,6 +2906,10 @@ components: - For **soleProprietorship**, `name`.' readOnly: true type: string + relationship: + description: 'The individual''s relationship to a legal representative if + the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.' + type: string settlorExemptionReason: description: 'Defines the Kyc Exemption Reason for a Settlor associated with a trust. @@ -2914,6 +2925,9 @@ components: legal entity. + Possible value for individuals: **legalRepresentative**. + + Possible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**. @@ -2921,7 +2935,7 @@ components: Possible values for sole proprietorships: **soleProprietorship**. - Possible value for trusts: **trust** + Possible value for trusts: **trust**. Possible values for trust members: **definedBeneficiary**, **protector**, @@ -3087,7 +3101,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string type: object LegalEntityInfoRequiredType: @@ -3140,7 +3154,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - type @@ -3190,73 +3204,8 @@ components: onboarding. type: string settings: - description: 'Key-value pairs indicating the settings for the hosted onboarding - page. The keys are the settings. - - - Possible keys: - - - By default, these values are set to **true**. Set to **false** to not - allow the action. - - - - **changeLegalEntityType**: The user can change their legal entity type. - - - - **editPrefilledCountry**: The user can change the country of their legal - entity''s address, for example the registered address of an organization. - - - By default, these values are set to **false**. Set to **true** to allow - the action. - - - - **allowBankAccountFormatSelection**: The user can select the format - for their payout account if applicable. - - - - **allowIntraRegionCrossBorderPayout**: The user can select a payout - account in a different EU/EEA country (including Switzerland and the UK) - than the country of their legal entity. - - - By default, these values are set to **false**. Set the following values - to **true** to require the user to sign PCI questionnaires based on their - sales channels. The user must sign PCI questionnaires for all relevant - sales channels. - - - - **requirePciSignEcommerce** - - - - **requirePciSignPos** - - - - **requirePciSignEcomMoto** - - - - **requirePciSignPosMoto** - - - The following value is an array of strings in the two-character [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code - format. The array is empty by default and only countries supported by - hosted onboarding are allowed. - - - - **acceptedCountries**: List of countries that the user can select in - hosted onboarding when `editPrefilledCountry` is allowed. - - - The following value is an integer: - - - - **transferInstrumentLimit**: The maximum number of transfer instruments - the user can create. - - - ' + description: Key-value pairs indicating the settings for the hosted onboarding + page. The key represents a specific setting. $ref: '#/components/schemas/OnboardingLinkSettings' themeId: description: The unique identifier of the hosted onboarding theme. @@ -3266,36 +3215,124 @@ components: additionalProperties: false properties: acceptedCountries: + description: 'The list of countries the user can choose from in hosted onboarding + when `editPrefilledCountry` is allowed. + + + The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code format. + + + The array is empty by default, allowing all [countries and regions supported + by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).' items: type: string type: array allowBankAccountFormatSelection: + description: 'Default value: **false** + + + Indicates if the user can select the format for their payout account (if + applicable).' type: boolean allowIntraRegionCrossBorderPayout: + description: 'Default value: **false** + + + Indicates if the user can select a payout account in a different EU/EEA + location (including Switzerland and the UK) than the location of their + legal entity.' type: boolean changeLegalEntityType: + description: 'Default value: **true** + + + Indicates if the user can change their legal entity type.' type: boolean editPrefilledCountry: + description: 'Default value: **true** + + + Indicates if the user can change the country of their legal entity''s + address, for example the registered address of an organization.' type: boolean hideOnboardingIntroductionIndividual: + description: 'Default value: **false** + + + Indicates if the user of the individual legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionOrganization: + description: 'Default value: **false** + + + Indicates if the user of the organization legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionSoleProprietor: + description: 'Default value: **false** + + + Indicates if the user of the sole proprietorship legal entity type can + view the introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionTrust: + description: 'Default value: **false** + + + Indicates if the user of the trust legal entity type can view the introduction + screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean instantBankVerification: + description: 'Default value: **true** + + + Indicates if the user can initiate the verification process through open + banking providers, like Plaid or Tink.' type: boolean requirePciSignEcomMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **ecomMoto** sales channel type.' type: boolean requirePciSignEcommerce: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **eCommerce** sales channel type.' type: boolean requirePciSignPos: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **pos** sales channel type.' type: boolean requirePciSignPosMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **posMoto** sales channel type.' type: boolean transferInstrumentLimit: + description: The maximum number of transfer instruments the user can create. format: int32 type: integer type: object diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index 6862714..44f209c 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -2754,7 +2754,8 @@ components: * For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **liveSelfie**, **proofOfNationalIdNumber**, **proofOfResidency**, - **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**. + **proofOfIndustry**, **proofOfIndividualTaxId**, **proofOfFundingOrWealthSource** + or **proofOfRelationship**. * For **soleProprietorship**, the `type` values can be **constitutionalDocument**, @@ -2784,6 +2785,7 @@ components: - proofOfIndustry - constitutionalDocument - proofOfFundingOrWealthSource + - proofOfRelationship type: string required: - description @@ -2941,6 +2943,10 @@ components: specified by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: 'The requested format for the Terms of Service document. Default + value: JSON.' + type: string type: description: 'The type of Terms of Service. @@ -2994,6 +3000,9 @@ components: by the two-letter [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language code. Possible value: **en** for English.' type: string + termsOfServiceDocumentFormat: + description: The format of the Terms of Service document. + type: string termsOfServiceDocumentId: description: The unique identifier of the Terms of Service document. type: string @@ -3119,12 +3128,12 @@ components: description: The number in the document. type: string type: - description: "Type of identity data. For individuals, the `type` value is\ - \ **nationalIdNumber**. For individuals in these countries, the following\ - \ types are supported.\n\n- Australia: **driversLicense**, **passport**\n\ - \n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\ - \n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\ - \ **nationalIdNumber**, **passport** \n\n" + description: "Type of identity data. For individuals, the following types\ + \ are supported:\n\n- Australia: **driversLicense**, **passport**\n\n\ + - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n\ + - New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\ + \ **nationalIdNumber**, **passport** \n\n- All other supported countries:\ + \ **nationalIdNumber" enum: - nationalIdNumber - passport @@ -3265,7 +3274,7 @@ components: type: array verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - id @@ -3305,6 +3314,10 @@ components: - For **soleProprietorship**, `name`.' readOnly: true type: string + relationship: + description: 'The individual''s relationship to a legal representative if + the `type` is **legalRepresentative**. Possible values: **parent**, **guardian**.' + type: string settlorExemptionReason: description: 'Defines the Kyc Exemption Reason for a Settlor associated with a trust. @@ -3320,6 +3333,9 @@ components: legal entity. + Possible value for individuals: **legalRepresentative**. + + Possible values for organizations: **uboThroughOwnership**, **uboThroughControl**, **director**, **signatory**, or **ultimateParentCompany**. @@ -3327,7 +3343,7 @@ components: Possible values for sole proprietorships: **soleProprietorship**. - Possible value for trusts: **trust** + Possible value for trusts: **trust**. Possible values for trust members: **definedBeneficiary**, **protector**, @@ -3336,6 +3352,7 @@ components: - definedBeneficiary - director - immediateParentCompany + - legalRepresentative - pciSignatory - protector - secondaryTrustee @@ -3487,7 +3504,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string type: object LegalEntityInfoRequiredType: @@ -3540,7 +3557,7 @@ components: type: string verificationPlan: description: A key-value pair that specifies the verification process for - a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/onboard-users#upfront). + a legal entity. Set to **upfront** for upfront verification for [marketplaces](https://docs.adyen.com/marketplaces/verification-overview/verification-types/#upfront-verification). type: string required: - type @@ -3656,73 +3673,8 @@ components: onboarding. type: string settings: - description: 'Key-value pairs indicating the settings for the hosted onboarding - page. The keys are the settings. - - - Possible keys: - - - By default, these values are set to **true**. Set to **false** to not - allow the action. - - - - **changeLegalEntityType**: The user can change their legal entity type. - - - - **editPrefilledCountry**: The user can change the country of their legal - entity''s address, for example the registered address of an organization. - - - By default, these values are set to **false**. Set to **true** to allow - the action. - - - - **allowBankAccountFormatSelection**: The user can select the format - for their payout account if applicable. - - - - **allowIntraRegionCrossBorderPayout**: The user can select a payout - account in a different EU/EEA country (including Switzerland and the UK) - than the country of their legal entity. - - - By default, these values are set to **false**. Set the following values - to **true** to require the user to sign PCI questionnaires based on their - sales channels. The user must sign PCI questionnaires for all relevant - sales channels. - - - - **requirePciSignEcommerce** - - - - **requirePciSignPos** - - - - **requirePciSignEcomMoto** - - - - **requirePciSignPosMoto** - - - The following value is an array of strings in the two-character [ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code - format. The array is empty by default and only countries supported by - hosted onboarding are allowed. - - - - **acceptedCountries**: List of countries that the user can select in - hosted onboarding when `editPrefilledCountry` is allowed. - - - The following value is an integer: - - - - **transferInstrumentLimit**: The maximum number of transfer instruments - the user can create. - - - ' + description: Key-value pairs indicating the settings for the hosted onboarding + page. The key represents a specific setting. $ref: '#/components/schemas/OnboardingLinkSettings' themeId: description: The unique identifier of the hosted onboarding theme. @@ -3732,36 +3684,124 @@ components: additionalProperties: false properties: acceptedCountries: + description: 'The list of countries the user can choose from in hosted onboarding + when `editPrefilledCountry` is allowed. + + + The value must be in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code format. + + + The array is empty by default, allowing all [countries and regions supported + by hosted onboarding](https://docs.adyen.com/platforms/onboard-users/#hosted-onboarding).' items: type: string type: array allowBankAccountFormatSelection: + description: 'Default value: **false** + + + Indicates if the user can select the format for their payout account (if + applicable).' type: boolean allowIntraRegionCrossBorderPayout: + description: 'Default value: **false** + + + Indicates if the user can select a payout account in a different EU/EEA + location (including Switzerland and the UK) than the location of their + legal entity.' type: boolean changeLegalEntityType: + description: 'Default value: **true** + + + Indicates if the user can change their legal entity type.' type: boolean editPrefilledCountry: + description: 'Default value: **true** + + + Indicates if the user can change the country of their legal entity''s + address, for example the registered address of an organization.' type: boolean hideOnboardingIntroductionIndividual: + description: 'Default value: **false** + + + Indicates if the user of the individual legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionOrganization: + description: 'Default value: **false** + + + Indicates if the user of the organization legal entity type can view the + introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionSoleProprietor: + description: 'Default value: **false** + + + Indicates if the user of the sole proprietorship legal entity type can + view the introduction screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean hideOnboardingIntroductionTrust: + description: 'Default value: **false** + + + Indicates if the user of the trust legal entity type can view the introduction + screen. + + The introduction screen provides brief instructions for the subsequent + steps in the hosted onboarding process.' type: boolean instantBankVerification: + description: 'Default value: **true** + + + Indicates if the user can initiate the verification process through open + banking providers, like Plaid or Tink.' type: boolean requirePciSignEcomMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **ecomMoto** sales channel type.' type: boolean requirePciSignEcommerce: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **eCommerce** sales channel type.' type: boolean requirePciSignPos: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **pos** sales channel type.' type: boolean requirePciSignPosMoto: + description: 'Default value: **false** + + + Indicates if the user is required to sign a PCI questionnaires for the + **posMoto** sales channel type.' type: boolean transferInstrumentLimit: + description: The maximum number of transfer instruments the user can create. format: int32 type: integer type: object