Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Jan 16, 2024
1 parent 4b5f19e commit 945c0f5
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 66 deletions.
12 changes: 6 additions & 6 deletions json/LegalEntityService-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -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\nYour Adyen contact will provide your API credential and an API key. To 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```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"[email protected]_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\\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>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\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password 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\nYour Adyen contact will provide your API credential and an API key. To 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```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"[email protected]_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\\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>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password 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",
Expand Down Expand Up @@ -46,7 +46,7 @@
"Business lines"
],
"summary" : "Create a business line",
"description" : "Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.\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\n",
"description" : "Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-businessLines",
"x-sortIndex" : 12,
Expand Down Expand Up @@ -769,7 +769,7 @@
"Legal entities"
],
"summary" : "Create a legal entity",
"description" : "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \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\n",
"description" : "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities",
"x-sortIndex" : 1,
Expand Down Expand Up @@ -1232,7 +1232,7 @@
"Hosted Onboarding"
],
"summary" : "Get a link to an Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.\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\n",
"description" : "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities-id-onboardingLinks",
"x-sortIndex" : 1,
Expand Down Expand Up @@ -2229,7 +2229,7 @@
"Hosted Onboarding"
],
"summary" : "Get a list of hosted onboarding page themes",
"description" : "Returns a list of hosted onboarding page themes.\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\n",
"description" : "Returns a list of hosted onboarding page themes.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "get-themes",
"x-sortIndex" : 2,
Expand Down Expand Up @@ -2319,7 +2319,7 @@
"Hosted Onboarding"
],
"summary" : "Get an onboarding link theme",
"description" : "Returns the details of the theme identified in the path.>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\n",
"description" : "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "get-themes-id",
"x-sortIndex" : 4,
Expand Down
12 changes: 6 additions & 6 deletions json/LegalEntityService-v2.json
Original file line number Diff line number Diff line change
Expand Up @@ -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\nYour Adyen contact will provide your API credential and an API key. To 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```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"[email protected]_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\\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>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\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password 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\nYour Adyen contact will provide your API credential and an API key. To 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```\nAlternatively, you can use the username and password of your API credential to connect to the API using basic authentication. For example:\n\n```\ncurl\n-U \"[email protected]_YOUR_COMPANY_ACCOUNT\":\"YourWsPassword\" \\\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>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n## Going live\nWhen going live, your Adyen contact will provide your API credential for the live environment. You can then use the API key or the username and password 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",
Expand Down Expand Up @@ -46,7 +46,7 @@
"Business lines"
],
"summary" : "Create a business line",
"description" : "Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.\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\n",
"description" : "Creates a business line. \n\nThis resource contains information about your user's line of business, including their industry and their source of funds. Adyen uses this information to verify your users as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-businessLines",
"x-sortIndex" : 12,
Expand Down Expand Up @@ -876,7 +876,7 @@
"Legal entities"
],
"summary" : "Create a legal entity",
"description" : "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \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\n",
"description" : "Creates a legal entity. \n\nThis resource contains information about the user that will be onboarded in your platform. Adyen uses this information to perform verification checks as required by payment industry regulations. Adyen informs you of the verification results through webhooks or API responses. \n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities",
"x-sortIndex" : 1,
Expand Down Expand Up @@ -1375,7 +1375,7 @@
"Hosted Onboarding"
],
"summary" : "Get a link to an Adyen-hosted onboarding page",
"description" : "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.\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\n",
"description" : "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "post-legalEntities-id-onboardingLinks",
"x-sortIndex" : 1,
Expand Down Expand Up @@ -2372,7 +2372,7 @@
"Hosted Onboarding"
],
"summary" : "Get a list of hosted onboarding page themes",
"description" : "Returns a list of hosted onboarding page themes.\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\n",
"description" : "Returns a list of hosted onboarding page themes.\n\n>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "get-themes",
"x-sortIndex" : 2,
Expand Down Expand Up @@ -2462,7 +2462,7 @@
"Hosted Onboarding"
],
"summary" : "Get an onboarding link theme",
"description" : "Returns the details of the theme identified in the path.>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\n",
"description" : "Returns the details of the theme identified in the path.>If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2.\n\n",
"x-addedInVersion" : "1",
"operationId" : "get-themes-id",
"x-sortIndex" : 4,
Expand Down
Loading

0 comments on commit 945c0f5

Please sign in to comment.