Mews · Schema

Identity document (ver 2024-10-25)

HospitalityHotelsPMSProperty Management

Properties

Name	Type	Description
Id	string	Unique identifier of the document.
CustomerId	string	Identifier of the `Customer`.
Type	object	Type of the document. IdentityCard Passport Visa DriversLicense
Number	string	Number of the document (e.g. passport number). The value is an empty string when the number is not collected in certain regions, such as The Netherlands.
ExpirationDate	string	Expiration date in ISO 8601 format.
IssuanceDate	string	Date of issuance in ISO 8601 format.
IssuingCountryCode	string	ISO 3166-1 code of the `Country`.
IssuingCountrySubdivisionCode	string	Identifier of the country subdivision where the document was issued (province, state or region).
IssuingCity	string	City where the document was issued.
IdentityDocumentSupportNumber	string	Identity document support number. Only required for Spanish identity cards in Spanish hotels.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/IdentityDocumentV20241025",
  "title": "Identity document (ver 2024-10-25)",
  "required": [
    "CustomerId",
    "Id",
    "Number",
    "Type"
  ],
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "Unique identifier of the document.",
      "format": "uuid"
    },
    "CustomerId": {
      "type": "string",
      "description": "Identifier of the `Customer`.",
      "format": "uuid"
    },
    "Type": {
      "title": "Document type",
      "allOf": [
        {
          "$ref": "#/components/schemas/IdentityDocumentTypeEnum"
        }
      ],
      "description": "Type of the document.\n\nIdentityCard\n\nPassport\n\nVisa\n\nDriversLicense",
      "x-enumNames": [
        "IdentityCard",
        "Passport",
        "Visa",
        "DriversLicense"
      ],
      "x-enumDescriptions": [
        "",
        "",
        "",
        ""
      ]
    },
    "Number": {
      "minLength": 1,
      "type": "string",
      "description": "Number of the document (e.g. passport number). The value is an empty string when the number is not collected in certain regions, such as The Netherlands."
    },
    "ExpirationDate": {
      "type": "string",
      "description": "Expiration date in ISO 8601 format.",
      "format": "date",
      "nullable": true
    },
    "IssuanceDate": {
      "type": "string",
      "description": "Date of issuance in ISO 8601 format.",
      "format": "date",
      "nullable": true
    },
    "IssuingCountryCode": {
      "type": "string",
      "description": "ISO 3166-1 code of the `Country`.",
      "nullable": true
    },
    "IssuingCountrySubdivisionCode": {
      "type": "string",
      "description": "Identifier of the country subdivision where the document was issued (province, state or region).",
      "nullable": true
    },
    "IssuingCity": {
      "type": "string",
      "description": "City where the document was issued.",
      "nullable": true
    },
    "IdentityDocumentSupportNumber": {
      "type": "string",
      "description": "Identity document support number. Only required for Spanish identity cards in Spanish hotels.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "IdentityDocumentV20241025"
}