Canonical URL

ResidentCard Credential

A certificate that attests that a recipient is legally registered as a resident in a country.

Canonical URL

Property	Description
`address`	The address of the recipient of the certificate.
`birthDate` schema.org	The date of birth of the recipient of the certificate.
`birthPlace`	The place of birth of the recipient of the certificate.
`familyName` schema.org	The family name, or last name, of the recipient of the certificate.
`gender`	The gender of the recipient of the certificate. See notes below.
`givenName` schema.org	The given name, or first name, of the recipient of the certificate.
`identifier`	The national identifier of the recipient of the certificate in the issuing country, e.g. social security number in Luxembourg.
`issuedBy`	The organization issuing the verifiable credential.
`maritalStatus`	The marital status of the recipient of the certificate at the time of issuance.
`nationality`	The nationality of the recipient of the certificate.

Example

The following JSON object is an example of how data can be expressed in the credentialSubject section of a ResidentCard verifiable credential.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


{
  "address": "21 rue Glesener, L-1631 Luxembourg, Luxembourg",
  "birthDate": "1997-02-16",
  "birthPlace": "Luxembourg, LUX",
  "email": "paul.durand@example.com",
  "familyName": "Durand",
  "gender": "male",
  "givenName": "Paul",
  "identifier": "1997021612356",
  "issuedBy": {
    "logo": "https://example.com/logo.png",
    "name": "Municipality A"
  },
  "maritalStatus": "Single",
  "nationality": "LU"
}

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102


{
  "credentialPreview": {
    "@context": [
      "https://www.w3.org/2018/credentials/v1",
      {
        "RevocationList2020Status": {
          "@context": {
            "@protected": true,
            "id": "@id",
            "revocationListCredential": {
              "@id": "https://w3id.org/vc-revocation-list-2020#revocationListCredential",
              "@type": "@id"
            },
            "revocationListIndex": "https://w3id.org/vc-revocation-list-2020#revocationListIndex",
            "type": "@type"
          },
          "@id": "https://w3id.org/vc-revocation-list-2020#RevocationList2020Status"
        }
      },
      {
        "ResidentCard": {
          "@context": {
            "@protected": true,
            "@version": 1.1,
            "address": "schema:address",
            "birthDate": "schema:birthDate",
            "birthPlace": "schema:birthPlace",
            "email": "schema:email",
            "familyName": "schema:familyName",
            "gender": "schema:gender",
            "givenName": "schema:givenName",
            "id": "@id",
            "identifier": "schema:identifier",
            "issuedBy": {
              "@context": {
                "@protected": true,
                "@version": 1.1,
                "logo": {
                  "@id": "schema:logo",
                  "@type": "@id"
                },
                "name": "schema:name",
                "schema": "https://schema.org/"
              },
              "@id": "schema:issuedBy"
            },
            "maritalStatus": "https://vocabulary.trustmydata.compell.io/properties/maritalStatus",
            "nationality": "schema:nationality",
            "schema": "https://schema.org/",
            "type": "@type"
          },
          "@id": "https://vocabulary.trustmydata.compell.io/credentials/ResidentCard"
        },
        "description": "https://schema.org/description",
        "name": "https://schema.org/name"
      }
    ],
    "credentialSchema": {
      "id": "...",
      "type": "JsonSchemaValidator2021"
    },
    "credentialSubject": {
      "id": "did:...",
      "type": "ResidentCard",
      "address": "21 rue Glesener, L-1631 Luxembourg, Luxembourg",
      "birthDate": "1997-02-16",
      "birthPlace": "Luxembourg, LUX",
      "email": "paul.durand@example.com",
      "familyName": "Durand",
      "gender": "male",
      "givenName": "Paul",
      "identifier": "1997021612356",
      "issuedBy": {
        "logo": "https://example.com/logo.png",
        "name": "Municipality A"
      },
      "maritalStatus": "Single",
      "nationality": "LU"
    },
    "description": [
      {
        "@language": "en",
        "@value": "This certificate proves the reality of your residence in Luxembourg.\n"
      }
    ],
    "id": "urn:...",
    "issuanceDate": "2021-12-08T08:55:32Z",
    "issuer": "did:...",
    "name": [
      {
        "@language": "en",
        "@value": "Residence certificate"
      }
    ],
    "type": [
      "VerifiableCredential",
      "ResidentCard"
    ]
  },
  "expires": "2022-12-08T08:55:32Z",
  "type": "CredentialOffer",
}

Notes on the `gender` property

This vocabulary defines a non-binary gender property, where the accepted values can be other than male or female. While multiple countries legally recognize non-binary or third gender classifications, the value of this property may be restricted depending on the issuing country within the scope of this verifiable credential.

ResidentCard Credential

Example

Notes on the gender property

Notes on the `gender` property