diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index 6f310085..f796c37e 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -33,13 +33,13 @@ "name" : "Terms of Service" }, { - "name" : "Tax eDelivery consent" + "name" : "PCI questionnaires" }, { - "name" : "Hosted Onboarding" + "name" : "Tax eDelivery consent" }, { - "name" : "PCI questionnaires" + "name" : "Hosted Onboarding" } ], "paths" : { @@ -1780,6 +1780,111 @@ } } }, + "/legalEntities/{id}/pciQuestionnaires/signingRequired" : { + "post" : { + "tags" : [ + "PCI questionnaires" + ], + "summary" : "Calculate PCI status of a legal entity", + "description" : "Calculate PCI status of a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-pciQuestionnaires-signingRequired", + "x-sortIndex" : 5, + "x-methodName" : "calculatePciStatusOfLegalEntity", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity to calculate PCI status.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/pciQuestionnaires/{pciid}" : { "get" : { "tags" : [ @@ -3380,6 +3485,35 @@ ], "type" : "object" }, + "CalculatePciStatusRequest" : { + "additionalProperties" : false, + "properties" : { + "additionalSalesChannels" : { + "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) before you generate the questionnaires.\n\nPossible values:\n* **eCommerce**\n* **pos**\n* **ecomMoto**\n* **posMoto**\n\n", + "items" : { + "enum" : [ + "eCommerce", + "ecomMoto", + "pos", + "posMoto" + ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "CalculatePciStatusResponse" : { + "additionalProperties" : false, + "properties" : { + "signingRequired" : { + "description" : "Indicates if the user is required to sign PCI questionnaires. If **false**, they do not need to sign any questionnaires.", + "type" : "boolean" + } + }, + "type" : "object" + }, "CalculateTermsOfServiceStatusResponse" : { "additionalProperties" : false, "properties" : { @@ -3664,7 +3798,7 @@ "type" : "string" }, "pciTemplateReferences" : { - "description" : "The array of Adyen-generated unique identifiers for the questionnaires.", + "description" : "The array of Adyen-generated unique identifiers for the questionnaires. If empty, the user is not required to sign questionnaires.", "items" : { "type" : "string" }, @@ -3951,6 +4085,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -4000,11 +4138,12 @@ "type" : "array" }, "type" : { - "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**.", + "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**.\n\nPossible value for unincorporated partnership: **unincorporatedPartnership**.\n\nPossible values for unincorporated partnership members: **secondaryPartner**, **uboThroughControl**, **uboThroughOwnership**", "enum" : [ "definedBeneficiary", "director", "protector", + "secondaryPartner", "secondaryTrustee", "settlor", "signatory", @@ -4126,6 +4265,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -4176,6 +4319,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -4851,6 +4998,87 @@ ], "type" : "object" }, + "UnincorporatedPartnership" : { + "additionalProperties" : false, + "properties" : { + "countryOfGoverningLaw" : { + "description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.", + "type" : "string" + }, + "doingBusinessAs" : { + "description" : "The registered name, if different from the `name`.", + "type" : "string" + }, + "name" : { + "description" : "The legal name.", + "type" : "string" + }, + "principalPlaceOfBusiness" : { + "description" : "The business address. Required if the principal place of business is different from the `registeredAddress`.", + "$ref" : "#/components/schemas/Address" + }, + "registeredAddress" : { + "description" : "The address registered at the registrar, such as the Chamber of Commerce.", + "$ref" : "#/components/schemas/Address" + }, + "registrationNumber" : { + "description" : "The registration number.", + "type" : "string" + }, + "type" : { + "description" : "Type of Partnership.\n\nPossible values:\n* **limitedPartnership**\n* **generalPartnership**\n* **familyPartnership**\n* **commercialPartnership**\n* **publicPartnership**\n* **otherPartnership**\n* **gbr**\n* **gmbh**\n* **kgaa**\n* **cv**\n* **vof**\n* **maatschap**\n* **privateFundLimitedPartnership**\n* **businessTrustEntity**\n* **businessPartnership**\n* **limitedLiabilityPartnership**\n* **eg**\n* **cooperative**\n* **vos**\n* **comunidadDeBienes**\n* **herenciaYacente**\n* **comunidadDePropietarios**\n* **sep**\n* **sca**\n* **bt**\n* **kkt**\n* **scs**\n* **snc**\n\n", + "enum" : [ + "limitedPartnership", + "generalPartnership", + "familyPartnership", + "commercialPartnership", + "publicPartnership", + "otherPartnership", + "gbr", + "gmbh", + "kgaa", + "cv", + "vof", + "maatschap", + "privateFundLimitedPartnership", + "businessTrustEntity", + "businessPartnership", + "limitedLiabilityPartnership", + "eg", + "cooperative", + "vos", + "comunidadDeBienes", + "herenciaYacente", + "comunidadDePropietarios", + "sep", + "sca", + "bt", + "kkt", + "scs", + "snc" + ], + "type" : "string" + }, + "vatAbsenceReason" : { + "description" : "The reason for not providing a VAT number.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.", + "enum" : [ + "industryExemption", + "belowTaxThreshold" + ], + "type" : "string" + }, + "vatNumber" : { + "description" : "The VAT number.", + "type" : "string" + } + }, + "required" : [ + "name", + "countryOfGoverningLaw", + "registeredAddress" + ], + "type" : "object" + }, "VerificationError" : { "additionalProperties" : false, "properties" : { diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 4931c2b9..51290a66 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -33,13 +33,13 @@ "name" : "Terms of Service" }, { - "name" : "Tax eDelivery consent" + "name" : "PCI questionnaires" }, { - "name" : "Hosted Onboarding" + "name" : "Tax eDelivery consent" }, { - "name" : "PCI questionnaires" + "name" : "Hosted Onboarding" } ], "paths" : { @@ -930,6 +930,9 @@ }, "createTrustAU" : { "$ref" : "#/components/examples/post-legalEntities-createTrustAU" + }, + "createUnincorporatedPartnershipAU" : { + "$ref" : "#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU" } }, "schema" : { @@ -977,6 +980,9 @@ }, "createTrustAU" : { "$ref" : "#/components/examples/post-legalEntities-createTrustAU-200" + }, + "createUnincorporatedPartnershipAU" : { + "$ref" : "#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU-200" } }, "schema" : { @@ -1172,6 +1178,12 @@ "updateLegalEntitySoleProp" : { "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp" }, + "updateLegalEntityUnincorporatedPartnership" : { + "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership" + }, + "updateLegalEntityUnincorporatedPartnershipMember" : { + "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember" + }, "updateTrustMember" : { "$ref" : "#/components/examples/patch-legalEntities-id-updateTrustMember" }, @@ -1219,6 +1231,12 @@ "updateLegalEntitySoleProp" : { "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp-200" }, + "updateLegalEntityUnincorporatedPartnership" : { + "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership-200" + }, + "updateLegalEntityUnincorporatedPartnershipMember" : { + "$ref" : "#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember-200" + }, "updateTrustMember" : { "$ref" : "#/components/examples/patch-legalEntities-id-updateTrustMember-200" }, @@ -2043,6 +2061,111 @@ } } }, + "/legalEntities/{id}/pciQuestionnaires/signingRequired" : { + "post" : { + "tags" : [ + "PCI questionnaires" + ], + "summary" : "Calculate PCI status of a legal entity", + "description" : "Calculate PCI status of a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-pciQuestionnaires-signingRequired", + "x-sortIndex" : 5, + "x-methodName" : "calculatePciStatusOfLegalEntity", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity to calculate PCI status.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/pciQuestionnaires/{pciid}" : { "get" : { "tags" : [ @@ -3682,6 +3805,35 @@ ], "type" : "object" }, + "CalculatePciStatusRequest" : { + "additionalProperties" : false, + "properties" : { + "additionalSalesChannels" : { + "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) before you generate the questionnaires.\n\nPossible values:\n* **eCommerce**\n* **pos**\n* **ecomMoto**\n* **posMoto**\n\n", + "items" : { + "enum" : [ + "eCommerce", + "ecomMoto", + "pos", + "posMoto" + ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "CalculatePciStatusResponse" : { + "additionalProperties" : false, + "properties" : { + "signingRequired" : { + "description" : "Indicates if the user is required to sign PCI questionnaires. If **false**, they do not need to sign any questionnaires.", + "type" : "boolean" + } + }, + "type" : "object" + }, "CalculateTermsOfServiceStatusResponse" : { "additionalProperties" : false, "properties" : { @@ -3897,7 +4049,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**, **proofOfResidency**, **proofOfIndustry**, **proofOfNationalIdNumber**, **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**, **proofOfResidency**, **proofOfIndustry**, **proofOfNationalIdNumber**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\n\n* For **trust**, the `type` value is **constitutionalDocument**.\n\n* For **unincorporatedPartnership**, the `type` value is **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", @@ -4032,7 +4184,7 @@ "type" : "string" }, "pciTemplateReferences" : { - "description" : "The array of Adyen-generated unique identifiers for the questionnaires.", + "description" : "The array of Adyen-generated unique identifiers for the questionnaires. If empty, the user is not required to sign questionnaires.", "items" : { "type" : "string" }, @@ -4374,6 +4526,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -4423,13 +4579,14 @@ "type" : "array" }, "type" : { - "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**.", + "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**.\n\nPossible value for unincorporated partnership: **unincorporatedPartnership**.\n\nPossible values for unincorporated partnership members: **secondaryPartner**, **uboThroughControl**, **uboThroughOwnership**", "enum" : [ "definedBeneficiary", "director", "immediateParentCompany", "pciSignatory", "protector", + "secondaryPartner", "secondaryTrustee", "settlor", "signatory", @@ -4438,7 +4595,8 @@ "uboThroughControl", "uboThroughOwnership", "ultimateParentCompany", - "undefinedBeneficiary" + "undefinedBeneficiary", + "unincorporatedPartnership" ], "type" : "string" } @@ -4570,6 +4728,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -4628,6 +4790,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -5515,6 +5681,100 @@ }, "type" : "object" }, + "UnincorporatedPartnership" : { + "additionalProperties" : false, + "properties" : { + "countryOfGoverningLaw" : { + "description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.", + "type" : "string" + }, + "dateOfIncorporation" : { + "x-addedInVersion" : "2", + "description" : "The date when the legal arrangement was incorporated in YYYY-MM-DD format.", + "type" : "string" + }, + "doingBusinessAs" : { + "description" : "The registered name, if different from the `name`.", + "type" : "string" + }, + "name" : { + "description" : "The legal name.", + "type" : "string" + }, + "principalPlaceOfBusiness" : { + "description" : "The business address. Required if the principal place of business is different from the `registeredAddress`.", + "$ref" : "#/components/schemas/Address" + }, + "registeredAddress" : { + "description" : "The address registered at the registrar, such as the Chamber of Commerce.", + "$ref" : "#/components/schemas/Address" + }, + "registrationNumber" : { + "description" : "The registration number.", + "type" : "string" + }, + "taxInformation" : { + "x-addedInVersion" : "2", + "description" : "The tax information of the entity.", + "items" : { + "$ref" : "#/components/schemas/TaxInformation" + }, + "type" : "array" + }, + "type" : { + "description" : "Type of Partnership.\n\nPossible values:\n* **limitedPartnership**\n* **generalPartnership**\n* **familyPartnership**\n* **commercialPartnership**\n* **publicPartnership**\n* **otherPartnership**\n* **gbr**\n* **gmbh**\n* **kgaa**\n* **cv**\n* **vof**\n* **maatschap**\n* **privateFundLimitedPartnership**\n* **businessTrustEntity**\n* **businessPartnership**\n* **limitedLiabilityPartnership**\n* **eg**\n* **cooperative**\n* **vos**\n* **comunidadDeBienes**\n* **herenciaYacente**\n* **comunidadDePropietarios**\n* **sep**\n* **sca**\n* **bt**\n* **kkt**\n* **scs**\n* **snc**\n\n", + "enum" : [ + "limitedPartnership", + "generalPartnership", + "familyPartnership", + "commercialPartnership", + "publicPartnership", + "otherPartnership", + "gbr", + "gmbh", + "kgaa", + "cv", + "vof", + "maatschap", + "privateFundLimitedPartnership", + "businessTrustEntity", + "businessPartnership", + "limitedLiabilityPartnership", + "eg", + "cooperative", + "vos", + "comunidadDeBienes", + "herenciaYacente", + "comunidadDePropietarios", + "sep", + "sca", + "bt", + "kkt", + "scs", + "snc" + ], + "type" : "string" + }, + "vatAbsenceReason" : { + "description" : "The reason for not providing a VAT number.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.", + "enum" : [ + "industryExemption", + "belowTaxThreshold" + ], + "type" : "string" + }, + "vatNumber" : { + "description" : "The VAT number.", + "type" : "string" + } + }, + "required" : [ + "name", + "countryOfGoverningLaw", + "registeredAddress" + ], + "type" : "object" + }, "VerificationError" : { "additionalProperties" : false, "properties" : { @@ -6229,6 +6489,109 @@ "id" : "LE00000000000000000000001" } }, + "patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership" : { + "summary" : "Associate unincorporated partnership to the main partner", + "description" : "Example request associating an unincorporated partnership to the main partner", + "value" : { + "entityAssociations" : [ + { + "legalEntityId" : "LE32CNC223225R5KXM9L97NTZ", + "type" : "unincorporatedPartnership" + } + ] + } + }, + "patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership-200" : { + "summary" : "Unincorporated partnership associated to the main partner", + "description" : "Example response associating an unincorporated partnership to the main partner", + "value" : { + "entityAssociations" : [ + { + "associatorId" : "LE32CNC223225R5KXM9T37PKD", + "entityType" : "unincorporatedPartnership", + "legalEntityId" : "LE32CNC223225R5KXM9L97NTZ", + "name" : "West Family Partnership", + "type" : "unincorporatedPartnership" + } + ], + "individual" : { + "email" : "s.eller@example.com", + "birthData" : { + "dateOfBirth" : "1990-06-21" + }, + "name" : { + "firstName" : "Shelly", + "lastName" : "Eller" + }, + "residentialAddress" : { + "city" : "Sydney", + "country" : "AU", + "stateOrProvince" : "NSW", + "postalCode" : "1197", + "street" : "54 Longfield Lane" + } + }, + "type" : "individual", + "id" : "LE32CNC223225R5KXM9T37PKD" + } + }, + "patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember" : { + "summary" : "Associate partnership member to an unincorporated partnership", + "description" : "Example request for associating a partnership member to an unincorporated partnership", + "value" : { + "entityAssociations" : [ + { + "legalEntityId" : "LE32CNC223225R5KXM9T37PKD", + "type" : "secondaryPartner" + } + ] + } + }, + "patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember-200" : { + "summary" : "Partnership member associated to an unincorporated partnership", + "description" : "Example response associating a partnership member to an unincorporated partnership", + "value" : { + "entityAssociations" : [ + { + "associatorId" : "LE32CNC223225R5KXM9L97NTZ", + "entityType" : "individual", + "legalEntityId" : "LE32CNC223225R5KXM9T37PKD", + "name" : "Shelly Eller", + "type" : "secondaryPartner" + } + ], + "unincorporatedPartnership" : { + "countryOfGoverningLaw" : "AU", + "doingBusinessAs" : "", + "name" : "West Family Partnership", + "principalPlaceOfBusiness" : { + "city" : "Sydney", + "country" : "AU", + "postalCode" : "5566", + "stateOrProvince" : "NSW", + "street" : "East City Street ", + "street2" : "222" + }, + "registeredAddress" : { + "city" : "Sydney", + "country" : "AU", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "street" : "53 Winterfield Avenue" + }, + "taxInformation" : [ + { + "country" : "AU", + "number" : "12345678901", + "type" : "ABN" + } + ], + "type" : "familyPartnership" + }, + "type" : "unincorporatedPartnership", + "id" : "LE32CNC223225R5KXM9L97NTZ" + } + }, "patch-legalEntities-id-updateTrustMember" : { "summary" : "Associate a trust member with a trust", "description" : "Example request associating a trust member with a trust", @@ -6863,6 +7226,76 @@ "id" : "LE322KH223222J5HJ6JRB75C5" } }, + "post-legalEntities-createUnincorporatedPartnershipAU" : { + "summary" : "Create a legal entity for an unincorporated partnership in Australia", + "description" : "Example request for creating a legal entity for an unincorporated partnership in Australia", + "value" : { + "type" : "unincorporatedPartnership", + "unincorporatedPartnership" : { + "name" : "West Family Partnership", + "type" : "familyPartnership", + "doingBusinessAs" : "", + "countryOfGoverningLaw" : "AU", + "taxInformation" : [ + { + "country" : "AU", + "type" : "ABN", + "number" : "12345678901" + } + ], + "registeredAddress" : { + "street" : " 53 Winterfield Avenue", + "city" : "Sydney", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "country" : "AU" + }, + "principalPlaceOfBusiness" : { + "street" : "East City Street ", + "street2" : "222", + "city" : "Sydney", + "postalCode" : "5566", + "stateOrProvince" : "NSW", + "country" : "AU" + } + } + } + }, + "post-legalEntities-createUnincorporatedPartnershipAU-200" : { + "summary" : "Unincorporated partnership legal entity created", + "description" : "Example response for creating a legal entity for an unincorporated partnership in Australia", + "value" : { + "unincorporatedPartnership" : { + "countryOfGoverningLaw" : "AU", + "doingBusinessAs" : "", + "name" : "West Family Partnership", + "registeredAddress" : { + "city" : "Sydney", + "country" : "AU", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "street" : "Winterfield Avenue" + }, + "principalPlaceOfBusiness" : { + "street" : "53 Winterfield Avenue", + "city" : "Sydney", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "country" : "AU" + }, + "taxInformation" : [ + { + "country" : "AU", + "number" : "12345678901", + "type" : "ABN" + } + ], + "type" : "familyPartnership" + }, + "type" : "unincorporatedPartnership", + "id" : "LE322KH223222J5HJ6JRB78K8" + } + }, "post-legalEntities-id-onboardingLinks-createOnboardingLink" : { "summary" : "Create a hosted onboarding link", "description" : "Example request for creating a hosted onboarding link", diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index 4ddf4987..325672e4 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -33,13 +33,13 @@ "name" : "Terms of Service" }, { - "name" : "Tax eDelivery consent" + "name" : "PCI questionnaires" }, { - "name" : "Hosted Onboarding" + "name" : "Tax eDelivery consent" }, { - "name" : "PCI questionnaires" + "name" : "Hosted Onboarding" } ], "paths" : { @@ -936,6 +936,9 @@ }, "createTrustAU" : { "$ref" : "#/components/examples/post-legalEntities-createTrustAU" + }, + "createUnincorporatedPartnershipAU" : { + "$ref" : "#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU" } }, "schema" : { @@ -983,6 +986,9 @@ }, "createTrustAU" : { "$ref" : "#/components/examples/post-legalEntities-createTrustAU-200" + }, + "createUnincorporatedPartnershipAU" : { + "$ref" : "#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU-200" } }, "schema" : { @@ -2257,6 +2263,111 @@ } } }, + "/legalEntities/{id}/pciQuestionnaires/signingRequired" : { + "post" : { + "tags" : [ + "PCI questionnaires" + ], + "summary" : "Calculate PCI status of a legal entity", + "description" : "Calculate PCI status of a legal entity.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-pciQuestionnaires-signingRequired", + "x-sortIndex" : 5, + "x-methodName" : "calculatePciStatusOfLegalEntity", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusRequest" + } + } + } + }, + "parameters" : [ + { + "description" : "The unique identifier of the legal entity to calculate PCI status.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CalculatePciStatusResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/pciQuestionnaires/{pciid}" : { "get" : { "tags" : [ @@ -4071,6 +4182,35 @@ ], "type" : "object" }, + "CalculatePciStatusRequest" : { + "additionalProperties" : false, + "properties" : { + "additionalSalesChannels" : { + "description" : "An array of additional sales channels to generate PCI questionnaires. Include the relevant sales channels if you need your user to sign PCI questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) before you generate the questionnaires.\n\nPossible values:\n* **eCommerce**\n* **pos**\n* **ecomMoto**\n* **posMoto**\n\n", + "items" : { + "enum" : [ + "eCommerce", + "ecomMoto", + "pos", + "posMoto" + ], + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "CalculatePciStatusResponse" : { + "additionalProperties" : false, + "properties" : { + "signingRequired" : { + "description" : "Indicates if the user is required to sign PCI questionnaires. If **false**, they do not need to sign any questionnaires.", + "type" : "boolean" + } + }, + "type" : "object" + }, "CalculateTermsOfServiceStatusResponse" : { "additionalProperties" : false, "properties" : { @@ -4327,7 +4467,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**, **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).", + "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 is **constitutionalDocument**.\n\n* For **unincorporatedPartnership**, the `type` value is **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", @@ -4463,7 +4603,7 @@ "type" : "string" }, "pciTemplateReferences" : { - "description" : "The array of Adyen-generated unique identifiers for the questionnaires.", + "description" : "The array of Adyen-generated unique identifiers for the questionnaires. If empty, the user is not required to sign questionnaires.", "items" : { "type" : "string" }, @@ -4890,6 +5030,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "verificationDeadlines" : { "x-addedInVersion" : "3", "description" : "List of verification deadlines and the capabilities that will be disallowed if verification errors are not resolved.", @@ -4948,7 +5092,7 @@ "type" : "array" }, "type" : { - "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**.", + "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**.\n\nPossible value for unincorporated partnership: **unincorporatedPartnership**.\n\nPossible values for unincorporated partnership members: **secondaryPartner**, **uboThroughControl**, **uboThroughOwnership**", "enum" : [ "definedBeneficiary", "director", @@ -4956,6 +5100,7 @@ "legalRepresentative", "pciSignatory", "protector", + "secondaryPartner", "secondaryTrustee", "settlor", "signatory", @@ -4965,7 +5110,8 @@ "uboThroughControl", "uboThroughOwnership", "ultimateParentCompany", - "undefinedBeneficiary" + "undefinedBeneficiary", + "unincorporatedPartnership" ], "type" : "string" } @@ -5089,6 +5235,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -5147,6 +5297,10 @@ ], "type" : "string" }, + "unincorporatedPartnership" : { + "description" : "Information about the unincorporated partnership. Required if `type` is **unincorporatedPartnership**.", + "$ref" : "#/components/schemas/UnincorporatedPartnership" + }, "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/verification-overview/verification-types/#upfront-verification).", "type" : "string" @@ -6296,6 +6450,105 @@ }, "type" : "object" }, + "UnincorporatedPartnership" : { + "additionalProperties" : false, + "properties" : { + "countryOfGoverningLaw" : { + "description" : "The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the governing country.", + "type" : "string" + }, + "dateOfIncorporation" : { + "x-addedInVersion" : "2", + "description" : "The date when the legal arrangement was incorporated in YYYY-MM-DD format.", + "type" : "string" + }, + "description" : { + "x-addedInVersion" : "3", + "description" : "Short description about the Legal Arrangement.", + "type" : "string" + }, + "doingBusinessAs" : { + "description" : "The registered name, if different from the `name`.", + "type" : "string" + }, + "name" : { + "description" : "The legal name.", + "type" : "string" + }, + "principalPlaceOfBusiness" : { + "description" : "The business address. Required if the principal place of business is different from the `registeredAddress`.", + "$ref" : "#/components/schemas/Address" + }, + "registeredAddress" : { + "description" : "The address registered at the registrar, such as the Chamber of Commerce.", + "$ref" : "#/components/schemas/Address" + }, + "registrationNumber" : { + "description" : "The registration number.", + "type" : "string" + }, + "taxInformation" : { + "x-addedInVersion" : "2", + "description" : "The tax information of the entity.", + "items" : { + "$ref" : "#/components/schemas/TaxInformation" + }, + "type" : "array" + }, + "type" : { + "description" : "Type of Partnership.\n\nPossible values:\n* **limitedPartnership**\n* **generalPartnership**\n* **familyPartnership**\n* **commercialPartnership**\n* **publicPartnership**\n* **otherPartnership**\n* **gbr**\n* **gmbh**\n* **kgaa**\n* **cv**\n* **vof**\n* **maatschap**\n* **privateFundLimitedPartnership**\n* **businessTrustEntity**\n* **businessPartnership**\n* **limitedLiabilityPartnership**\n* **eg**\n* **cooperative**\n* **vos**\n* **comunidadDeBienes**\n* **herenciaYacente**\n* **comunidadDePropietarios**\n* **sep**\n* **sca**\n* **bt**\n* **kkt**\n* **scs**\n* **snc**\n\n", + "enum" : [ + "limitedPartnership", + "generalPartnership", + "familyPartnership", + "commercialPartnership", + "publicPartnership", + "otherPartnership", + "gbr", + "gmbh", + "kgaa", + "cv", + "vof", + "maatschap", + "privateFundLimitedPartnership", + "businessTrustEntity", + "businessPartnership", + "limitedLiabilityPartnership", + "eg", + "cooperative", + "vos", + "comunidadDeBienes", + "herenciaYacente", + "comunidadDePropietarios", + "sep", + "sca", + "bt", + "kkt", + "scs", + "snc" + ], + "type" : "string" + }, + "vatAbsenceReason" : { + "description" : "The reason for not providing a VAT number.\n\nPossible values: **industryExemption**, **belowTaxThreshold**.", + "enum" : [ + "industryExemption", + "belowTaxThreshold" + ], + "type" : "string" + }, + "vatNumber" : { + "description" : "The VAT number.", + "type" : "string" + } + }, + "required" : [ + "name", + "countryOfGoverningLaw", + "registeredAddress" + ], + "type" : "object" + }, "VerificationDeadline" : { "additionalProperties" : false, "properties" : { @@ -7832,6 +8085,76 @@ "id" : "LE322KH223222J5HJ6JRB75C5" } }, + "post-legalEntities-createUnincorporatedPartnershipAU" : { + "summary" : "Create a legal entity for an unincorporated partnership in Australia", + "description" : "Example request for creating a legal entity for an unincorporated partnership in Australia", + "value" : { + "type" : "unincorporatedPartnership", + "unincorporatedPartnership" : { + "name" : "West Family Partnership", + "type" : "familyPartnership", + "doingBusinessAs" : "", + "countryOfGoverningLaw" : "AU", + "taxInformation" : [ + { + "country" : "AU", + "type" : "ABN", + "number" : "12345678901" + } + ], + "registeredAddress" : { + "street" : " 53 Winterfield Avenue", + "city" : "Sydney", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "country" : "AU" + }, + "principalPlaceOfBusiness" : { + "street" : "East City Street ", + "street2" : "222", + "city" : "Sydney", + "postalCode" : "5566", + "stateOrProvince" : "NSW", + "country" : "AU" + } + } + } + }, + "post-legalEntities-createUnincorporatedPartnershipAU-200" : { + "summary" : "Unincorporated partnership legal entity created", + "description" : "Example response for creating a legal entity for an unincorporated partnership in Australia", + "value" : { + "unincorporatedPartnership" : { + "countryOfGoverningLaw" : "AU", + "doingBusinessAs" : "", + "name" : "West Family Partnership", + "registeredAddress" : { + "city" : "Sydney", + "country" : "AU", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "street" : "Winterfield Avenue" + }, + "principalPlaceOfBusiness" : { + "street" : "53 Winterfield Avenue", + "city" : "Sydney", + "postalCode" : "1197", + "stateOrProvince" : "NSW", + "country" : "AU" + }, + "taxInformation" : [ + { + "country" : "AU", + "number" : "12345678901", + "type" : "ABN" + } + ], + "type" : "familyPartnership" + }, + "type" : "unincorporatedPartnership", + "id" : "LE322KH223222J5HJ6JRB78K8" + } + }, "post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200" : { "summary" : "Verification errors for a legal entity", "description" : "Example response when checking the verification errors of a legal entity", diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index a0a32c58..d8e733d2 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -32,9 +32,9 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: PCI questionnaires - name: Tax eDelivery consent - name: Hosted Onboarding -- name: PCI questionnaires paths: /businessLines: post: @@ -1110,6 +1110,68 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/pciQuestionnaires/signingRequired: + post: + tags: + - PCI questionnaires + summary: Calculate PCI status of a legal entity + description: Calculate PCI status of a legal entity. + x-addedInVersion: '1' + operationId: post-legalEntities-id-pciQuestionnaires-signingRequired + x-sortIndex: 5 + x-methodName: calculatePciStatusOfLegalEntity + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusRequest' + parameters: + - description: The unique identifier of the legal entity to calculate PCI status. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/pciQuestionnaires/{pciid}: get: tags: @@ -2254,6 +2316,46 @@ components: required: - businessLines type: object + CalculatePciStatusRequest: + additionalProperties: false + properties: + additionalSalesChannels: + description: 'An array of additional sales channels to generate PCI questionnaires. + Include the relevant sales channels if you need your user to sign PCI + questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) + and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) + before you generate the questionnaires. + + + Possible values: + + * **eCommerce** + + * **pos** + + * **ecomMoto** + + * **posMoto** + + + ' + items: + enum: + - eCommerce + - ecomMoto + - pos + - posMoto + type: string + type: array + type: object + CalculatePciStatusResponse: + additionalProperties: false + properties: + signingRequired: + description: Indicates if the user is required to sign PCI questionnaires. + If **false**, they do not need to sign any questionnaires. + type: boolean + type: object CalculateTermsOfServiceStatusResponse: additionalProperties: false properties: @@ -2508,6 +2610,7 @@ components: type: string pciTemplateReferences: description: The array of Adyen-generated unique identifiers for the questionnaires. + If empty, the user is not required to sign questionnaires. items: type: string type: array @@ -2789,6 +2892,10 @@ components: - individual - organization type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -2864,11 +2971,19 @@ components: Possible values for trust members: **definedBeneficiary**, **protector**, - **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.' + **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**. + + + Possible value for unincorporated partnership: **unincorporatedPartnership**. + + + Possible values for unincorporated partnership members: **secondaryPartner**, + **uboThroughControl**, **uboThroughOwnership**' enum: - definedBeneficiary - director - protector + - secondaryPartner - secondaryTrustee - settlor - signatory @@ -3001,6 +3116,10 @@ components: - individual - organization type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -3046,6 +3165,10 @@ components: - individual - organization type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -3723,6 +3846,141 @@ components: - registeredAddress - type type: object + UnincorporatedPartnership: + additionalProperties: false + properties: + countryOfGoverningLaw: + description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code of the governing country. + type: string + doingBusinessAs: + description: The registered name, if different from the `name`. + type: string + name: + description: The legal name. + type: string + principalPlaceOfBusiness: + description: The business address. Required if the principal place of business + is different from the `registeredAddress`. + $ref: '#/components/schemas/Address' + registeredAddress: + description: The address registered at the registrar, such as the Chamber + of Commerce. + $ref: '#/components/schemas/Address' + registrationNumber: + description: The registration number. + type: string + type: + description: 'Type of Partnership. + + + Possible values: + + * **limitedPartnership** + + * **generalPartnership** + + * **familyPartnership** + + * **commercialPartnership** + + * **publicPartnership** + + * **otherPartnership** + + * **gbr** + + * **gmbh** + + * **kgaa** + + * **cv** + + * **vof** + + * **maatschap** + + * **privateFundLimitedPartnership** + + * **businessTrustEntity** + + * **businessPartnership** + + * **limitedLiabilityPartnership** + + * **eg** + + * **cooperative** + + * **vos** + + * **comunidadDeBienes** + + * **herenciaYacente** + + * **comunidadDePropietarios** + + * **sep** + + * **sca** + + * **bt** + + * **kkt** + + * **scs** + + * **snc** + + + ' + enum: + - limitedPartnership + - generalPartnership + - familyPartnership + - commercialPartnership + - publicPartnership + - otherPartnership + - gbr + - gmbh + - kgaa + - cv + - vof + - maatschap + - privateFundLimitedPartnership + - businessTrustEntity + - businessPartnership + - limitedLiabilityPartnership + - eg + - cooperative + - vos + - comunidadDeBienes + - herenciaYacente + - comunidadDePropietarios + - sep + - sca + - bt + - kkt + - scs + - snc + type: string + vatAbsenceReason: + description: 'The reason for not providing a VAT number. + + + Possible values: **industryExemption**, **belowTaxThreshold**.' + enum: + - industryExemption + - belowTaxThreshold + type: string + vatNumber: + description: The VAT number. + type: string + required: + - name + - countryOfGoverningLaw + - registeredAddress + type: object VerificationError: additionalProperties: false properties: diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index b551b448..56dd2138 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -32,9 +32,9 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: PCI questionnaires - name: Tax eDelivery consent - name: Hosted Onboarding -- name: PCI questionnaires paths: /businessLines: post: @@ -591,6 +591,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU' + createUnincorporatedPartnershipAU: + $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU' schema: $ref: '#/components/schemas/LegalEntityInfoRequiredType' parameters: @@ -623,6 +625,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS-200' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU-200' + createUnincorporatedPartnershipAU: + $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU-200' schema: $ref: '#/components/schemas/LegalEntity' description: OK - the request has succeeded. @@ -742,6 +746,10 @@ paths: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization' updateLegalEntitySoleProp: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp' + updateLegalEntityUnincorporatedPartnership: + $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership' + updateLegalEntityUnincorporatedPartnershipMember: + $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember' updateTrustMember: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember' updateTrustMemberExempt: @@ -774,6 +782,10 @@ paths: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityOrganization-200' updateLegalEntitySoleProp: $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntitySoleProp-200' + updateLegalEntityUnincorporatedPartnership: + $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership-200' + updateLegalEntityUnincorporatedPartnershipMember: + $ref: '#/components/examples/patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember-200' updateTrustMember: $ref: '#/components/examples/patch-legalEntities-id-updateTrustMember-200' updateTrustMemberExempt: @@ -1273,6 +1285,68 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/pciQuestionnaires/signingRequired: + post: + tags: + - PCI questionnaires + summary: Calculate PCI status of a legal entity + description: Calculate PCI status of a legal entity. + x-addedInVersion: '1' + operationId: post-legalEntities-id-pciQuestionnaires-signingRequired + x-sortIndex: 5 + x-methodName: calculatePciStatusOfLegalEntity + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusRequest' + parameters: + - description: The unique identifier of the legal entity to calculate PCI status. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/pciQuestionnaires/{pciid}: get: tags: @@ -2457,6 +2531,46 @@ components: required: - businessLines type: object + CalculatePciStatusRequest: + additionalProperties: false + properties: + additionalSalesChannels: + description: 'An array of additional sales channels to generate PCI questionnaires. + Include the relevant sales channels if you need your user to sign PCI + questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) + and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) + before you generate the questionnaires. + + + Possible values: + + * **eCommerce** + + * **pos** + + * **ecomMoto** + + * **posMoto** + + + ' + items: + enum: + - eCommerce + - ecomMoto + - pos + - posMoto + type: string + type: array + type: object + CalculatePciStatusResponse: + additionalProperties: false + properties: + signingRequired: + description: Indicates if the user is required to sign PCI questionnaires. + If **false**, they do not need to sign any questionnaires. + type: boolean + type: object CalculateTermsOfServiceStatusResponse: additionalProperties: false properties: @@ -2642,7 +2756,10 @@ components: **proofOfAddress**, or **proofOfIndustry**. - * For **trust**, the `type` value can be **constitutionalDocument**. + * For **trust**, the `type` value is **constitutionalDocument**. + + + * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).' @@ -2771,6 +2888,7 @@ components: type: string pciTemplateReferences: description: The array of Adyen-generated unique identifiers for the questionnaires. + If empty, the user is not required to sign questionnaires. items: type: string type: array @@ -3105,6 +3223,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -3180,13 +3302,21 @@ components: Possible values for trust members: **definedBeneficiary**, **protector**, - **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.' + **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**. + + + Possible value for unincorporated partnership: **unincorporatedPartnership**. + + + Possible values for unincorporated partnership members: **secondaryPartner**, + **uboThroughControl**, **uboThroughOwnership**' enum: - definedBeneficiary - director - immediateParentCompany - pciSignatory - protector + - secondaryPartner - secondaryTrustee - settlor - signatory @@ -3196,6 +3326,7 @@ components: - uboThroughOwnership - ultimateParentCompany - undefinedBeneficiary + - unincorporatedPartnership type: string required: - legalEntityId @@ -3340,6 +3471,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -3393,6 +3528,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -4294,6 +4433,152 @@ components: readOnly: true type: string type: object + UnincorporatedPartnership: + additionalProperties: false + properties: + countryOfGoverningLaw: + description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code of the governing country. + type: string + dateOfIncorporation: + x-addedInVersion: '2' + description: The date when the legal arrangement was incorporated in YYYY-MM-DD + format. + type: string + doingBusinessAs: + description: The registered name, if different from the `name`. + type: string + name: + description: The legal name. + type: string + principalPlaceOfBusiness: + description: The business address. Required if the principal place of business + is different from the `registeredAddress`. + $ref: '#/components/schemas/Address' + registeredAddress: + description: The address registered at the registrar, such as the Chamber + of Commerce. + $ref: '#/components/schemas/Address' + registrationNumber: + description: The registration number. + type: string + taxInformation: + x-addedInVersion: '2' + description: The tax information of the entity. + items: + $ref: '#/components/schemas/TaxInformation' + type: array + type: + description: 'Type of Partnership. + + + Possible values: + + * **limitedPartnership** + + * **generalPartnership** + + * **familyPartnership** + + * **commercialPartnership** + + * **publicPartnership** + + * **otherPartnership** + + * **gbr** + + * **gmbh** + + * **kgaa** + + * **cv** + + * **vof** + + * **maatschap** + + * **privateFundLimitedPartnership** + + * **businessTrustEntity** + + * **businessPartnership** + + * **limitedLiabilityPartnership** + + * **eg** + + * **cooperative** + + * **vos** + + * **comunidadDeBienes** + + * **herenciaYacente** + + * **comunidadDePropietarios** + + * **sep** + + * **sca** + + * **bt** + + * **kkt** + + * **scs** + + * **snc** + + + ' + enum: + - limitedPartnership + - generalPartnership + - familyPartnership + - commercialPartnership + - publicPartnership + - otherPartnership + - gbr + - gmbh + - kgaa + - cv + - vof + - maatschap + - privateFundLimitedPartnership + - businessTrustEntity + - businessPartnership + - limitedLiabilityPartnership + - eg + - cooperative + - vos + - comunidadDeBienes + - herenciaYacente + - comunidadDePropietarios + - sep + - sca + - bt + - kkt + - scs + - snc + type: string + vatAbsenceReason: + description: 'The reason for not providing a VAT number. + + + Possible values: **industryExemption**, **belowTaxThreshold**.' + enum: + - industryExemption + - belowTaxThreshold + type: string + vatNumber: + description: The VAT number. + type: string + required: + - name + - countryOfGoverningLaw + - registeredAddress + type: object VerificationError: additionalProperties: false properties: @@ -4879,6 +5164,83 @@ components: street: Simon Carmiggeltstraat 6 - 50 type: individual id: LE00000000000000000000001 + patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership: + summary: Associate unincorporated partnership to the main partner + description: Example request associating an unincorporated partnership to the + main partner + value: + entityAssociations: + - legalEntityId: LE32CNC223225R5KXM9L97NTZ + type: unincorporatedPartnership + patch-legalEntities-id-updateLegalEntityUnincorporatedPartnership-200: + summary: Unincorporated partnership associated to the main partner + description: Example response associating an unincorporated partnership to the + main partner + value: + entityAssociations: + - associatorId: LE32CNC223225R5KXM9T37PKD + entityType: unincorporatedPartnership + legalEntityId: LE32CNC223225R5KXM9L97NTZ + name: West Family Partnership + type: unincorporatedPartnership + individual: + email: s.eller@example.com + birthData: + dateOfBirth: '1990-06-21' + name: + firstName: Shelly + lastName: Eller + residentialAddress: + city: Sydney + country: AU + stateOrProvince: NSW + postalCode: '1197' + street: 54 Longfield Lane + type: individual + id: LE32CNC223225R5KXM9T37PKD + patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember: + summary: Associate partnership member to an unincorporated partnership + description: Example request for associating a partnership member to an unincorporated + partnership + value: + entityAssociations: + - legalEntityId: LE32CNC223225R5KXM9T37PKD + type: secondaryPartner + patch-legalEntities-id-updateLegalEntityUnincorporatedPartnershipMember-200: + summary: Partnership member associated to an unincorporated partnership + description: Example response associating a partnership member to an unincorporated + partnership + value: + entityAssociations: + - associatorId: LE32CNC223225R5KXM9L97NTZ + entityType: individual + legalEntityId: LE32CNC223225R5KXM9T37PKD + name: Shelly Eller + type: secondaryPartner + unincorporatedPartnership: + countryOfGoverningLaw: AU + doingBusinessAs: '' + name: West Family Partnership + principalPlaceOfBusiness: + city: Sydney + country: AU + postalCode: '5566' + stateOrProvince: NSW + street: 'East City Street ' + street2: '222' + registeredAddress: + city: Sydney + country: AU + postalCode: '1197' + stateOrProvince: NSW + street: 53 Winterfield Avenue + taxInformation: + - country: AU + number: '12345678901' + type: ABN + type: familyPartnership + type: unincorporatedPartnership + id: LE32CNC223225R5KXM9L97NTZ patch-legalEntities-id-updateTrustMember: summary: Associate a trust member with a trust description: Example request associating a trust member with a trust @@ -5359,6 +5721,62 @@ components: reference: SE322KH223222J5HJ6JRB75HQ type: trust id: LE322KH223222J5HJ6JRB75C5 + post-legalEntities-createUnincorporatedPartnershipAU: + summary: Create a legal entity for an unincorporated partnership in Australia + description: Example request for creating a legal entity for an unincorporated + partnership in Australia + value: + type: unincorporatedPartnership + unincorporatedPartnership: + name: West Family Partnership + type: familyPartnership + doingBusinessAs: '' + countryOfGoverningLaw: AU + taxInformation: + - country: AU + type: ABN + number: '12345678901' + registeredAddress: + street: ' 53 Winterfield Avenue' + city: Sydney + postalCode: '1197' + stateOrProvince: NSW + country: AU + principalPlaceOfBusiness: + street: 'East City Street ' + street2: '222' + city: Sydney + postalCode: '5566' + stateOrProvince: NSW + country: AU + post-legalEntities-createUnincorporatedPartnershipAU-200: + summary: Unincorporated partnership legal entity created + description: Example response for creating a legal entity for an unincorporated + partnership in Australia + value: + unincorporatedPartnership: + countryOfGoverningLaw: AU + doingBusinessAs: '' + name: West Family Partnership + registeredAddress: + city: Sydney + country: AU + postalCode: '1197' + stateOrProvince: NSW + street: Winterfield Avenue + principalPlaceOfBusiness: + street: 53 Winterfield Avenue + city: Sydney + postalCode: '1197' + stateOrProvince: NSW + country: AU + taxInformation: + - country: AU + number: '12345678901' + type: ABN + type: familyPartnership + type: unincorporatedPartnership + id: LE322KH223222J5HJ6JRB78K8 post-legalEntities-id-onboardingLinks-createOnboardingLink: summary: Create a hosted onboarding link description: Example request for creating a hosted onboarding link diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index 340bc50d..a92808f9 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -32,9 +32,9 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: PCI questionnaires - name: Tax eDelivery consent - name: Hosted Onboarding -- name: PCI questionnaires paths: /businessLines: post: @@ -595,6 +595,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU' + createUnincorporatedPartnershipAU: + $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU' schema: $ref: '#/components/schemas/LegalEntityInfoRequiredType' parameters: @@ -627,6 +629,8 @@ paths: $ref: '#/components/examples/post-legalEntities-createLegalEntitySolePropUS-200' createTrustAU: $ref: '#/components/examples/post-legalEntities-createTrustAU-200' + createUnincorporatedPartnershipAU: + $ref: '#/components/examples/post-legalEntities-createUnincorporatedPartnershipAU-200' schema: $ref: '#/components/schemas/LegalEntity' description: OK - the request has succeeded. @@ -1405,6 +1409,68 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/pciQuestionnaires/signingRequired: + post: + tags: + - PCI questionnaires + summary: Calculate PCI status of a legal entity + description: Calculate PCI status of a legal entity. + x-addedInVersion: '1' + operationId: post-legalEntities-id-pciQuestionnaires-signingRequired + x-sortIndex: 5 + x-methodName: calculatePciStatusOfLegalEntity + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusRequest' + parameters: + - description: The unique identifier of the legal entity to calculate PCI status. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CalculatePciStatusResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/pciQuestionnaires/{pciid}: get: tags: @@ -2737,6 +2803,46 @@ components: - accountNumber - bankCode type: object + CalculatePciStatusRequest: + additionalProperties: false + properties: + additionalSalesChannels: + description: 'An array of additional sales channels to generate PCI questionnaires. + Include the relevant sales channels if you need your user to sign PCI + questionnaires. Not required if you [create stores](https://docs.adyen.com/platforms) + and [add payment methods](https://docs.adyen.com/adyen-for-platforms-model) + before you generate the questionnaires. + + + Possible values: + + * **eCommerce** + + * **pos** + + * **ecomMoto** + + * **posMoto** + + + ' + items: + enum: + - eCommerce + - ecomMoto + - pos + - posMoto + type: string + type: array + type: object + CalculatePciStatusResponse: + additionalProperties: false + properties: + signingRequired: + description: Indicates if the user is required to sign PCI questionnaires. + If **false**, they do not need to sign any questionnaires. + type: boolean + type: object CalculateTermsOfServiceStatusResponse: additionalProperties: false properties: @@ -2956,7 +3062,10 @@ components: **proofOfAddress**, or **proofOfIndustry**. - * For **trust**, the `type` value can be **constitutionalDocument**. + * For **trust**, the `type` value is **constitutionalDocument**. + + + * For **unincorporatedPartnership**, the `type` value is **constitutionalDocument**. * Use **bankStatement** to upload documents for a [transfer instrument](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/transferInstruments__resParam_id).' @@ -3086,6 +3195,7 @@ components: type: string pciTemplateReferences: description: The array of Adyen-generated unique identifiers for the questionnaires. + If empty, the user is not required to sign questionnaires. items: type: string type: array @@ -3487,6 +3597,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' verificationDeadlines: x-addedInVersion: '3' description: List of verification deadlines and the capabilities that will @@ -3570,7 +3684,14 @@ components: Possible values for trust members: **definedBeneficiary**, **protector**, - **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**.' + **secondaryTrustee**, **settlor**, **uboThroughControl**, or **uboThroughOwnership**. + + + Possible value for unincorporated partnership: **unincorporatedPartnership**. + + + Possible values for unincorporated partnership members: **secondaryPartner**, + **uboThroughControl**, **uboThroughOwnership**' enum: - definedBeneficiary - director @@ -3578,6 +3699,7 @@ components: - legalRepresentative - pciSignatory - protector + - secondaryPartner - secondaryTrustee - settlor - signatory @@ -3588,6 +3710,7 @@ components: - uboThroughOwnership - ultimateParentCompany - undefinedBeneficiary + - unincorporatedPartnership type: string required: - legalEntityId @@ -3725,6 +3848,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -3778,6 +3905,10 @@ components: - trust - unincorporatedPartnership type: string + unincorporatedPartnership: + description: Information about the unincorporated partnership. Required + if `type` is **unincorporatedPartnership**. + $ref: '#/components/schemas/UnincorporatedPartnership' 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/verification-overview/verification-types/#upfront-verification). @@ -4895,6 +5026,156 @@ components: readOnly: true type: string type: object + UnincorporatedPartnership: + additionalProperties: false + properties: + countryOfGoverningLaw: + description: The two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code of the governing country. + type: string + dateOfIncorporation: + x-addedInVersion: '2' + description: The date when the legal arrangement was incorporated in YYYY-MM-DD + format. + type: string + description: + x-addedInVersion: '3' + description: Short description about the Legal Arrangement. + type: string + doingBusinessAs: + description: The registered name, if different from the `name`. + type: string + name: + description: The legal name. + type: string + principalPlaceOfBusiness: + description: The business address. Required if the principal place of business + is different from the `registeredAddress`. + $ref: '#/components/schemas/Address' + registeredAddress: + description: The address registered at the registrar, such as the Chamber + of Commerce. + $ref: '#/components/schemas/Address' + registrationNumber: + description: The registration number. + type: string + taxInformation: + x-addedInVersion: '2' + description: The tax information of the entity. + items: + $ref: '#/components/schemas/TaxInformation' + type: array + type: + description: 'Type of Partnership. + + + Possible values: + + * **limitedPartnership** + + * **generalPartnership** + + * **familyPartnership** + + * **commercialPartnership** + + * **publicPartnership** + + * **otherPartnership** + + * **gbr** + + * **gmbh** + + * **kgaa** + + * **cv** + + * **vof** + + * **maatschap** + + * **privateFundLimitedPartnership** + + * **businessTrustEntity** + + * **businessPartnership** + + * **limitedLiabilityPartnership** + + * **eg** + + * **cooperative** + + * **vos** + + * **comunidadDeBienes** + + * **herenciaYacente** + + * **comunidadDePropietarios** + + * **sep** + + * **sca** + + * **bt** + + * **kkt** + + * **scs** + + * **snc** + + + ' + enum: + - limitedPartnership + - generalPartnership + - familyPartnership + - commercialPartnership + - publicPartnership + - otherPartnership + - gbr + - gmbh + - kgaa + - cv + - vof + - maatschap + - privateFundLimitedPartnership + - businessTrustEntity + - businessPartnership + - limitedLiabilityPartnership + - eg + - cooperative + - vos + - comunidadDeBienes + - herenciaYacente + - comunidadDePropietarios + - sep + - sca + - bt + - kkt + - scs + - snc + type: string + vatAbsenceReason: + description: 'The reason for not providing a VAT number. + + + Possible values: **industryExemption**, **belowTaxThreshold**.' + enum: + - industryExemption + - belowTaxThreshold + type: string + vatNumber: + description: The VAT number. + type: string + required: + - name + - countryOfGoverningLaw + - registeredAddress + type: object VerificationDeadline: additionalProperties: false properties: @@ -6111,6 +6392,62 @@ components: reference: SE322KH223222J5HJ6JRB75HQ type: trust id: LE322KH223222J5HJ6JRB75C5 + post-legalEntities-createUnincorporatedPartnershipAU: + summary: Create a legal entity for an unincorporated partnership in Australia + description: Example request for creating a legal entity for an unincorporated + partnership in Australia + value: + type: unincorporatedPartnership + unincorporatedPartnership: + name: West Family Partnership + type: familyPartnership + doingBusinessAs: '' + countryOfGoverningLaw: AU + taxInformation: + - country: AU + type: ABN + number: '12345678901' + registeredAddress: + street: ' 53 Winterfield Avenue' + city: Sydney + postalCode: '1197' + stateOrProvince: NSW + country: AU + principalPlaceOfBusiness: + street: 'East City Street ' + street2: '222' + city: Sydney + postalCode: '5566' + stateOrProvince: NSW + country: AU + post-legalEntities-createUnincorporatedPartnershipAU-200: + summary: Unincorporated partnership legal entity created + description: Example response for creating a legal entity for an unincorporated + partnership in Australia + value: + unincorporatedPartnership: + countryOfGoverningLaw: AU + doingBusinessAs: '' + name: West Family Partnership + registeredAddress: + city: Sydney + country: AU + postalCode: '1197' + stateOrProvince: NSW + street: Winterfield Avenue + principalPlaceOfBusiness: + street: 53 Winterfield Avenue + city: Sydney + postalCode: '1197' + stateOrProvince: NSW + country: AU + taxInformation: + - country: AU + number: '12345678901' + type: ABN + type: familyPartnership + type: unincorporatedPartnership + id: LE322KH223222J5HJ6JRB78K8 post-legalEntities-id-checkVerificationErrors-checkVerificationErrors-200: summary: Verification errors for a legal entity description: Example response when checking the verification errors of a legal