Accounts Document Detail Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/accounts-document-detail-structure.json",
  "description": "DocumentDetail schema from Adyen API",
  "type": "object",
  "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"
  ],
  "name": "DocumentDetail"
}