spec release

This commit is contained in:
Adyen Automation
2023-05-26 12:56:30 +00:00
parent 8b5c747c20
commit d11715be1f
4 changed files with 28 additions and 78 deletions

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Legal Entity Management API",
"description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws_123456@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\n>If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n",
"x-timestamp" : "2023-05-25T17:22:32Z",
"x-timestamp" : "2023-05-25T18:23:16Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -3374,7 +3374,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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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",
@@ -3388,7 +3388,8 @@
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
"constitutionalDocument",
"proofOfFundingOrWealthSource"
],
"type" : "string"
}
@@ -3606,7 +3607,7 @@
"type" : "string"
},
"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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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",
@@ -3620,7 +3621,8 @@
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
"constitutionalDocument",
"proofOfFundingOrWealthSource"
],
"type" : "string"
}

View File

@@ -10,7 +10,7 @@
"x-publicVersion" : true,
"title" : "Legal Entity Management API",
"description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nTo connect to the Legal Entity Management API, you must use the basic authentication credentials of your web service user. If you don't have one, contact the [Adyen Support Team](https://www.adyen.help/hc/en-us/requests/new). Use the web service user credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws_123456@Scope.BalancePlatform_YourBalancePlatform\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nThe Legal Entity Management API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\n>If you are using hosted onboarding, [only use v2](https://docs.adyen.com/release-notes/platforms-and-financial-products#releaseNote=2023-05-01-legal-entity-management-api-3) for your API requests.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the username and password to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n",
"x-timestamp" : "2023-05-25T17:22:33Z",
"x-timestamp" : "2023-05-26T14:24:32Z",
"termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
"contact" : {
"name" : "Adyen Developer Experience team",
@@ -3159,9 +3159,6 @@
{
"$ref" : "#/components/schemas/SELocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/SGLocalAccountIdentification"
},
{
"$ref" : "#/components/schemas/UKLocalAccountIdentification"
},
@@ -3695,7 +3692,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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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",
@@ -3709,7 +3706,8 @@
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
"constitutionalDocument",
"proofOfFundingOrWealthSource"
],
"type" : "string"
}
@@ -3973,7 +3971,7 @@
"type" : "string"
},
"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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, or **proofOfIndustry**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, or **proofOfIndividualTaxId**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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\nWhen providing ID numbers:\n* For **individual**, the `type` values can be **driversLicense**, **identityCard**, **nationalIdNumber**, or **passport**.\n\nWhen uploading photo IDs:\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, or **passport**.\n\nWhen uploading other documents:\n* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**, **vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**, **proofOfIndustry**, or **proofOfFundingOrWealthSource**.\n\n* For **individual**, the `type` values can be **identityCard**, **driversLicense**, **passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**, **proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.\n\n* For **soleProprietorship**, the `type` values can be **constitutionalDocument**, **proofOfAddress**, or **proofOfIndustry**.\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",
@@ -3987,7 +3985,8 @@
"vatDocument",
"proofOfOrganizationTaxInfo",
"proofOfIndustry",
"constitutionalDocument"
"constitutionalDocument",
"proofOfFundingOrWealthSource"
],
"type" : "string"
}
@@ -4763,36 +4762,6 @@
],
"type" : "object"
},
"SGLocalAccountIdentification" : {
"additionalProperties" : false,
"properties" : {
"accountNumber" : {
"description" : "The 4- to 19-digit bank account number, without separators or whitespace.",
"maxLength" : 19,
"minLength" : 4,
"type" : "string"
},
"bic" : {
"description" : "The bank's 8- or 11-character BIC or SWIFT code.",
"maxLength" : 11,
"minLength" : 8,
"type" : "string"
},
"type" : {
"default" : "sgLocal",
"description" : "**sgLocal**",
"enum" : [
"sgLocal"
],
"type" : "string"
}
},
"required" : [
"accountNumber",
"bic"
],
"type" : "object"
},
"ServiceError" : {
"properties" : {
"errorCode" : {

View File

@@ -22,7 +22,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n"
x-timestamp: '2023-05-25T17:22:32Z'
x-timestamp: '2023-05-25T18:23:16Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -2261,12 +2261,12 @@ components:
* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**,
**vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**,
or **proofOfIndustry**.
**proofOfIndustry**, or **proofOfFundingOrWealthSource**.
* For **individual**, the `type` values can be **identityCard**, **driversLicense**,
**passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**,
or **proofOfIndividualTaxId**.
**proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.
* For **soleProprietorship**, the `type` values can be **constitutionalDocument**,
@@ -2288,6 +2288,7 @@ components:
- proofOfOrganizationTaxInfo
- proofOfIndustry
- constitutionalDocument
- proofOfFundingOrWealthSource
type: string
required:
- type
@@ -2480,12 +2481,12 @@ components:
* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**,
**vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**,
or **proofOfIndustry**.
**proofOfIndustry**, or **proofOfFundingOrWealthSource**.
* For **individual**, the `type` values can be **identityCard**, **driversLicense**,
**passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**,
or **proofOfIndividualTaxId**.
**proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.
* For **soleProprietorship**, the `type` values can be **constitutionalDocument**,
@@ -2507,6 +2508,7 @@ components:
- proofOfOrganizationTaxInfo
- proofOfIndustry
- constitutionalDocument
- proofOfFundingOrWealthSource
type: string
required:
- type

View File

@@ -22,7 +22,7 @@ info:
```\n## Going live\nWhen going live, your Adyen contact will provide your API\
\ credential for the live environment. You can then use the username and password\
\ to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n"
x-timestamp: '2023-05-25T17:22:33Z'
x-timestamp: '2023-05-26T14:24:32Z'
termsOfService: https://www.adyen.com/legal/terms-and-conditions
contact:
name: Adyen Developer Experience team
@@ -2005,7 +2005,6 @@ components:
- $ref: '#/components/schemas/NumberAndBicAccountIdentification'
- $ref: '#/components/schemas/PLLocalAccountIdentification'
- $ref: '#/components/schemas/SELocalAccountIdentification'
- $ref: '#/components/schemas/SGLocalAccountIdentification'
- $ref: '#/components/schemas/UKLocalAccountIdentification'
- $ref: '#/components/schemas/USLocalAccountIdentification'
accountType:
@@ -2494,12 +2493,12 @@ components:
* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**,
**vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**,
or **proofOfIndustry**.
**proofOfIndustry**, or **proofOfFundingOrWealthSource**.
* For **individual**, the `type` values can be **identityCard**, **driversLicense**,
**passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**,
or **proofOfIndividualTaxId**.
**proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.
* For **soleProprietorship**, the `type` values can be **constitutionalDocument**,
@@ -2521,6 +2520,7 @@ components:
- proofOfOrganizationTaxInfo
- proofOfIndustry
- constitutionalDocument
- proofOfFundingOrWealthSource
type: string
required:
- type
@@ -2748,12 +2748,12 @@ components:
* For **organization**, the `type` values can be **proofOfAddress**, **registrationDocument**,
**vatDocument**, **proofOfOrganizationTaxInfo**, **proofOfOwnership**,
or **proofOfIndustry**.
**proofOfIndustry**, or **proofOfFundingOrWealthSource**.
* For **individual**, the `type` values can be **identityCard**, **driversLicense**,
**passport**, **proofOfNationalIdNumber**, **proofOfResidency**, **proofOfIndustry**,
or **proofOfIndividualTaxId**.
**proofOfIndividualTaxId**, or **proofOfFundingOrWealthSource**.
* For **soleProprietorship**, the `type` values can be **constitutionalDocument**,
@@ -2775,6 +2775,7 @@ components:
- proofOfOrganizationTaxInfo
- proofOfIndustry
- constitutionalDocument
- proofOfFundingOrWealthSource
type: string
required:
- type
@@ -3486,30 +3487,6 @@ components:
- accountNumber
- clearingNumber
type: object
SGLocalAccountIdentification:
additionalProperties: false
properties:
accountNumber:
description: The 4- to 19-digit bank account number, without separators
or whitespace.
maxLength: 19
minLength: 4
type: string
bic:
description: The bank's 8- or 11-character BIC or SWIFT code.
maxLength: 11
minLength: 8
type: string
type:
default: sgLocal
description: '**sgLocal**'
enum:
- sgLocal
type: string
required:
- accountNumber
- bic
type: object
ServiceError:
properties:
errorCode: