jlengrand/adyen-postman
1
0
Fork 0
mirror of https://github.com/gcatanese/adyen-postman.git synced 2026-03-10 08:01:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2c763919aaaf2712410b1271f48d5c6537022931
adyen-postman/postman/LegalEntityService-v3.json
AdyenAutomationBot 2c763919aa Update latest definitions files
2024-05-06 08:21:50 +00:00

3770 lines
134 KiB
JSON
Raw Blame History

{
"info": {
"name": "Legal Entity Management API (v3)",
"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 \"ws_123456@Scope.Company_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/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 API key or the username and password to send requests to `https://kyc-live.adyen.com/lem/v3`.\n\n",
"type": "text/markdown"
},
"version": "3",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
"name": "Legal entities",
"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. ",
"item": [
{
"name": "Create a legal entity for an individual residing in the Netherlands",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"email\": \"s.eller@example.com\",\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for an individual residing in the US",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"email\": \"s.eller@example.com\",\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\",\n \"individual\": {\n \"residentialAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"phone\": {\n \"number\": \"+14153671502\",\n \"type\": \"mobile\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"email\": \"s.eller@example.com\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for a Dutch organization",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"signatory\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE00000000000000000000002\",\n \"entityType\": \"individual\",\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"name\": \"Simone Hopper\",\n \"type\": \"signatory\"\n}],\n \"organization\": {\n \"email\": \"organization@example.com\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"legalName\": \"Explorer Company based in NL\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"type\": \"privateCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE00000000000000000000002\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in NL\",\n \"doingBusinessAs\": \"API Company Trading\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"34179503\",\n \"email\": \"organization@example.com\"\n},\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"signatory\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for an organization in the US",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n},\n \"type\": \"privateCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"organization\",\n \"organization\": {\n \"legalName\": \"Explorer Company based in US\",\n \"registrationNumber\": \"101002749\",\n \"type\": \"privateCompany\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for a Dutch sole proprietor",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\": \"NL\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\": \"NL\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n},\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Seller Sole Trader\",\n \"countryOfGoverningLaw\": \"NL\",\n \"registeredAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for a sole proprietor in the US",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\": \"US\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\": \"US\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n},\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"soleProprietorship\",\n \"soleProprietorship\": {\n \"name\": \"Shelly Eller Sole Trader\",\n \"countryOfGoverningLaw\": \"US\",\n \"registeredAddress\": {\n \"city\": \"New York\",\n \"country\": \"US\",\n \"postalCode\": \"10003\",\n \"stateOrProvince\": \"NY\",\n \"street\": \"71 5th Avenue\",\n \"street2\": \"11th floor\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a legal entity for a trust in Australia",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"trust\",\n \"trust\": {\n \"name\": \"Example Trust\",\n \"type\": \"fixedUnitTrust\",\n \"doingBusinessAs\": \"West's Store\",\n \"countryOfGoverningLaw\": \"AU\",\n \"taxInformation\": [{\n \"country\": \"AU\",\n \"type\": \"ABN\",\n \"number\": \"12345678123\"\n}],\n \"registeredAddress\": {\n \"street\": \"Winfield Avenue\",\n \"city\": \"Sydney\",\n \"postalCode\": \"1197\",\n \"stateOrProvince\": \"NSW\",\n \"country\": \"AU\"\n},\n \"undefinedBeneficiaryInfo\": [{\n \"description\": \"My future children\"\n}]\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"trust\": {\n \"countryOfGoverningLaw\": \"AU\",\n \"doingBusinessAs\": \"West's Store\",\n \"name\": \"Example Trust\",\n \"registeredAddress\": {\n \"city\": \"Sydney\",\n \"country\": \"AU\",\n \"postalCode\": \"1197\",\n \"stateOrProvince\": \"NSW\",\n \"street\": \"Winfield Avenue\"\n},\n \"taxInformation\": [{\n \"country\": \"AU\",\n \"number\": \"12345678901\",\n \"type\": \"ABN\"\n}],\n \"type\": \"fixedUnitTrust\",\n \"undefinedBeneficiaryInfo\": [{\n \"description\": \"My future children\",\n \"reference\": \"SE322KH223222J5HJ6JRB75HQ\"\n}]\n},\n \"type\": \"trust\",\n \"id\": \"LE322KH223222J5HJ6JRB75C5\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"trust\",\n \"trust\": {\n \"name\": \"Example Trust\",\n \"type\": \"fixedUnitTrust\",\n \"doingBusinessAs\": \"West's Store\",\n \"countryOfGoverningLaw\": \"AU\",\n \"taxInformation\": [{\n \"country\": \"AU\",\n \"type\": \"ABN\",\n \"number\": \"12345678123\"\n}],\n \"registeredAddress\": {\n \"street\": \"Winfield Avenue\",\n \"city\": \"Sydney\",\n \"postalCode\": \"1197\",\n \"stateOrProvince\": \"NSW\",\n \"country\": \"AU\"\n},\n \"undefinedBeneficiaryInfo\": [{\n \"description\": \"My future children\"\n}]\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities"
],
"variable": [
],
"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. "
}
}
]
}
]
},
{
"name": "/legalEntities/:id",
"description": "Returns a legal entity.",
"item": [
{
"name": "Get a legal entity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Returns a legal entity."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id",
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries.",
"item": [
{
"name": "Change a legal entity from an organization to an individual",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"individual\": {\n \"name\": {\n \"firstName\": \"Explorer\",\n \"lastName\": \"Company based in US\"\n},\n \"residentialAddress\": {\n \"country\": \"US\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"individual\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
},
{
"name": "Add entity associations to an organization",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"uboThroughControl\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE00000000000000000000001\",\n \"entityType\": \"individual\",\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"name\": \"Simone Hopper\",\n \"type\": \"uboThroughControl\"\n}],\n \"organization\": {\n \"email\": \"john.doe@adyen.com\",\n \"phone\": {\n \"number\": \"646467363\",\n \"type\": \"mobile\"\n},\n \"description\": \"FinTech\",\n \"doingBusinessAs\": \"Adyen BV\",\n \"legalName\": \"Adyen BV\",\n \"registeredAddress\": {\n \"city\": \"AMS\",\n \"country\": \"NL\",\n \"postalCode\": \"1234EE\",\n \"stateOrProvince\": \"NH\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n},\n \"registrationNumber\": \"\",\n \"stockData\": {\n \"marketIdentifier\": \"ADYN\",\n \"stockNumber\": \"NL012345ABC4\",\n \"tickerSymbol\": \"ADYN.M\"\n},\n \"type\": \"listedPublicCompany\"\n},\n \"type\": \"organization\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"jobTitle\": \"CEO\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"uboThroughControl\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
},
{
"name": "Add entity associations to a sole proprietorship",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"soleProprietorship\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE00000000000000000000001\",\n \"entityType\": \"soleProprietorship\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"soleProprietorship\"\n}],\n \"individual\": {\n \"email\": \"s.eller@example.com\",\n \"birthData\": {\n \"dateOfBirth\": \"1990-06-21\"\n},\n \"name\": {\n \"firstName\": \"Shelly\",\n \"lastName\": \"Eller\"\n},\n \"residentialAddress\": {\n \"city\": \"Amsterdam\",\n \"country\": \"NL\",\n \"postalCode\": \"1011DJ\",\n \"street\": \"Simon Carmiggeltstraat 6 - 50\"\n}\n},\n \"type\": \"individual\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"soleProprietorship\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
},
{
"name": "Associate a trust member with a trust",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"protector\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE00000000000000000000001\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"name\": \"Simone Hopper\",\n \"type\": \"protector\"\n}],\n \"trust\": {\n \"name\": \"Example Trust\",\n \"type\": \"fixedUnitTrust\",\n \"doingBusinessAs\": \"West's Store\",\n \"countryOfGoverningLaw\": \"AU\",\n \"taxInformation\": [{\n \"country\": \"AU\",\n \"type\": \"ABN\",\n \"number\": \"12345678901\"\n}],\n \"registeredAddress\": {\n \"street\": \"Winfield Avenue\",\n \"city\": \"Sydney\",\n \"postalCode\": \"1197\",\n \"stateOrProvince\": \"NSW\",\n \"country\": \"AU\"\n},\n \"undefinedBeneficiaryInfo\": [{\n \"description\": \"My future children\"\n}]\n},\n \"type\": \"trust\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"protector\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
},
{
"name": "Associate an exempt settlor with a trust",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"settlor\",\n \"entityType\": \"individual\",\n \"settlorExemptionReason\": [\"deceased\", \"professionalServiceProvider\"]\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"entityAssociations\": [{\n \"associatorId\": \"LE00000000000000000000001\",\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"settlor\",\n \"entityType\": \"individual\",\n \"settlorExemptionReason\": [\"deceased\", \"professionalServiceProvider\"]\n}],\n \"trust\": {\n \"name\": \"Example Trust\",\n \"type\": \"fixedUnitTrust\",\n \"doingBusinessAs\": \"West's Store\",\n \"countryOfGoverningLaw\": \"AU\",\n \"taxInformation\": [{\n \"country\": \"AU\",\n \"type\": \"ABN\",\n \"number\": \"12345678901\"\n}],\n \"registeredAddress\": {\n \"street\": \"Winfield Avenue\",\n \"city\": \"Sydney\",\n \"postalCode\": \"1197\",\n \"stateOrProvince\": \"NSW\",\n \"country\": \"AU\"\n},\n \"undefinedBeneficiaryInfo\": [{\n \"description\": \"My future children\"\n}]\n},\n \"type\": \"trust\",\n \"id\": \"LE00000000000000000000001\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the legal entity. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"entityAssociations\": [{\n \"legalEntityId\": \"LE00000000000000000000002\",\n \"type\": \"settlor\",\n \"entityType\": \"individual\",\n \"settlorExemptionReason\": [\"deceased\", \"professionalServiceProvider\"]\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Updates a legal entity. >To change the legal entity type, include only the new `type` in your request. To update the `entityAssociations` array, you need to replace the entire array. For example, if the array has 3 entries and you want to remove 1 entry, you need to PATCH the resource with the remaining 2 entries."
}
}
]
}
]
},
{
"name": "/legalEntities/:id/businessLines",
"description": "Returns the business lines owned by a legal entity.",
"item": [
{
"name": "Get all business lines under a legal entity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/businessLines",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"businessLines"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Returns the business lines owned by a legal entity."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id/checkVerificationErrors",
"description": "Returns the verification errors for a legal entity and its supporting entities.",
"item": [
{
"name": "Check a legal entity's verification errors",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/checkVerificationErrors",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"checkVerificationErrors"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Returns the verification errors for a legal entity and its supporting entities."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id/confirmDataReview",
"description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request.",
"item": [
{
"name": "Confirm data review",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/confirmDataReview",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"confirmDataReview"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity."
}
],
"query": [
]
},
"description": "Confirms that your user has reviewed the data for the legal entity specified in the path. Call this endpoint to inform Adyen that your user reviewed and verified that the data is up-to-date. The endpoint returns the timestamp of when Adyen received the request."
}
,"response": [
]
}
]
}
]
},
{
"name": "Hosted Onboarding",
"item": [
{
"name": "/legalEntities/:id/onboardingLinks",
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. ",
"item": [
{
"name": "Create a hosted onboarding link",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"themeId\": \"YOUR_THEME_ID\",\n \"redirectUrl\": \"https://your.redirect-url.com/\",\n \"locale\": \"nl-NL\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"onboardingLinks"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity"
}
],
"query": [
]
},
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"url\": \"https://balanceplatform-test.adyen.com/balanceplatform/uo/form/xtl-...?signature=..&cd=..&redirectUrl=https%3A%2F%2Fyour.redirect-url.com%2F&expiry=1667226404807&locale=nl-NL\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"themeId\": \"YOUR_THEME_ID\",\n \"redirectUrl\": \"https://your.redirect-url.com/\",\n \"locale\": \"nl-NL\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/onboardingLinks",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"onboardingLinks"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity"
}
],
"query": [
]
},
"description": "Returns a link to an Adyen-hosted onboarding page where you need to redirect your user. "
}
}
]
}
]
},
{
"name": "/themes",
"description": "Returns a list of hosted onboarding page themes. ",
"item": [
{
"name": "Get a list of hosted onboarding page themes",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/themes",
"host": [
"{{baseUrl}}"
],
"path": [
"themes"
],
"variable": [
],
"query": [
]
},
"description": "Returns a list of hosted onboarding page themes. "
}
,"response": [
]
}
]
},
{
"name": "/themes/:id",
"description": "Returns the details of the theme identified in the path.",
"item": [
{
"name": "Get an onboarding link theme",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/themes/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"themes",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the theme"
}
],
"query": [
]
},
"description": "Returns the details of the theme identified in the path."
}
,"response": [
]
}
]
}
]
},
{
"name": "Business lines",
"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. ",
"item": [
{
"name": "Create a business line for a business account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service\": \"banking\",\n \"industryCode\": \"4531\",\n \"webData\": [{\n \"webAddress\": \"https://www.adyen.com\"\n}],\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"sourceOfFunds\": {\n \"type\": \"business\",\n \"adyenProcessedFunds\": false,\n \"description\": \"Funds from my flower shop business\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"industryCode\": \"4531\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"service\": \"banking\",\n \"sourceOfFunds\": {\n \"adyenProcessedFunds\": false,\n \"description\": \"Funds from my flower shop business\",\n \"type\": \"business\"\n},\n \"webData\": [{\n \"webAddress\": \"https://www.adyen.com\",\n \"webAddressId\": \"SE322JV223222F5H4CQGS77V4\"\n}],\n \"id\": \"SE322KT223222D5FJ7TJN2986\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service\": \"banking\",\n \"industryCode\": \"4531\",\n \"webData\": [{\n \"webAddress\": \"https://www.adyen.com\"\n}],\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"sourceOfFunds\": {\n \"type\": \"business\",\n \"adyenProcessedFunds\": false,\n \"description\": \"Funds from my flower shop business\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines"
],
"variable": [
],
"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. "
}
}
]
},
{
"name": "Create a business line for receiving payments",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service\": \"paymentProcessing\",\n \"industryCode\": \"339E\",\n \"salesChannels\": [\"eCommerce\", \"ecomMoto\"],\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"webData\": [{\n \"webAddress\": \"https://yoururl.com\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines"
],
"variable": [
],
"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. "
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"service\": \"paymentProcessing\",\n \"industryCode\": \"339E\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"salesChannels\": [\"eCommerce\", \"ecomMoto\"],\n \"webData\": [{\n \"webAddress\": \"https://yoururl.com\",\n \"webAddressId\": \"SE654AC923222F5H4CQGS77V4\"\n}],\n \"id\": \"SE322KT223222D5FJ7TJN2986\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"service\": \"paymentProcessing\",\n \"industryCode\": \"339E\",\n \"salesChannels\": [\"eCommerce\", \"ecomMoto\"],\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"webData\": [{\n \"webAddress\": \"https://yoururl.com\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines"
],
"variable": [
],
"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. "
}
}
]
}
]
},
{
"name": "/businessLines/:id",
"description": "Deletes a business line. >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts.",
"item": [
{
"name": "Delete a business line",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the business line to be deleted."
}
],
"query": [
]
},
"description": "Deletes a business line. >If you delete a business line linked to a [payment method](https://docs.adyen.com/development-resources/paymentmethodvariant#management-api), it can affect your merchant account's ability to use the [payment method](https://docs.adyen.com/api-explorer/Management/latest/post/merchants/_merchantId_/paymentMethodSettings). The business line is removed from all linked merchant accounts."
}
,"response": [
]
}
]
},
{
"name": "/businessLines/:id",
"description": "Returns the detail of a business line.",
"item": [
{
"name": "Get a business line",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the business line."
}
],
"query": [
]
},
"description": "Returns the detail of a business line."
}
,"response": [
]
}
]
},
{
"name": "/businessLines/:id",
"description": "Updates a business line.",
"item": [
{
"name": "Update a business line",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"industryCode\": \"55\",\n \"webData\": [{\n \"webAddress\": \"https://www.example.com\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the business line."
}
],
"query": [
]
},
"description": "Updates a business line."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"service\": \"banking\",\n \"industryCode\": \"55\",\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"sourceOfFunds\": {\n \"adyenProcessedFunds\": false,\n \"description\": \"Funds from my flower shop business\",\n \"type\": \"business\"\n},\n \"webData\": [{\n \"webAddress\": \"https://www.example.com\",\n \"webAddressId\": \"SE966LI345672J5H8V87B3FGH\"\n}],\n \"id\": \"SE322JV223222F5GVGMLNB83F\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"industryCode\": \"55\",\n \"webData\": [{\n \"webAddress\": \"https://www.example.com\"\n}]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/businessLines/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"businessLines",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the business line."
}
],
"query": [
]
},
"description": "Updates a business line."
}
}
]
}
]
}
]
},
{
"name": "Documents",
"item": [
{
"name": "/documents",
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs.",
"item": [
{
"name": "Upload a document",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE00000000000000000000001\",\n \"type\": \"legalEntity\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents",
"host": [
"{{baseUrl}}"
],
"path": [
"documents"
],
"variable": [
],
"query": [
]
},
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"fileName\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE00000000000000000000001\",\n \"type\": \"legalEntity\"\n},\n \"id\": \"SE322JV223222F5GV2N9L8GDK\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"registrationDocument\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n}],\n \"description\": \"Registration doc for Example Company\",\n \"owner\": {\n \"id\": \"LE00000000000000000000001\",\n \"type\": \"legalEntity\"\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents",
"host": [
"{{baseUrl}}"
],
"path": [
"documents"
],
"variable": [
],
"query": [
]
},
"description": "Uploads a document for verification checks. Adyen uses the information from the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities) to run automated verification checks. If these checks fail, you will be notified to provide additional documents. You should only upload documents when Adyen requests additional information for the legal entity. >You can upload a maximum of 15 pages for photo IDs."
}
}
]
}
]
},
{
"name": "/documents/:id",
"description": "Deletes a document.",
"item": [
{
"name": "Delete a document",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document to be deleted."
}
],
"query": [
]
},
"description": "Deletes a document."
}
,"response": [
]
}
]
},
{
"name": "/documents/:id",
"description": "Returns a document.",
"item": [
{
"name": "Get a document",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document."
}
],
"query": [
{
"key": "skipContent",
"value": "true",
"description": "Do not load document content while fetching the document.",
"disabled": true
}
]
},
"description": "Returns a document."
}
,"response": [
]
}
]
},
{
"name": "/documents/:id",
"description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs.",
"item": [
{
"name": "Update a document",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"proofOfIndustry\",\n \"description\": \"Proof of industry doc for Example Company\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document to be updated."
}
],
"query": [
]
},
"description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"type\": \"proofOfIndustry\",\n \"attachments\": [{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\"\n}],\n \"description\": \"Proof of industry for Example Company\",\n \"fileName\": \"Proof of industry for Example Company\",\n \"owner\": {\n \"id\": \"LE00000000000000000000001\",\n \"type\": \"legalEntity\"\n},\n \"id\": \"SE322JV223222F5GV2N9L8GDK\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the document. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"proofOfIndustry\",\n \"description\": \"Proof of industry doc for Example Company\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/documents/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"documents",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the document to be updated."
}
],
"query": [
]
},
"description": "Updates a document. >You can upload a maximum of 15 pages for photo IDs."
}
}
]
}
]
}
]
},
{
"name": "Terms of Service",
"item": [
{
"name": "/legalEntities/:id/termsOfService",
"description": "Returns the Terms of Service document for a legal entity.",
"item": [
{
"name": "Get the Terms of Service document",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"adyenIssuing\",\n \"language\": \"en\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfService",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfService"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
}
],
"query": [
]
},
"description": "Returns the Terms of Service document for a legal entity."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"id\": \"LE00000000000000000000001\",\n \"type\": \"adyenIssuing\",\n \"language\": \"en\",\n \"document\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"termsOfServiceDocumentId\": \"abc123\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"type\": \"adyenIssuing\",\n \"language\": \"en\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfService",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfService"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
}
],
"query": [
]
},
"description": "Returns the Terms of Service document for a legal entity."
}
}
]
}
]
},
{
"name": "/legalEntities/:id/termsOfService/:termsofservicedocumentid",
"description": "Accepts Terms of Service.",
"item": [
{
"name": "Accept the Terms of Service document",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"acceptedBy\": \"LE00000000000000000000002\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfService",
":termsofservicedocumentid"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
},
{
"key": "termsofservicedocumentid",
"value": "",
"description": "The unique identifier of the Terms of Service document."
}
],
"query": [
]
},
"description": "Accepts Terms of Service."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"acceptedBy\": \"LE00000000000000000000002\",\n \"id\": \"TOSA000AB00000000B2AAAB2BA0AA0\",\n \"language\": \"en\",\n \"termsOfServiceDocumentId\": \"abc123\",\n \"type\": \"adyenIssuing\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"acceptedBy\": \"LE00000000000000000000002\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfService/:termsofservicedocumentid",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfService",
":termsofservicedocumentid"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
},
{
"key": "termsofservicedocumentid",
"value": "",
"description": "The unique identifier of the Terms of Service document."
}
],
"query": [
]
},
"description": "Accepts Terms of Service."
}
}
]
}
]
},
{
"name": "/legalEntities/:id/termsOfServiceAcceptanceInfos",
"description": "Returns Terms of Service information for a legal entity.",
"item": [
{
"name": "Get Terms of Service information for a legal entity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceAcceptanceInfos",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfServiceAcceptanceInfos"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
}
],
"query": [
]
},
"description": "Returns Terms of Service information for a legal entity."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id/termsOfServiceStatus",
"description": "Returns the required types of Terms of Service that need to be accepted by a legal entity.",
"item": [
{
"name": "Get Terms of Service status",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/termsOfServiceStatus",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"termsOfServiceStatus"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity. For sole proprietorships, this is the individual legal entity ID of the owner. For organizations, this is the ID of the organization."
}
],
"query": [
]
},
"description": "Returns the required types of Terms of Service that need to be accepted by a legal entity."
}
,"response": [
]
}
]
}
]
},
{
"name": "Transfer instruments",
"item": [
{
"name": "/transferInstruments",
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts).",
"item": [
{
"name": "Add a EUR bank account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL62ABNA0000000123\"\n},\n \"countryCode\": \"NL\",\n \"trustedSource\": false\n},\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"capabilities\": {\n \"sendToTransferInstrument\": {\n \"allowed\": false,\n \"requested\": true,\n \"verificationStatus\": \"pending\"\n}\n},\n \"id\": \"SE322KH223222F5GXZFNM3BGP\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL62ABNA0000000123\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
}
]
},
{
"name": "Add a USD bank account",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"0000000123\",\n \"routingNumber\": \"121202211\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"0000000123\",\n \"accountType\": \"checking\",\n \"routingNumber\": \"121202211\"\n},\n \"countryCode\": \"US\",\n \"trustedSource\": false\n},\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"capabilities\": {\n \"sendToTransferInstrument\": {\n \"allowed\": false,\n \"requested\": true,\n \"verificationStatus\": \"pending\"\n}\n},\n \"id\": \"SE322JV223222F5GJVKHH8DTC\"\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use a suberror code as your requested verification code. You can include one code at a time in your request header. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"usLocal\",\n \"accountNumber\": \"0000000123\",\n \"routingNumber\": \"121202211\"\n}\n}\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments"
],
"variable": [
],
"query": [
]
},
"description": "Creates a transfer instrument. A transfer instrument is a bank account that a legal entity owns. Adyen performs verification checks on the transfer instrument as required by payment industry regulations. We inform you of the verification results through webhooks or API responses. When the transfer instrument passes the verification checks, you can start sending funds from the balance platform to the transfer instrument (such as payouts)."
}
}
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Deletes a transfer instrument.",
"item": [
{
"name": "Delete a transfer instrument",
"request": {
"method": "DELETE",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument to be deleted."
}
],
"query": [
]
},
"description": "Deletes a transfer instrument."
}
,"response": [
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Returns the details of a transfer instrument.",
"item": [
{
"name": "Get a transfer instrument",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument."
}
],
"query": [
]
},
"description": "Returns the details of a transfer instrument."
}
,"response": [
]
}
]
},
{
"name": "/transferInstruments/:id",
"description": "Updates a transfer instrument.",
"item": [
{
"name": "Update a transfer instrument",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL02ABNA0123456789\"\n}\n},\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument."
}
],
"query": [
]
},
"description": "Updates a transfer instrument."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL02ABNA0123456789\"\n},\n \"countryCode\": \"NL\"\n},\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\",\n \"id\": \"SE322KH223222F5GXZFNM3BGP\"\n}",
"originalRequest": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "x-requested-verification-code",
"value": "",
"description": "Use the requested verification code 0_0001 to resolve any suberrors associated with the transfer instrument. Requested verification codes can only be used in your test environment.",
"disabled": true
}
],
"body": {
"mode": "raw",
"raw": "{\n \"bankAccount\": {\n \"accountIdentification\": {\n \"type\": \"iban\",\n \"iban\": \"NL02ABNA0123456789\"\n}\n},\n \"legalEntityId\": \"LE00000000000000000000001\",\n \"type\": \"bankAccount\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/transferInstruments/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"transferInstruments",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the transfer instrument."
}
],
"query": [
]
},
"description": "Updates a transfer instrument."
}
}
]
}
]
}
]
},
{
"name": "PCI questionnaires",
"item": [
{
"name": "/legalEntities/:id/pciQuestionnaires",
"description": "Get a list of signed PCI questionnaires.",
"item": [
{
"name": "Get PCI questionnaire details",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity to get PCI questionnaire information."
}
],
"query": [
]
},
"description": "Get a list of signed PCI questionnaires."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id/pciQuestionnaires/:pciid",
"description": "Returns the signed PCI questionnaire.",
"item": [
{
"name": "Get PCI questionnaire",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/:pciid",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires",
":pciid"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The legal entity ID of the individual who signed the PCI questionnaire."
},
{
"key": "pciid",
"value": "",
"description": "The unique identifier of the signed PCI questionnaire."
}
],
"query": [
]
},
"description": "Returns the signed PCI questionnaire."
}
,"response": [
]
}
]
},
{
"name": "/legalEntities/:id/pciQuestionnaires/generatePciTemplates",
"description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels).",
"item": [
{
"name": "Generate PCI questionnaires",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"language\": \"fr\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires",
"generatePciTemplates"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity to get PCI questionnaire information."
}
],
"query": [
]
},
"description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"content\": \"JVBERi0xLjQKJcOkw7zDtsOfCjIgMCBv+f/ub0j6JPRX+E3EmC==\",\n \"language\": \"fr\",\n \"pciTemplateReferences\": [\"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\"]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"language\": \"fr\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/generatePciTemplates",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires",
"generatePciTemplates"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The unique identifier of the legal entity to get PCI questionnaire information."
}
],
"query": [
]
},
"description": "Generates the required PCI questionnaires based on the user's [salesChannel](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines__reqParam_salesChannels)."
}
}
]
}
]
},
{
"name": "/legalEntities/:id/pciQuestionnaires/signPciTemplates",
"description": "Signs the required PCI questionnaire.",
"item": [
{
"name": "Sign PCI questionnaires",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"signedBy\": \"LE00000000000000000000002\",\n \"pciTemplateReferences\": [\"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires",
"signPciTemplates"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The legal entity ID of the user that has a contractual relationship with your platform."
}
],
"query": [
]
},
"description": "Signs the required PCI questionnaire."
}
,"response": [
{"name": "OK - the request has succeeded.",
"code": 200,
"status": "OK",
"header": [{
"key": "Content-Type",
"value": "application/json"}
],
"_postman_previewlanguage": "json",
"cookie": [],
"body" : "{\n \"pciQuestionnaireIds\": [\"PCID422GZ22322565HHMH48CW63CPH\", \"PCID422GZ22322565HHMH49CW75Z9H\"]\n}",
"originalRequest": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": "",
"disabled": false
},
{
"key": "Accept",
"value": "application/json",
"description": "",
"disabled": false
}
],
"body": {
"mode": "raw",
"raw": "{\n \"signedBy\": \"LE00000000000000000000002\",\n \"pciTemplateReferences\": [\"PCIT-T7KC6VGL\", \"PCIT-PKB6DKS4\"]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/legalEntities/:id/pciQuestionnaires/signPciTemplates",
"host": [
"{{baseUrl}}"
],
"path": [
"legalEntities",
":id",
"pciQuestionnaires",
"signPciTemplates"
],
"variable": [
{
"key": "id",
"value": "",
"description": "The legal entity ID of the user that has a contractual relationship with your platform."
}
],
"query": [
]
},
"description": "Signs the required PCI questionnaire."
}
}
]
}
]
}
]
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "value",
"value": "{{X-API-Key}}",
"type": "string"
},
{
"key": "key",
"value": "X-API-Key",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://kyc-test.adyen.com/lem/v3",
"type": "string"
},
{
"key": "X-API-Key",
"value": "",
"type": "string"
}
]
}
Reference in New Issue View Git Blame Copy Permalink