Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Adyen

Adyen legalEntities API

The legalEntities API from Adyen — 14 operation(s) for legalentities.

Documentation Provider Profile APIs.io OpenAPI GitHub

Adyen legalEntities API is one of 202 APIs that Adyen publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include legalEntities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 15 operations across 14 paths, and defines 57 schemas. It is described by OpenAPI 3.1.0, at version 6.

Requests are made against a single base URL, https://cal-test.adyen.com/cal/services/Account/v6.

15 operations 14 paths 57 schemas 6 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
6
Base URL
https://cal-test.adyen.com
Authentication
API Key, HTTP Basic
Contact
Adyen Developer Experience team
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Adyen legalEntities API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). It accepts HTTP basic authentication (BasicAuth).

Paths & Operations 15

Across 14 paths, the API surfaces 15 operations — 6 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

legalEntities 15
POST
/legalEntities
Adyen Create a Legal Entity
post-legalEntities 1 param body → 200400401403422500
GET
/legalEntities/{id}
Adyen Get a Legal Entity
get-legalEntities-id 1 param → 200400401403422500
PATCH
/legalEntities/{id}
Adyen Update a Legal Entity
patch-legalEntities-id 2 params body → 200400401403422500
GET
/legalEntities/{id}/businessLines
Adyen Get All Business Lines Under a Legal Entity
get-legalEntities-id-businessLines 1 param → 200400401403422500
POST
/legalEntities/{id}/checkVerificationErrors
Adyen Check a Legal Entity's Verification Errors
post-legalEntities-id-checkVerificationErrors 1 param → 200400401403422500
POST
/legalEntities/{id}/confirmDataReview
Adyen Confirm Data Review
post-legalEntities-id-confirmDataReview 1 param → 200400401403422500
POST
/legalEntities/{id}/onboardingLinks
Adyen Get a Link to an Adyen-hosted Onboarding Page
post-legalEntities-id-onboardingLinks 1 param body → 200400401403422500
GET
/legalEntities/{id}/pciQuestionnaires
Adyen Get PCI Questionnaire Details
get-legalEntities-id-pciQuestionnaires 1 param → 200400401403422500
POST
/legalEntities/{id}/pciQuestionnaires/generatePciTemplates
Adyen Generate PCI Questionnaire
post-legalEntities-id-pciQuestionnaires-generatePciTemplates 1 param body → 200400401403422500
POST
/legalEntities/{id}/pciQuestionnaires/signPciTemplates
Adyen Sign PCI Questionnaire
post-legalEntities-id-pciQuestionnaires-signPciTemplates 1 param body → 200400401403422500
GET
/legalEntities/{id}/pciQuestionnaires/{pciid}
Adyen Get PCI Questionnaire
get-legalEntities-id-pciQuestionnaires-pciid 2 params → 200400401403422500
POST
/legalEntities/{id}/termsOfService
Adyen Get Terms of Service Document
post-legalEntities-id-termsOfService 1 param body → 200400401403422500
PATCH
/legalEntities/{id}/termsOfService/{termsofservicedocumentid}
Adyen Accept Terms of Service
patch-legalEntities-id-termsOfService-termsofservicedocumentid 2 params body → 200400401403422500
GET
/legalEntities/{id}/termsOfServiceAcceptanceInfos
Adyen Get Terms of Service Information for a Legal Entity
get-legalEntities-id-termsOfServiceAcceptanceInfos 1 param → 200400401403422500
GET
/legalEntities/{id}/termsOfServiceStatus
Adyen Get Terms of Service Status
get-legalEntities-id-termsOfServiceStatus 1 param → 200400401403422500

Schemas 57

The contract defines 57 schemas that model the data the API accepts and returns. The most detailed are LegalEntity (16 properties), Organization (16 properties), Trust (13 properties), UnincorporatedPartnership (12 properties). Each schema is shown below with its type and property counts.

StockData
object
3 properties
PciDocumentInfo
object
3 properties
BusinessLines
object
1 property 1 required
DataReviewConfirmationResponse
object
1 property
LegalEntityInfo
object
10 properties
GetTermsOfServiceDocumentRequest
object
2 properties 2 required
GeneratePciDescriptionRequest
object
2 properties
BirthData
object
1 property
GetTermsOfServiceAcceptanceInfosResponse
object
1 property
PciSigningRequest
object
2 properties 2 required
Address
object
6 properties 1 required
TransferInstrumentReference
object
4 properties 2 required
Trust
object
13 properties 4 required
LegalEntityAssociation
object
7 properties 2 required
OnboardingLink
object
1 property
SourceOfFunds
object
4 properties
Organization
object
16 properties 2 required
VerificationError
object
6 properties
CapabilitySettings
object
5 properties
TaxInformation
object
3 properties
GetTermsOfServiceDocumentResponse
object
5 properties
EntityReference
object
1 property
Individual
object
9 properties 2 required
DocumentReference
object
7 properties
SupportingEntityCapability
object
4 properties
DocumentPage
object
3 properties
CalculateTermsOfServiceStatusResponse
object
1 property
WebDataExemption
object
1 property
UndefinedBeneficiary
object
2 properties
PhoneNumber
object
2 properties 1 required
VerificationError-recursive
object
5 properties
RemediatingAction
object
2 properties
CapabilityProblemEntity
object
4 properties
SoleProprietorship
object
11 properties 3 required
UnincorporatedPartnership
object
12 properties 4 required
LegalEntity
object
16 properties 1 required
VerificationDeadline
object
3 properties 2 required
CapabilityProblemEntity-recursive
object
3 properties
LegalEntityCapability
object
8 properties
AcceptTermsOfServiceRequest
object
2 properties 1 required
WebData
object
2 properties
ServiceError
object
5 properties
Name
object
3 properties 2 required
IdentificationData
object
7 properties 1 required
LegalEntityInfoRequiredType
object
10 properties 1 required
Amount
object
2 properties
CapabilityProblem
object
2 properties
VerificationErrors
object
1 property
BusinessLine
object
10 properties 4 required
AcceptTermsOfServiceResponse
object
6 properties
PciSigningResponse
object
2 properties
GetPciQuestionnaireInfosResponse
object
1 property
OnboardingLinkInfo
object
4 properties
TermsOfServiceAcceptanceInfo
object
5 properties
GetPciQuestionnaireResponse
object
4 properties
GeneratePciDescriptionResponse
object
3 properties
TaxReportingClassification
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-legalentities-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
AE Profile APIs.io
Adyen Account API
AE Profile APIs.io
Adyen accountHolderBalance API
AE Profile APIs.io
Adyen accountHolders API
AE Profile APIs.io
Adyen accountHolderTransactionList API
AE Profile APIs.io
Adyen Accounting Notifications API
AE Profile APIs.io
Adyen Accounts API
AE Profile APIs.io
Adyen adjustAuthorisation API
AE Profile APIs.io
Adyen Admin API
AE Profile APIs.io
Adyen Amount API
AE Profile APIs.io
Adyen Apple API
AE Profile APIs.io
Adyen applePay API
AE Profile APIs.io
#legalEntities
← Back to A APIs
API Details
ID
adyen:adyen-legalentities-api
Base URL
https://cal-test.adyen.com
Docs
https://docs.adyen.com/marketplaces-and-platforms/classic/configure-notifications/
Provider
Adyen
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network