spec release

Adyen · Sep 4, 2024 · 9c80253 · 9c80253
1 parent 963849f
commit 9c80253
Show file tree

Hide file tree

Showing 6 changed files with 121 additions and 25 deletions.
diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json
@@ -9,7 +9,7 @@
       "version" : "1",
       "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\nEach request to the Configuration API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n",
+      "description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nEach request to the Legal Entity Management API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v1/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v1`.\n\n",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -4706,7 +4706,7 @@
                   "type" : "array"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",
@@ -4790,7 +4790,7 @@
                   "type" : "string"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",

diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json
@@ -9,7 +9,7 @@
       "version" : "2",
       "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\nEach request to the Configuration API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n",
+      "description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nEach request to the Legal Entity Management API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v2/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v2`.\n\n",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -3885,7 +3885,7 @@
                   "type" : "string"
                },
                "type" : {
-                  "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber",
+                  "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber**",
                   "enum" : [
                      "nationalIdNumber",
                      "passport",
@@ -5241,7 +5241,7 @@
                   "type" : "array"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",
@@ -5325,7 +5325,7 @@
                   "type" : "string"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",

diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json
@@ -9,7 +9,7 @@
       "version" : "3",
       "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\nEach request to the Configuration API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n",
+      "description" : "The Legal Entity Management API enables you to manage legal entities that contain information required for verification. \n## Authentication\nEach request to the Legal Entity Management API must be signed with an API key. Generate an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key) or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key) in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key` header with the API key as the value. For example:\n\n```\ncurl\n-H \"X-API-Key: YOUR_API_KEY\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n## Versioning\nThe Legal Entity Management API supports [versioning](https://docs.adyen.com/development-resources/versioning) using a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://kyc-test.adyen.com/lem/v3/legalEntities\n```\n## Going live\nWhen going live, generate an API key in your [live Customer Area](https://ca-live.adyen.com/ca/) if you have an Adyen for Platforms integration or [live Balance Platform Customer Area](https://balanceplatform-live.adyen.com/balanceplatform/) if you have an Adyen Issuing integration.You can then use the API key to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n",
       "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions",
       "contact" : {
          "name" : "Adyen Developer Experience team",
@@ -4399,7 +4399,7 @@
                   "type" : "string"
                },
                "type" : {
-                  "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber",
+                  "description" : "Type of identity data. For individuals, the following types are supported:\n\n- Australia: **driversLicense**, **passport**\n\n- Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n- New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**, **nationalIdNumber**, **passport** \n\n- All other supported countries: **nationalIdNumber**",
                   "enum" : [
                      "nationalIdNumber",
                      "passport",
@@ -6107,7 +6107,7 @@
                   "type" : "array"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",
@@ -6191,7 +6191,7 @@
                   "type" : "string"
                },
                "type" : {
-                  "description" : "The type of error.",
+                  "description" : "The type of error.\n\nPossible values:\n*  **invalidInput**\n*  **dataMissing**\n*  **pendingStatus**\n*  **rejected**\n*  **dataReview**\n\n",
                   "enum" : [
                      "dataMissing",
                      "dataReview",

diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml
@@ -7,8 +7,8 @@ info:
   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\nEach\
-    \ request to the Configuration API must be signed with an API key. Generate an\
-    \ API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key)\
+    \ request to the Legal Entity Management API must be signed with an API key. Generate\
+    \ an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key)\
     \ or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\
     \n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
     \ in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key`\
@@ -3631,7 +3631,23 @@ components:
             $ref: '#/components/schemas/VerificationError-recursive'
           type: array
         type:
-          description: The type of error.
+          description: 'The type of error.
+
+
+            Possible values:
+
+            *  **invalidInput**
+
+            *  **dataMissing**
+
+            *  **pendingStatus**
+
+            *  **rejected**
+
+            *  **dataReview**
+
+
+            '
           enum:
           - dataMissing
           - dataReview
@@ -3709,7 +3725,23 @@ components:
           description: The general error message.
           type: string
         type:
-          description: The type of error.
+          description: 'The type of error.
+
+
+            Possible values:
+
+            *  **invalidInput**
+
+            *  **dataMissing**
+
+            *  **pendingStatus**
+
+            *  **rejected**
+
+            *  **dataReview**
+
+
+            '
           enum:
           - dataMissing
           - dataReview

diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml
@@ -7,8 +7,8 @@ info:
   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\nEach\
-    \ request to the Configuration API must be signed with an API key. Generate an\
-    \ API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key)\
+    \ request to the Legal Entity Management API must be signed with an API key. Generate\
+    \ an API key in your Customer Area if you have a [platform setup](https://docs.adyen.com/platforms/manage-access/api-credentials-web-service/#generate-api-key)\
     \ or [marketplace setup](https://docs.adyen.com/marketplaces/manage-access/api-credentials-web-service/#generate-api-key).\n\
     \n If you have an Adyen Issuing integration, [generate an API key](https://docs.adyen.com/issuing/manage-access/api-credentials-web-service/#generate-api-key)\
     \ in your Balance Platform Customer Area.\n\nTo connect to the API, add an `X-API-Key`\
@@ -2742,7 +2742,7 @@ components:
             - Hong Kong: **driversLicense**, **nationalIdNumber**, **passport**\n\n\
             - New Zealand: **driversLicense**, **passport**\n\n- Singapore: **driversLicense**,\
             \ **nationalIdNumber**, **passport** \n\n- All other supported countries:\
-            \ **nationalIdNumber"
+            \ **nationalIdNumber**"
           enum:
           - nationalIdNumber
           - passport
@@ -4114,7 +4114,23 @@ components:
             $ref: '#/components/schemas/VerificationError-recursive'
           type: array
         type:
-          description: The type of error.
+          description: 'The type of error.
+
+
+            Possible values:
+
+            *  **invalidInput**
+
+            *  **dataMissing**
+
+            *  **pendingStatus**
+
+            *  **rejected**
+
+            *  **dataReview**
+
+
+            '
           enum:
           - dataMissing
           - dataReview
@@ -4192,7 +4208,23 @@ components:
           description: The general error message.
           type: string
         type:
-          description: The type of error.
+          description: 'The type of error.
+
+
+            Possible values:
+
+            *  **invalidInput**
+
+            *  **dataMissing**
+
+            *  **pendingStatus**
+
+            *  **rejected**
+
+            *  **dataReview**
+
+
+            '
           enum:
           - dataMissing
           - dataReview