Skip to content

Commit 1694668

Browse files
TinaKTTinaKT
authored
Merge pull request #1446 from Concordium/Ad-ID-attributes-reference
Ad IDd attributes reference
2 parents 6a37d9a + b8c8992 commit 1694668

File tree

3 files changed

+161
-1
lines changed

3 files changed

+161
-1
lines changed

‎source/mainnet/docs/network/web3-id/id-attributes-reference.rst‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
.. _id-attributes-reference:
2+
3+
========================
4+
ID attributes reference
5+
========================
6+
7+
8+
This page lists all ID attributes available in Concordium Identity Credentials, including their types, attribute tags, and value formats.
9+
10+
There are two types of ID credentials:
11+
12+
- **Individual ID**: For individuals using personal identification documents
13+
- **Company ID**: For companies using corporate documents
14+
15+
.. _individual-id-attributes:
16+
17+
Individual ID attributes
18+
========================
19+
20+
The following table lists all attributes available for Individual IDs.
21+
22+
23+
.. list-table::
24+
:header-rows: 1
25+
:widths: 20 15 20 45
26+
27+
* - Attribute
28+
- Type
29+
- Attribute tag
30+
- Attribute value format
31+
* - First name
32+
- Mandatory
33+
- firstName
34+
- string
35+
* - Last name
36+
- Mandatory
37+
- lastName
38+
- string
39+
* - Date of birth
40+
- Mandatory
41+
- dob
42+
- ISO8601 YYYYMMDD
43+
* - Identity Document Type
44+
- Mandatory
45+
- idDocType
46+
- na=0, passport=1, national id card=2, driving license=3, immigration card=4 or eID string (see separate table)
47+
* - Sex
48+
- Optional
49+
- sex
50+
- ISO/IEC 5218
51+
* - Country of residence
52+
- Optional
53+
- countryOfResidence
54+
- ISO3166-1 alpha-2
55+
* - Country of nationality
56+
- Mandatory
57+
- nationality
58+
- ISO3166-1 alpha-2
59+
* - Identity Document number
60+
- Optional (one of the two)
61+
- idDocNo
62+
- string
63+
* - Identity Document Issuer
64+
- Optional
65+
- idDocIssuer
66+
- ISO3166-1 alpha-2 or ISO3166-2 if applicable
67+
* - ID Valid from
68+
- Optional
69+
- idDocIssuedAt
70+
- ISO8601 YYYYMMDD
71+
* - ID Valid to
72+
- Optional
73+
- idDocExpiresAt
74+
- ISO8601 YYYYMMDD
75+
* - National ID number
76+
- Optional (one of the two)
77+
- nationalIdNo
78+
- string
79+
* - Tax ID number
80+
- Optional
81+
- taxIdNo
82+
- string
83+
84+
.. _company-id-attributes:
85+
86+
Company ID attributes
87+
=====================
88+
89+
The following table lists all attributes available for Company IDs.
90+
91+
.. list-table::
92+
:header-rows: 1
93+
:widths: 20 15 20 45
94+
95+
* - Attribute
96+
- Type
97+
- Attribute tag
98+
- Attribute value format
99+
* - Legal Name
100+
- Mandatory
101+
- legalName
102+
- string
103+
* - Legal Jurisdiction Country
104+
- Mandatory
105+
- legalCountry
106+
- ISO3166-1 alpha-2
107+
* - Business Number
108+
- Mandatory
109+
- businessNumber
110+
- string
111+
* - LEI-code
112+
- Optional
113+
- lei
114+
- ISO17442
115+
* - Registration authority
116+
- Optional
117+
- registrationAuth
118+
- string
119+
120+
.. _document-type-exceptions:
121+
122+
Document type exceptions
123+
========================
124+
125+
The following table lists the eID string values that can be used for the Identity Document Type attribute.
126+
127+
.. list-table::
128+
:header-rows: 1
129+
:widths: 30 70
130+
131+
* - idDocType eID string
132+
- Description
133+
* - DK:MITID
134+
- Danish MitId
135+
* - SE:BANKID
136+
- Swedish BankID
137+
* - NO:BANKID
138+
- Norwegian BankID
139+
* - NO:VIPPS
140+
- Norwegian Vipps
141+
* - FI:TRUSTNETWORK
142+
- Finnish Trust Network
143+
* - NL:DIGID
144+
- Netherlands DigiD
145+
* - NL:IDIN
146+
- Netherlands iDIN
147+
* - BE:EID
148+
- Belgian eID
149+
* - ITSME
150+
- (Cross-national) ItsME
151+
* - SOFORT
152+
- (Cross-national) Sofort
153+

‎source/mainnet/docs/network/web3-id/index.rst‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ Concordium’s identity layer is built into the protocol. Every account on the c
1414
.. image:: ../../../docs/images/mobile-wallet/MW12.png
1515
:width: 25%
1616

17-
You can read more about the identity provider issued account credentials in :ref:`Identity<reference-identity>`.
17+
|
18+
19+
You can read more about the identity provider issued account credentials in :ref:`Identity framework on Concordium<reference-identity>`.
20+
21+
You can find a complete list of available ID attributes and their formats in :ref:`ID attributes reference<id-attributes-reference>`.
1822

1923
Web3 ID
2024
=======
@@ -104,4 +108,5 @@ An example backend can be found in `the Web3 ID repository <https://github.com/C
104108
issuer
105109
Wallet identity provider interfaces <identity-provider-interfaces>
106110
../guides/create-proofs
111+
id-attributes-reference
107112

‎source/mainnet/tools/developer-page.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ All of our repositories are on `GitHub <https://github.com/Concordium>`__.
7373

7474
For information about how to create proofs to verify identity for dApps and services see :ref:`Create proofs<create-proofs>`.
7575

76+
For a complete list of available ID attributes that can be used in proofs, see :ref:`id-attributes-reference`.
77+
7678
If you want to familiarize yourself with how proofs work and can be constructed as well as test them, you can use the `Concordium Proof Explorer <https://web3id-proof-explorer.testnet.concordium.com/>`__ to create proofs and send them to a |bw| to see how they interact with account credentials and verifiable credentials. The Concordium Proof Explorer works on Testnet. You can use the `Web3Id Issuer Frontend <https://web3id-issuer-frontend.testnet.concordium.com/>`__ to create verifiable credential to test with the proof explorer.
7779

7880
If you decide that you want to become an issuer of verifiable credentials, see :ref:`Web3 ID issuers<web3id-issuer>` to learn more and access the production ready tools to become an issuer.

0 commit comments

Comments
 (0)