@cef-ebsi/vcdm1.1-vid-natural-person-schema
v5.0.0
Published
Person Identification Data for the Natural Person (VCDM 1.1)
Keywords
Readme
@cef-ebsi/vcdm1.1-vid-natural-person-schema
Person Identification Data for the Natural Person
Reference: https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=OJ:L_202402977
The schema is published to the Trusted Schemas Registry with the IDs:
0x3575d43f6da84b0705272aa08a2aa928d45cfddbea0f3e7a343b7fa745cb293e(hexadecimal)z4bgpN8zjHe8v9nFbRzU2eRaAfRLDozRzYcYKdjr1pX7s(multibase base58btc)
Table of Contents
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Person Identification Data for the Natural Person",
"description": "Reference: https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=OJ:L_202402977",
"type": "object",
"allOf": [
{
"$ref": "./node_modules/@cef-ebsi/vcdm1.1-attestation-schema/schema.json"
},
{
"type": "object",
"properties": {
"credentialSubject": {
"type": "object",
"properties": {
"family_name": {
"type": "string",
"description": "Current last name(s) or surname(s) of the user to whom the person identification data relates.",
"minLength": 1
},
"given_name": {
"type": "string",
"description": "Current first name(s), including middle name(s) where applicable, of the user to whom the person identification data relates.",
"minLength": 1
},
"birth_date": {
"type": "string",
"format": "date",
"description": "Day, month, and year on which the user to whom the person identification data relates was born."
},
"birth_place": {
"type": "string",
"description": "The country as an alpha-2 country code as specified in ISO 3166-1, or the state, province, district, or local area or the municipality, city, town, or village where the user to whom the person identification data relates was born."
},
"nationality": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"CV",
"KH",
"CM",
"CA",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CD",
"CG",
"CK",
"CR",
"CI",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"SZ",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MK",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"description": "One or more alpha-2 country codes as specified in ISO 3166-1, representing the nationality of the user to whom the person identification data relates."
},
"resident_address": {
"type": "string",
"description": "The full address of the place where the user to whom the person identification data relates currently resides or can be contacted (street name, house number, city etc.)."
},
"resident_country": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"CV",
"KH",
"CM",
"CA",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CD",
"CG",
"CK",
"CR",
"CI",
"HR",
"CU",
"CW",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"SZ",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MK",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"SS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
],
"description": "The country where the user to whom the person identification data relates currently resides, as an alpha-2 country code as specified in ISO 3166-1."
},
"resident_state": {
"type": "string",
"description": "The state, province, district, or local area where the user to whom the person identification data relates currently resides."
},
"resident_city": {
"type": "string",
"description": "The municipality, city, town, or village where the user to whom the person identification data relates currently resides."
},
"resident_postal_code": {
"type": "string",
"description": "The postal code of the place where the user to whom the person identification data relates currently resides."
},
"resident_street": {
"type": "string",
"description": "The name of the street where the user to whom the person identification data relates currently resides."
},
"resident_house_number": {
"type": "string",
"description": "The house number where the user to whom the person identification data relates currently resides, including any affix or suffix."
},
"personal_administrative_number": {
"type": "string",
"description": "A value assigned to the natural person that is unique among all personal administrative numbers issued by the provider of person identification data. Where Member States opt to include this attribute, they shall describe in their electronic identification schemes under which the person identification data is issued, the policy that they apply to the values of this attribute, including, where applicable, specific conditions for the processing of this value."
},
"portrait": {
"type": "string",
"description": "Facial image of the wallet user compliant with ISO 19794-5 or ISO 39794 specifications."
},
"family_name_birth": {
"type": "string",
"description": "Last name(s) or surname(s) of the person identification data user at the time of birth."
},
"given_name_birth": {
"type": "string",
"description": "First name(s), including middle name(s), of the person identification data user at the time of birth."
},
"sex": {
"type": "integer",
"enum": [0, 1, 2, 3, 4, 5, 6, 9],
"description": "Sex of the user. Values: 0 = not known, 1 = male, 2 = female, 3 = other, 4 = inter, 5 = diverse, 6 = open, 9 = not applicable. For values 0, 1, 2 and 9, ISO/IEC 5218 applies."
},
"email_address": {
"type": "string",
"format": "email",
"description": "Electronic mail address of the user to whom the person identification data relates [in conformance with RFC 5322]."
},
"mobile_phone_number": {
"type": "string",
"pattern": "^\\+\\d+$",
"description": "Mobile telephone number of the user to whom the person identification data relates, starting with the ‘+’ symbol as the international code prefix and the country code, followed by numbers only."
},
"expiry_date": {
"type": "string",
"format": "date-time",
"description": "Date (and if possible time) when the person identification data will expire."
},
"document_number": {
"type": "string",
"description": "A number for the person identification data, assigned by the provider of person identification data.",
"nullable": true
},
"issuing_authority": {
"type": "string",
"description": "Name of the administrative authority that issued the person identification data, or the ISO 3166 alpha-2 country code of the respective Member State if there is no separate authority entitled to issue person identification data."
},
"issuing_country": {
"type": "string",
"pattern": "^[A-Z]{2}$",
"description": "Alpha-2 country code, as specified in ISO 3166-1, of the country or territory of the provider of the person identification data."
},
"issuing_jurisdiction": {
"type": "string",
"pattern": "^[A-Z]{2}(-[A-Za-z0-9]{1,3})?$",
"description": "Country subdivision code of the jurisdiction that issued the person identification data, as specified in ISO 3166-2:2020, Clause 8. The first part of the code shall be the same as the value for the issuing country.",
"nullable": true
},
"location_status": {
"type": "string",
"description": "The location of validity status information on the person identification data where the providers of person identification data revoke person identification data.",
"nullable": true
}
},
"required": [
"family_name",
"given_name",
"birth_date",
"birth_place",
"nationality",
"expiry_date",
"issuing_authority",
"issuing_country"
]
}
}
}
]
}Installation
# with npm
npm add @cef-ebsi/[email protected]
# with Yarn
yarn add @cef-ebsi/[email protected]
# with pnpm
pnpm add @cef-ebsi/[email protected]Usage
The package exports the schema and its metadata as JavaScript objects:
import { schema, metadata } from "@cef-ebsi/vcdm1.1-vid-natural-person-schema";
// you can now use the schema and metadataIn addition, the package exports a TypeScript type corresponding to the schema:
import type { PersonIdentificationDataForTheNaturalPerson } from "@cef-ebsi/vcdm1.1-vid-natural-person-schema";License
Copyright (C) 2024 European Union
This program is free software: you can redistribute it and/or modify it under the terms of the EUROPEAN UNION PUBLIC LICENCE v. 1.2 as published by the European Union.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the EUROPEAN UNION PUBLIC LICENCE v. 1.2 for further details.
You should have received a copy of the EUROPEAN UNION PUBLIC LICENCE v. 1.2. along with this program. If not, see https://joinup.ec.europa.eu/collection/eupl/eupl-text-eupl-12.