Adyen · JSON Structure

Legal Entity Verification Error Structure

VerificationError schema from Adyen API

Type: object Properties: 6
PaymentsFinancial ServicesFintech

VerificationError is a JSON Structure definition published by Adyen, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

capabilities code message remediatingActions subErrors type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/legal-entity-verification-error-structure.json",
  "description": "VerificationError schema from Adyen API",
  "type": "object",
  "properties": {
    "capabilities": {
      "description": "Contains key-value pairs that specify the actions that the legal entity can do in your platform. The key is a capability required for your integration. For example, **issueCard** for Issuing.The value is an object containing the settings for the capability.",
      "items": {
        "enum": [
          "acceptExternalFunding",
          "acceptPspFunding",
          "acceptTransactionInRestrictedCountries",
          "acceptTransactionInRestrictedCountriesCommercial",
          "acceptTransactionInRestrictedCountriesConsumer",
          "acceptTransactionInRestrictedIndustries",
          "acceptTransactionInRestrictedIndustriesCommercial",
          "acceptTransactionInRestrictedIndustriesConsumer",
          "acquiring",
          "atmWithdrawal",
          "atmWithdrawalCommercial",
          "atmWithdrawalConsumer",
          "atmWithdrawalInRestrictedCountries",
          "atmWithdrawalInRestrictedCountriesCommercial",
          "atmWithdrawalInRestrictedCountriesConsumer",
          "authorisedPaymentInstrumentUser",
          "getGrantOffers",
          "issueBankAccount",
          "issueCard",
          "issueCardCommercial",
          "issueCardConsumer",
          "localAcceptance",
          "payout",
          "payoutToTransferInstrument",
          "processing",
          "receiveFromBalanceAccount",
          "receiveFromPlatformPayments",
          "receiveFromThirdParty",
          "receiveFromTransferInstrument",
          "receiveGrants",
          "receivePayments",
          "sendToBalanceAccount",
          "sendToThirdParty",
          "sendToTransferInstrument",
          "thirdPartyFunding",
          "useCard",
          "useCardCommercial",
          "useCardConsumer",
          "useCardInRestrictedCountries",
          "useCardInRestrictedCountriesCommercial",
          "useCardInRestrictedCountriesConsumer",
          "useCardInRestrictedIndustries",
          "useCardInRestrictedIndustriesCommercial",
          "useCardInRestrictedIndustriesConsumer",
          "withdrawFromAtm",
          "withdrawFromAtmCommercial",
          "withdrawFromAtmConsumer",
          "withdrawFromAtmInRestrictedCountries",
          "withdrawFromAtmInRestrictedCountriesCommercial",
          "withdrawFromAtmInRestrictedCountriesConsumer"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "code": {
      "description": "The general error code.",
      "type": "string"
    },
    "message": {
      "description": "The general error message.",
      "type": "string"
    },
    "remediatingActions": {
      "description": "An object containing possible solutions to fix a verification error.",
      "items": {
        "$ref": "#/components/schemas/RemediatingAction"
      },
      "type": "array"
    },
    "subErrors": {
      "description": "An array containing more granular information about the cause of the verification error.",
      "items": {
        "$ref": "#/components/schemas/VerificationError-recursive"
      },
      "type": "array"
    },
    "type": {
      "description": "The type of error.",
      "enum": [
        "dataMissing",
        "dataReview",
        "invalidInput",
        "pendingStatus",
        "rejected"
      ],
      "type": "string"
    }
  },
  "name": "VerificationError"
}