Adyen · JSON Structure

Notifications Personal Document Data Structure

PersonalDocumentData schema from Adyen API

Type: object Properties: 5 Required: 1
PaymentsFinancial ServicesFintech

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

Properties

expirationDate issuerCountry issuerState number 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/notifications-personal-document-data-structure.json",
  "description": "PersonalDocumentData schema from Adyen API",
  "type": "object",
  "properties": {
    "expirationDate": {
      "description": "The expiry date of the document, \n in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.",
      "type": "string"
    },
    "issuerCountry": {
      "description": "The country where the document was issued, in the two-character \n[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.",
      "maxLength": 2,
      "minLength": 2,
      "type": "string"
    },
    "issuerState": {
      "description": "The state where the document was issued (if applicable).",
      "type": "string"
    },
    "number": {
      "description": "The number in the document.",
      "type": "string"
    },
    "type": {
      "description": "The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**.\n\nTo delete an existing entry for a document `type`, send only the `type` field in your request. ",
      "enum": [
        "DRIVINGLICENSE",
        "ID",
        "PASSPORT",
        "SOCIALSECURITY",
        "VISA"
      ],
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "name": "PersonalDocumentData"
}