Adyen · Schema

PersonalDocumentData

PaymentsFinancial ServicesFintech

Properties

Name Type Description
expirationDate string The expiry date of the document, in ISO-8601 YYYY-MM-DD format. For example, **2000-01-31**.
issuerCountry string The country where the document was issued, in the two-character [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. For example, **NL**.
issuerState string The state where the document was issued (if applicable).
number string The number in the document.
type string The type of the document. Possible values: **ID**, **DRIVINGLICENSE**, **PASSPORT**, **SOCIALSECURITY**, **VISA**. To delete an existing entry for a document `type`, send only the `type` field in your
View JSON Schema on GitHub

JSON Schema

adyen-personaldocumentdata-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PersonalDocumentData",
  "title": "PersonalDocumentData",
  "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"
  ],
  "type": "object"
}