From 0db5ba83dfa6c98c9c27ed35404524c077087bda Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 2 Oct 2024 23:04:50 +0200 Subject: [PATCH] spec release --- json/LegalEntityService-v1.json | 217 ++++++++++++++++++++++++++++++++ json/LegalEntityService-v2.json | 217 ++++++++++++++++++++++++++++++++ json/LegalEntityService-v3.json | 217 ++++++++++++++++++++++++++++++++ yaml/LegalEntityService-v1.yaml | 135 ++++++++++++++++++++ yaml/LegalEntityService-v2.yaml | 135 ++++++++++++++++++++ yaml/LegalEntityService-v3.yaml | 135 ++++++++++++++++++++ 6 files changed, 1056 insertions(+) diff --git a/json/LegalEntityService-v1.json b/json/LegalEntityService-v1.json index 98beb2e..d42b6ba 100644 --- a/json/LegalEntityService-v1.json +++ b/json/LegalEntityService-v1.json @@ -32,6 +32,9 @@ { "name" : "Terms of Service" }, + { + "name" : "Tax eDelivery consent" + }, { "name" : "Hosted Onboarding" }, @@ -1235,6 +1238,102 @@ } } }, + "/legalEntities/{id}/checkTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Check the status of consent for electronic delivery of tax forms", + "description" : "Returns the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-checkTaxElectronicDeliveryConsent", + "x-sortIndex" : 2, + "x-methodName" : "checkStatusOfConsentForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CheckTaxElectronicDeliveryConsentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/onboardingLinks" : { "post" : { "tags" : [ @@ -1791,6 +1890,104 @@ } } }, + "/legalEntities/{id}/setTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Set the consent status for electronic delivery of tax forms", + "description" : "Set the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-setTaxElectronicDeliveryConsent", + "x-sortIndex" : 1, + "x-methodName" : "setConsentStatusForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SetTaxElectronicDeliveryConsentRequest" + } + } + } + }, + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "description" : "No Content - look at the actual response code for the status of the request. " + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/termsOfService" : { "post" : { "tags" : [ @@ -3319,6 +3516,16 @@ }, "type" : "object" }, + "CheckTaxElectronicDeliveryConsentResponse" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "Document" : { "additionalProperties" : false, "properties" : { @@ -4384,6 +4591,16 @@ }, "type" : "object" }, + "SetTaxElectronicDeliveryConsentRequest" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "SourceOfFunds" : { "additionalProperties" : false, "properties" : { diff --git a/json/LegalEntityService-v2.json b/json/LegalEntityService-v2.json index 04a952c..e7d522c 100644 --- a/json/LegalEntityService-v2.json +++ b/json/LegalEntityService-v2.json @@ -32,6 +32,9 @@ { "name" : "Terms of Service" }, + { + "name" : "Tax eDelivery consent" + }, { "name" : "Hosted Onboarding" }, @@ -1384,6 +1387,102 @@ } } }, + "/legalEntities/{id}/checkTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Check the status of consent for electronic delivery of tax forms", + "description" : "Returns the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-checkTaxElectronicDeliveryConsent", + "x-sortIndex" : 2, + "x-methodName" : "checkStatusOfConsentForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CheckTaxElectronicDeliveryConsentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/onboardingLinks" : { "post" : { "tags" : [ @@ -1940,6 +2039,104 @@ } } }, + "/legalEntities/{id}/setTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Set the consent status for electronic delivery of tax forms", + "description" : "Set the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-setTaxElectronicDeliveryConsent", + "x-sortIndex" : 1, + "x-methodName" : "setConsentStatusForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SetTaxElectronicDeliveryConsentRequest" + } + } + } + }, + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "description" : "No Content - look at the actual response code for the status of the request. " + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/termsOfService" : { "post" : { "tags" : [ @@ -3507,6 +3704,16 @@ }, "type" : "object" }, + "CheckTaxElectronicDeliveryConsentResponse" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "Document" : { "additionalProperties" : false, "properties" : { @@ -4710,6 +4917,16 @@ }, "type" : "object" }, + "SetTaxElectronicDeliveryConsentRequest" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "SoleProprietorship" : { "additionalProperties" : false, "properties" : { diff --git a/json/LegalEntityService-v3.json b/json/LegalEntityService-v3.json index 4bf128c..f629366 100644 --- a/json/LegalEntityService-v3.json +++ b/json/LegalEntityService-v3.json @@ -32,6 +32,9 @@ { "name" : "Terms of Service" }, + { + "name" : "Tax eDelivery consent" + }, { "name" : "Hosted Onboarding" }, @@ -1396,6 +1399,102 @@ } } }, + "/legalEntities/{id}/checkTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Check the status of consent for electronic delivery of tax forms", + "description" : "Returns the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-checkTaxElectronicDeliveryConsent", + "x-sortIndex" : 2, + "x-methodName" : "checkStatusOfConsentForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CheckTaxElectronicDeliveryConsentResponse" + } + } + }, + "description" : "OK - the request has succeeded." + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/checkVerificationErrors" : { "post" : { "tags" : [ @@ -2154,6 +2253,104 @@ } } }, + "/legalEntities/{id}/setTaxElectronicDeliveryConsent" : { + "post" : { + "tags" : [ + "Tax eDelivery consent" + ], + "summary" : "Set the consent status for electronic delivery of tax forms", + "description" : "Set the consent status for electronic delivery of tax forms.", + "x-addedInVersion" : "1", + "operationId" : "post-legalEntities-id-setTaxElectronicDeliveryConsent", + "x-sortIndex" : 1, + "x-methodName" : "setConsentStatusForElectronicDeliveryOfTaxForms", + "security" : [ + { + "BasicAuth" : [ + ] + }, + { + "ApiKeyAuth" : [ + ] + } + ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SetTaxElectronicDeliveryConsentRequest" + } + } + } + }, + "parameters" : [ + { + "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.", + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } + ], + "responses" : { + "200" : { + "description" : "No Content - look at the actual response code for the status of the request. " + }, + "400" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Bad Request - a problem reading or understanding the request." + }, + "401" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unauthorized - authentication required." + }, + "403" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Forbidden - insufficient permissions to process the request." + }, + "422" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Unprocessable Entity - a request validation error." + }, + "500" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ServiceError" + } + } + }, + "description" : "Internal Server Error - the server could not process the request." + } + } + } + }, "/legalEntities/{id}/termsOfService" : { "post" : { "tags" : [ @@ -3896,6 +4093,16 @@ }, "type" : "object" }, + "CheckTaxElectronicDeliveryConsentResponse" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "DKLocalAccountIdentification" : { "additionalProperties" : false, "properties" : { @@ -5396,6 +5603,16 @@ }, "type" : "object" }, + "SetTaxElectronicDeliveryConsentRequest" : { + "additionalProperties" : false, + "properties" : { + "US1099k" : { + "description" : "Consent to electronically deliver tax form US1099-K.", + "type" : "boolean" + } + }, + "type" : "object" + }, "SoleProprietorship" : { "additionalProperties" : false, "properties" : { diff --git a/yaml/LegalEntityService-v1.yaml b/yaml/LegalEntityService-v1.yaml index a2f7416..ef86571 100644 --- a/yaml/LegalEntityService-v1.yaml +++ b/yaml/LegalEntityService-v1.yaml @@ -32,6 +32,7 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: Tax eDelivery consent - name: Hosted Onboarding - name: PCI questionnaires paths: @@ -779,6 +780,65 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/checkTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Check the status of consent for electronic delivery of tax forms + description: Returns the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-checkTaxElectronicDeliveryConsent + x-sortIndex: 2 + x-methodName: checkStatusOfConsentForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CheckTaxElectronicDeliveryConsentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/onboardingLinks: post: tags: @@ -1116,6 +1176,67 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/setTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Set the consent status for electronic delivery of tax forms + description: Set the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-setTaxElectronicDeliveryConsent + x-sortIndex: 1 + x-methodName: setConsentStatusForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetTaxElectronicDeliveryConsentRequest' + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + description: 'No Content - look at the actual response code for the status + of the request. ' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/termsOfService: post: tags: @@ -2235,6 +2356,13 @@ components: description: The maximum amount a card holder can withdraw per day. $ref: '#/components/schemas/Amount' type: object + CheckTaxElectronicDeliveryConsentResponse: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object Document: additionalProperties: false properties: @@ -3341,6 +3469,13 @@ components: format: int32 type: integer type: object + SetTaxElectronicDeliveryConsentRequest: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object SourceOfFunds: additionalProperties: false properties: diff --git a/yaml/LegalEntityService-v2.yaml b/yaml/LegalEntityService-v2.yaml index 39088ef..84f3326 100644 --- a/yaml/LegalEntityService-v2.yaml +++ b/yaml/LegalEntityService-v2.yaml @@ -32,6 +32,7 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: Tax eDelivery consent - name: Hosted Onboarding - name: PCI questionnaires paths: @@ -870,6 +871,65 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/checkTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Check the status of consent for electronic delivery of tax forms + description: Returns the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-checkTaxElectronicDeliveryConsent + x-sortIndex: 2 + x-methodName: checkStatusOfConsentForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CheckTaxElectronicDeliveryConsentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/onboardingLinks: post: tags: @@ -1207,6 +1267,67 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/setTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Set the consent status for electronic delivery of tax forms + description: Set the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-setTaxElectronicDeliveryConsent + x-sortIndex: 1 + x-methodName: setConsentStatusForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetTaxElectronicDeliveryConsentRequest' + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + description: 'No Content - look at the actual response code for the status + of the request. ' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/termsOfService: post: tags: @@ -2366,6 +2487,13 @@ components: description: The maximum amount a card holder can withdraw per day. $ref: '#/components/schemas/Amount' type: object + CheckTaxElectronicDeliveryConsentResponse: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object Document: additionalProperties: false properties: @@ -3605,6 +3733,13 @@ components: format: int32 type: integer type: object + SetTaxElectronicDeliveryConsentRequest: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object SoleProprietorship: additionalProperties: false properties: diff --git a/yaml/LegalEntityService-v3.yaml b/yaml/LegalEntityService-v3.yaml index fd1406c..2519f77 100644 --- a/yaml/LegalEntityService-v3.yaml +++ b/yaml/LegalEntityService-v3.yaml @@ -32,6 +32,7 @@ tags: - name: Business lines - name: Documents - name: Terms of Service +- name: Tax eDelivery consent - name: Hosted Onboarding - name: PCI questionnaires paths: @@ -878,6 +879,65 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/checkTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Check the status of consent for electronic delivery of tax forms + description: Returns the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-checkTaxElectronicDeliveryConsent + x-sortIndex: 2 + x-methodName: checkStatusOfConsentForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CheckTaxElectronicDeliveryConsentResponse' + description: OK - the request has succeeded. + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/checkVerificationErrors: post: tags: @@ -1339,6 +1399,67 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. + /legalEntities/{id}/setTaxElectronicDeliveryConsent: + post: + tags: + - Tax eDelivery consent + summary: Set the consent status for electronic delivery of tax forms + description: Set the consent status for electronic delivery of tax forms. + x-addedInVersion: '1' + operationId: post-legalEntities-id-setTaxElectronicDeliveryConsent + x-sortIndex: 1 + x-methodName: setConsentStatusForElectronicDeliveryOfTaxForms + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SetTaxElectronicDeliveryConsentRequest' + parameters: + - 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. + name: id + in: path + required: true + schema: + type: string + responses: + '200': + description: 'No Content - look at the actual response code for the status + of the request. ' + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Bad Request - a problem reading or understanding the request. + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unauthorized - authentication required. + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Forbidden - insufficient permissions to process the request. + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Unprocessable Entity - a request validation error. + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceError' + description: Internal Server Error - the server could not process the request. /legalEntities/{id}/termsOfService: post: tags: @@ -2646,6 +2767,13 @@ components: description: The maximum amount a card holder can withdraw per day. $ref: '#/components/schemas/Amount' type: object + CheckTaxElectronicDeliveryConsentResponse: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object DKLocalAccountIdentification: additionalProperties: false properties: @@ -4125,6 +4253,13 @@ components: format: int32 type: integer type: object + SetTaxElectronicDeliveryConsentRequest: + additionalProperties: false + properties: + US1099k: + description: Consent to electronically deliver tax form US1099-K. + type: boolean + type: object SoleProprietorship: additionalProperties: false properties: