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

Adyen Documents API

The Documents API from Adyen — 4 operation(s) for documents.

Adyen Documents 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 Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 6 operations across 4 paths, and defines 43 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.

6 operations 4 paths 43 schemas 1 DELETE1 GET1 PATCH3 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
Terms of Service
Resource Areas
1

Authentication & Security 2

Adyen Documents 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 6

Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Documents 6
POST
/getUploadedDocuments
Adyen Get Documents
post-getUploadedDocuments body → 200400401403422500
POST
/uploadDocument
Adyen Upload a Document
post-uploadDocument body → 200202400401403422500
POST
/documents
Adyen Upload a Document for Verification Checks
post-documents 1 param body → 200400401403422500
DELETE
/documents/{id}
Adyen Delete a Document
delete-documents-id 1 param → 204400401403422500
GET
/documents/{id}
Adyen Get a Document
get-documents-id 1 param → 200400401403422500
PATCH
/documents/{id}
Adyen Update a Document
patch-documents-id 2 params body → 200400401403422500

Schemas 43

The contract defines 43 schemas that model the data the API accepts and returns. The most detailed are BankAccountDetail (26 properties), StoreDetail (15 properties), AccountHolderDetails (15 properties), Document (13 properties). Each schema is shown below with its type and property counts.

LegalArrangementEntityDetail
object
11 properties
GetUploadedDocumentsResponse
object
4 properties
StoreDetail
object
15 properties 3 required
AccountPayoutState
object
6 properties
KYCLegalArrangementCheckResult
object
2 properties
PersonalDocumentData
object
5 properties 1 required
KYCUltimateParentCompanyCheckResult
object
2 properties
ShareholderContact
object
11 properties
Document
object
13 properties 2 required
KYCVerificationResult
object
7 properties
ViasPhoneNumber
object
3 properties
ErrorFieldType
object
3 properties
OwnerEntity
object
2 properties 2 required
UltimateParentCompany
object
3 properties
Attachment
object
5 properties 1 required
PayoutMethod
object
5 properties 3 required
BankAccountDetail
object
26 properties
IndividualDetails
object
2 properties
UploadDocumentRequest
object
2 properties 2 required
DocumentDetail
object
9 properties 1 required
SignatoryContact
object
10 properties
UltimateParentCompanyBusinessDetails
object
5 properties
KYCSignatoryCheckResult
object
2 properties
KYCCheckStatusData
object
4 properties 2 required
KYCCheckResult
object
1 property
LegalArrangementDetail
object
9 properties 3 required
ServiceError
object
5 properties
ViasName
object
4 properties
KYCLegalArrangementEntityCheckResult
object
3 properties
AccountHolderDetails
object
15 properties 1 required
FieldType
object
3 properties
AccountEvent
object
3 properties
GetUploadedDocumentsRequest
object
3 properties 1 required
KYCCheckSummary
object
2 properties
UpdateAccountHolderResponse
object
11 properties
BusinessDetails
object
10 properties
AccountProcessingState
object
5 properties
ViasAddress
object
6 properties 1 required
AccountHolderStatus
object
5 properties 1 required
Amount
object
2 properties 2 required
KYCPayoutMethodCheckResult
object
2 properties
ViasPersonalData
object
3 properties
KYCShareholderCheckResult
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

adyen-documents-api-openapi.yml Raw ↑

Other APIs Adyen publishes across the network.

Adyen acceptDispute API
Adyen Account API
Adyen accountHolderBalance API
Adyen accountHolders API
Adyen accountHolderTransactionList API
Adyen Accounting Notifications API
Adyen Accounts API
Adyen adjustAuthorisation API
Adyen Admin API
Adyen Amount API
Adyen Apple API
Adyen applePay API