Das Schema person:identificationdocuments definiert:

documents – Eine Liste von Identifikationsdokumenten einer Person. Jedes Dokument enthält:

type

value: Art des Dokuments (z. B. „passport“, „idCard“, „residencePermit“).

scheme: URI eines kontrollierten Vokabulars (z. B. „b2:documenttypes“).

language: Sprache der Bezeichnung (z. B. „en“, „de“).

number: Offizielle Dokumentennummer.

issuer

authority: Ausstellende Behörde (z. B. „Stadt Köln“).

country: Länderkürzel nach ISO 3166-1 Alpha-2 (z. B. „DE“).

region: Optional, z. B. Bundesland oder Verwaltungseinheit.

issueDate: Ausstellungsdatum im ISO-8601-Format (YYYY-MM-DD).

expiryDate: Ablaufdatum im ISO-8601-Format (YYYY-MM-DD).

validityStatus

value: Gültigkeitsstatus (z. B. „valid“, „expired“, „revoked“).

scheme: URI des verwendeten Status-Vokabulars.

machineReadableZone

lines: Optional, ein- bis dreizeilige maschinenlesbare Zone (z. B. MRZ aus Reisepässen).

notes

language: Sprache des Hinweises (z. B. „de“).

text: Freitextlicher Hinweis zum Dokument.

linkedBiometrics

type: Typ des biometrischen Merkmals (z. B. „face“, „fingerprint“).

reference: URI oder ID zur Referenz auf das Merkmal.

translations

language: Sprache der Übersetzung (z. B. „fr“).

authorityTranslated: Übersetzung der ausstellenden Behörde.

typeTranslated: Übersetzung des Dokumenttyps.

{
  "documents": [
    {
      "type": {
        "value": "passport",
        "scheme": "b2:documenttypes",
        "language": "en"
      },
      "number": "C01X0006H",
      "issuer": {
        "authority": "Stadt Köln",
        "country": "DE",
        "region": "NW"
      },
      "issueDate": "2017-03-01",
      "expiryDate": "2027-02-28",
      "validityStatus": {
        "value": "valid",
        "scheme": "b2:validitystatuses"
      },
      "machineReadableZone": {
        "lines": [
          "P<DEUDOE<<JOHN<<<<<<<<<<<<<<<<<<<<<<<<<<<",
          "C01X0006HDEU8007257M2702286<<<<<<<<<<<<<<02"
        ]
      },
      "notes": [
        {
          "language": "de",
          "text": "Nur gültig für berufliche Reisen"
        }
      ],
      "linkedBiometrics": [
        {
          "type": "face",
          "reference": "urn:b2base:biometric:face:1234567890"
        }
      ],
      "translations": [
        {
          "language": "fr",
          "authorityTranslated": "Ville de Cologne",
          "typeTranslated": "passeport"
        }
      ]
    }
  ]
}

$person['identificationdocuments']['documents'][0]['type']['value'] = "passport";
$person['identificationdocuments']['documents'][0]['type']['scheme'] = "b2:documenttypes";
$person['identificationdocuments']['documents'][0]['type']['language'] = "en";

$person['identificationdocuments']['documents'][0]['number'] = "C01X0006H";

$person['identificationdocuments']['documents'][0]['issuer']['authority'] = "Stadt Köln";
$person['identificationdocuments']['documents'][0]['issuer']['country'] = "DE";
$person['identificationdocuments']['documents'][0]['issuer']['region'] = "NW";

$person['identificationdocuments']['documents'][0]['issueDate'] = "2017-03-01";
$person['identificationdocuments']['documents'][0]['expiryDate'] = "2027-02-28";

$person['identificationdocuments']['documents'][0]['validityStatus']['value'] = "valid";
$person['identificationdocuments']['documents'][0]['validityStatus']['scheme'] = "b2:validitystatuses";

$person['identificationdocuments']['documents'][0]['machineReadableZone']['lines'][0] = "P<DEUDOE<<JOHN<<<<<<<<<<<<<<<<<<<<<<<<<<<";
$person['identificationdocuments']['documents'][0]['machineReadableZone']['lines'][1] = "C01X0006HDEU8007257M2702286<<<<<<<<<<<<<<02";

$person['identificationdocuments']['documents'][0]['notes'][0]['language'] = "de";
$person['identificationdocuments']['documents'][0]['notes'][0]['text'] = "Nur gültig für berufliche Reisen";

$person['identificationdocuments']['documents'][0]['linkedBiometrics'][0]['type'] = "face";
$person['identificationdocuments']['documents'][0]['linkedBiometrics'][0]['reference'] = "urn:b2base:biometric:face:1234567890";

$person['identificationdocuments']['documents'][0]['translations'][0]['language'] = "fr";
$person['identificationdocuments']['documents'][0]['translations'][0]['authorityTranslated'] = "Ville de Cologne";
$person['identificationdocuments']['documents'][0]['translations'][0]['typeTranslated'] = "passeport";

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://b2base.eu/schema/person/identificationdocuments.json",
  "title": "Identification Documents",
  "description": "Standardisiertes, internationales Schema für Identifikationsdokumente von Personen",
  "type": "object",
  "properties": {
    "documents": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "object",
            "properties": {
              "value": { "type": "string" },
              "scheme": { "type": "string", "format": "uri" },
              "language": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" }
            },
            "required": ["value"]
          },
          "number": {
            "type": "string",
            "description": "Die offizielle Dokumentennummer"
          },
          "issuer": {
            "type": "object",
            "properties": {
              "authority": { "type": "string" },
              "country": { "type": "string", "pattern": "^[A-Z]{2}$" },
              "region": { "type": "string" }
            },
            "required": ["authority", "country"]
          },
          "issueDate": {
            "type": "string",
            "format": "date"
          },
          "expiryDate": {
            "type": "string",
            "format": "date"
          },
          "validityStatus": {
            "type": "object",
            "properties": {
              "value": { "type": "string" },
              "scheme": { "type": "string", "format": "uri" }
            },
            "required": ["value"]
          },
          "machineReadableZone": {
            "type": "object",
            "properties": {
              "lines": {
                "type": "array",
                "items": { "type": "string" },
                "minItems": 1,
                "maxItems": 3
              }
            }
          },
          "notes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "language": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" },
                "text": { "type": "string" }
              },
              "required": ["text"]
            }
          },
          "linkedBiometrics": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "type": { "type": "string" },
                "reference": { "type": "string", "format": "uri" }
              },
              "required": ["type", "reference"]
            }
          },
          "translations": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "language": { "type": "string", "pattern": "^[a-z]{2}(-[A-Z]{2})?$" },
                "authorityTranslated": { "type": "string" },
                "typeTranslated": { "type": "string" }
              },
              "required": ["language"]
            }
          }
        },
        "required": ["type", "number", "issuer", "issueDate"]
      }
    }
  },
  "required": ["documents"]
}