GetUploadedDocumentsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/main/json-schema/adyen-get-uploaded-documents-response-schema.json",
  "title": "GetUploadedDocumentsResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/adyen-getuploadeddocuments-api-openapi.yml#/components/schemas/GetUploadedDocumentsResponse",
  "properties": {
    "documentDetails": {
      "description": "A list of the documents and their details.",
      "items": {
        "$ref": "#/$defs/DocumentDetail"
      },
      "type": "array"
    },
    "invalidFields": {
      "x-addedInVersion": "5",
      "description": "Contains field validation errors that would prevent requests from being processed.",
      "items": {
        "$ref": "#/$defs/ErrorFieldType"
      },
      "type": "array"
    },
    "pspReference": {
      "description": "The reference of a request. Can be used to uniquely identify the request.",
      "type": "string"
    },
    "resultCode": {
      "description": "The result code.",
      "type": "string"
    }
  },
  "type": "object",
  "$defs": {
    "DocumentDetail": {
      "properties": {
        "accountHolderCode": {
          "x-addedInVersion": "2",
          "description": "The code of account holder, to which the document applies.",
          "type": "string"
        },
        "bankAccountUUID": {
          "x-addedInVersion": "2",
          "description": "The Adyen-generated [`bankAccountUUID`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-bankAccountDetails-bankAccountUUID) to which the document must be linked. Refer to [Bank account check](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks/bank-account-check#uploading-a-bank-statement) for details on when a document should be submitted.\n>Required if the `documentType` is **BANK_STATEMENT**, where a document is being submitted in order to verify a bank account.\n",
          "type": "string"
        },
        "description": {
          "description": "Description of the document.",
          "type": "string"
        },
        "documentType": {
          "description": "The type of the document. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when each document type should be submitted and for the accepted file formats.\n\nPermitted values:\n* **BANK_STATEMENT**: A file containing a bank statement or other document proving ownership of a specific bank account.\n* **COMPANY_REGISTRATION_SCREENING** (Supported from v5 and later): A file containing a company registration document.\n* **CONSTITUTIONAL_DOCUMENT**: A file containing information about the account holder's legal arrangement.\n* **PASSPORT**: A file containing the identity page(s) of a passport.\n* **ID_CARD_FRONT**: A file containing only the front of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **ID_CARD_BACK**: A file containing only the back of the ID card. In order for a document to be usable, both the **ID_CARD_FRONT** and **ID_CARD_BACK** must be submitted.\n* **DRIVING_LICENCE_FRONT**: A file containing only the front of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_BACK** must be submitted.\n* **DRIVING_LICENCE_BACK**: A file containing only the back of the driving licence. In order for a document to be usable, both the **DRIVING_LICENCE_FRONT** and **DRIVING_LICENCE_FRONT** must be submitted.\n",
          "enum": [
            "BANK_STATEMENT",
            "BSN",
            "COMPANY_REGISTRATION_SCREENING",
            "CONSTITUTIONAL_DOCUMENT",
            "DRIVING_LICENCE",
            "DRIVING_LICENCE_BACK",
            "DRIVING_LICENCE_FRONT",
            "ID_CARD",
            "ID_CARD_BACK",
            "ID_CARD_FRONT",
            "PASSPORT",
            "PROOF_OF_RESIDENCY",
            "SSN",
            "SUPPORTING_DOCUMENTS"
          ],
          "type": "string"
        },
        "filename": {
          "description": "Filename of the document.",
          "type": "string"
        },
        "legalArrangementCode": {
          "x-addedInVersion": "6",
          "description": "The Adyen-generated [`legalArrangementCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementCode) to which the document must be linked.",
          "type": "string"
        },
        "legalArrangementEntityCode": {
          "x-addedInVersion": "6",
          "description": "The Adyen-generated [`legalArrangementEntityCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-legalArrangements-legalArrangementEntities-legalArrangementEntityCode)  to which the document must be linked.",
          "type": "string"
        },
        "shareholderCode": {
          "x-addedInVersion": "2",
          "description": "The Adyen-generated [`shareholderCode`](https://docs.adyen.com/api-explorer/#/Account/latest/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-shareholders-shareholderCode) to which the document must be linked. Refer to [Verification checks](https://docs.adyen.com/marketplaces-and-platforms/classic/verification-checks) for details on when a document should be submitted.\n>Required if the account holder has a `legalEntity` of type **Business** and the `documentType` is either **PASSPORT**, **ID_CARD_FRONT**, **ID_CARD_BACK**, **DRIVING_LICENCE_FRONT**, or **DRIVING_LICENCE_BACK**. ",
          "type": "string"
        },
        "signatoryCode": {
          "description": "The Adyen-generated [`signatoryCode`](https://docs.adyen.com/api-explorer/#/Account/v6/post/createAccountHolder__resParam_accountHolderDetails-businessDetails-signatories-signatoryCode) to which the document must be linked.",
          "type": "string"
        }
      },
      "required": [
        "documentType"
      ],
      "type": "object"
    },
    "ErrorFieldType": {
      "properties": {
        "errorCode": {
          "description": "The validation error code.",
          "format": "int32",
          "type": "integer"
        },
        "errorDescription": {
          "description": "A description of the validation error.",
          "type": "string"
        },
        "fieldType": {
          "description": "The type of error field.",
          "$ref": "#/$defs/FieldType"
        }
      },
      "type": "object"
    },
    "FieldType": {
      "properties": {
        "field": {
          "description": "The full name of the property.",
          "type": "string"
        },
        "fieldName": {
          "description": "The type of the field.",
          "enum": [
            "accountCode",
            "accountHolderCode",
            "accountHolderDetails",
            "accountNumber",
            "accountStateType",
            "accountStatus",
            "accountType",
            "address",
            "balanceAccount",
            "balanceAccountActive",
            "balanceAccountCode",
            "balanceAccountId",
            "bankAccount",
            "bankAccountCode",
            "bankAccountName",
            "bankAccountUUID",
            "bankBicSwift",
            "bankCity",
            "bankCode",
            "bankName",
            "bankStatement",
            "branchCode",
            "businessContact",
            "cardToken",
            "checkCode",
            "city",
            "companyRegistration",
            "constitutionalDocument",
            "controller",
            "country",
            "countryCode",
            "currency",
            "currencyCode",
            "dateOfBirth",
            "description",
            "destinationAccountCode",
            "document",
            "documentContent",
            "documentExpirationDate",
            "documentIssuerCountry",
            "documentIssuerState",
            "documentName",
            "documentNumber",
            "documentType",
            "doingBusinessAs",
            "drivingLicence",
            "drivingLicenceBack",
            "drivingLicenceFront",
            "drivingLicense",
            "email",
            "firstName",
            "formType",
            "fullPhoneNumber",
            "gender",
            "hopWebserviceUser",
            "houseNumberOrName",
            "iban",
            "idCard",
            "idCardBack",
            "idCardFront",
            "idNumber",
            "identityDocument",
            "individualDetails",
            "infix",
            "jobTitle",
            "lastName",
            "lastReviewDate",
            "legalArrangement",
            "legalArrangementCode",
            "legalArrangementEntity",
            "legalArrangementEntityCode",
            "legalArrangementLegalForm",
            "legalArrangementMember",
            "legalArrangementMembers",
            "legalArrangementName",
            "legalArrangementReference",
            "legalArrangementRegistrationNumber",
            "legalArrangementTaxNumber",
            "legalArrangementType",
            "legalBusinessName",
            "legalEntity",
            "legalEntityType",
            "logo",
            "merchantAccount",
            "merchantCategoryCode",
            "merchantHouseNumber",
            "merchantReference",
            "microDeposit",
            "name",
            "nationality",
            "originalReference",
            "ownerCity",
            "ownerCountryCode",
            "ownerDateOfBirth",
            "ownerHouseNumberOrName",
            "ownerName",
            "ownerPostalCode",
            "ownerState",
            "ownerStreet",
            "passport",
            "passportNumber",
            "payoutMethod",
            "payoutMethodCode",
            "payoutSchedule",
            "pciSelfAssessment",
            "personalData",
            "phoneCountryCode",
            "phoneNumber",
            "postalCode",
            "primaryCurrency",
            "reason",
            "registrationNumber",
            "returnUrl",
            "schedule",
            "shareholder",
            "shareholderCode",
            "shareholderCodeAndSignatoryCode",
            "shareholderCodeOrSignatoryCode",
            "shareholderType",
            "shareholderTypes",
            "shopperInteraction",
            "signatory",
            "signatoryCode",
            "socialSecurityNumber",
            "sourceAccountCode",
            "splitAccount",
            "splitConfigurationUUID",
            "splitCurrency",
            "splitValue",
            "splits",
            "stateOrProvince",
            "status",
            "stockExchange",
            "stockNumber",
            "stockTicker",
            "store",
            "storeDetail",
            "storeName",
            "storeReference",
            "street",
            "taxId",
            "tier",
            "tierNumber",
            "transferCode",
            "ultimateParentCompany",
            "ultimateParentCompanyAddressDetails",
            "ultimateParentCompanyAddressDetailsCountry",
            "ultimateParentCompanyBusinessDetails",
            "ultimateParentCompanyBusinessDetailsLegalBusinessName",
            "ultimateParentCompanyBusinessDetailsRegistrationNumber",
            "ultimateParentCompanyCode",
            "ultimateParentCompanyStockExchange",
            "ultimateParentCompanyStockNumber",
            "ultimateParentCompanyStockNumberOrStockTicker",
            "ultimateParentCompanyStockTicker",
            "unknown",
            "value",
            "verificationType",
            "virtualAccount",
            "visaNumber",
            "webAddress",
            "year"
          ],
          "type": "string"
        },
        "shareholderCode": {
          "description": "The code of the shareholder that the field belongs to. If empty, the field belongs to an account holder.",
          "type": "string"
        }
      },
      "type": "object"
    }
  }
}