Adyen · JSON Structure

Accounts Kyc Check Status Data Structure

KYCCheckStatusData schema from Adyen API

Type: object Properties: 4 Required: 2
PaymentsFinancial ServicesFintech

KYCCheckStatusData is a JSON Structure definition published by Adyen, describing 4 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

requiredFields status summary 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/accounts-kyc-check-status-data-structure.json",
  "description": "KYCCheckStatusData schema from Adyen API",
  "type": "object",
  "properties": {
    "requiredFields": {
      "description": "A list of the fields required for execution of the check.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "status": {
      "description": "The status of the check.\n\nPossible values: **AWAITING_DATA** , **DATA_PROVIDED**, **FAILED**, **INVALID_DATA**, **PASSED**, **PENDING**, **RETRY_LIMIT_REACHED**.",
      "enum": [
        "AWAITING_DATA",
        "DATA_PROVIDED",
        "FAILED",
        "INVALID_DATA",
        "PASSED",
        "PENDING",
        "PENDING_REVIEW",
        "RETRY_LIMIT_REACHED",
        "UNCHECKED"
      ],
      "type": "string"
    },
    "summary": {
      "description": "A summary of the execution of the check.",
      "$ref": "#/components/schemas/KYCCheckSummary"
    },
    "type": {
      "description": "The type of check.\n\nPossible values:\n\n * **BANK_ACCOUNT_VERIFICATION**: Used in v5 and earlier. Replaced by **PAYOUT_METHOD_VERIFICATION** in v6 and later.\n\n * **COMPANY_VERIFICATION**\n\n  * **CARD_VERIFICATION**\n\n* **IDENTITY_VERIFICATION**\n\n* **LEGAL_ARRANGEMENT_VERIFICATION**\n\n* **NONPROFIT_VERIFICATION**\n\n * **PASSPORT_VERIFICATION**\n\n* **PAYOUT_METHOD_VERIFICATION**: Used in v6 and later.\n\n* **PCI_VERIFICATION**",
      "enum": [
        "BANK_ACCOUNT_VERIFICATION",
        "CARD_VERIFICATION",
        "COMPANY_VERIFICATION",
        "IDENTITY_VERIFICATION",
        "LEGAL_ARRANGEMENT_VERIFICATION",
        "NONPROFIT_VERIFICATION",
        "PASSPORT_VERIFICATION",
        "PAYOUT_METHOD_VERIFICATION",
        "PCI_VERIFICATION"
      ],
      "type": "string"
    }
  },
  "required": [
    "type",
    "status"
  ],
  "name": "KYCCheckStatusData"
}