-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
15f05ef
commit 9f370ad
Showing
3 changed files
with
50 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
"info": { | ||
"name": "Legal Entity Management API (v1)", | ||
"description": { | ||
"content": "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", | ||
"content": "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", | ||
"type": "text/markdown" | ||
}, | ||
"version": "1", | ||
|
@@ -14,7 +14,7 @@ | |
"item": [ | ||
{ | ||
"name": "/legalEntities", | ||
"description": "Creates a legal entity. This 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. >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. ", | ||
"description": "Creates a legal entity. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", | ||
"item": [ | ||
{ | ||
"name": "Create a legal entity for an individual residing in the Netherlands", | ||
|
@@ -62,7 +62,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a legal entity. This 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. >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. " | ||
"description": "Creates a legal entity. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
}, | ||
{ | ||
|
@@ -111,7 +111,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a legal entity. This 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. >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. " | ||
"description": "Creates a legal entity. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
}, | ||
{ | ||
|
@@ -160,7 +160,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a legal entity. This 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. >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. " | ||
"description": "Creates a legal entity. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
}, | ||
{ | ||
|
@@ -209,7 +209,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a legal entity. This 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. >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. " | ||
"description": "Creates a legal entity. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
} | ||
] | ||
|
@@ -440,7 +440,7 @@ | |
"item": [ | ||
{ | ||
"name": "/legalEntities/:id/onboardingLinks", | ||
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >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. ", | ||
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", | ||
"item": [ | ||
{ | ||
"name": "Create a hosted onboarding link", | ||
|
@@ -489,15 +489,15 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >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. " | ||
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
} | ||
] | ||
} | ||
, | ||
{ | ||
"name": "/themes", | ||
"description": "Returns a list of hosted onboarding page themes. >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. ", | ||
"description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", | ||
"item": [ | ||
{ | ||
"name": "Get a list of hosted onboarding page themes", | ||
|
@@ -533,15 +533,15 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Returns a list of hosted onboarding page themes. >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. " | ||
"description": "Returns a list of hosted onboarding page themes. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
} | ||
] | ||
} | ||
, | ||
{ | ||
"name": "/themes/:id", | ||
"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. ", | ||
"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. ", | ||
"item": [ | ||
{ | ||
"name": "Get an onboarding link theme", | ||
|
@@ -583,7 +583,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"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. " | ||
"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. " | ||
} | ||
} | ||
] | ||
|
@@ -596,7 +596,7 @@ | |
"item": [ | ||
{ | ||
"name": "/businessLines", | ||
"description": "Creates a business line. This 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. >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. ", | ||
"description": "Creates a business line. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. ", | ||
"item": [ | ||
{ | ||
"name": "Create a business line for a business account", | ||
|
@@ -638,7 +638,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a business line. This 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. >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. " | ||
"description": "Creates a business line. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
}, | ||
{ | ||
|
@@ -681,7 +681,7 @@ | |
"query": [ | ||
] | ||
}, | ||
"description": "Creates a business line. This 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. >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. " | ||
"description": "Creates a business line. This 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. >If you are using hosted onboarding and just beginning your integration, use v3 for your API requests. Otherwise, use v2. " | ||
} | ||
} | ||
] | ||
|
Oops, something went wrong.