@mattrglobal/verifier-sdk-web 1.1.1-unstable.28 → 1.1.1-unstable.29

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -142,9 +142,23 @@ const credentialQuery = [
142
142
  }
143
143
  ];
144
144
  ```
145
-
145
+ * `profile`: Credential format of the credential that will be verified. Currently only mobile (mDocs) is supported.
146
+ * `docType`: the mDL’s type. Confirm with the certificate issuer for what docType they are issuing. Some common examples include:
147
+ * Mobile Driver Licence (`org.iso.18013.5.1.mDL`).
148
+ * PhotoID (`org.iso.23220.photoid.1`).
149
+ * Mobile Vehicle Registration Card (`org.iso.7367.1.mVRC`).
150
+ * Health certificate (`org.micov.vtr.1`).
151
+ * `nameSpaces`: Each namespace corresponds to a group of claims included in the credential. These can be claims that are part of a specific standard, jurisdiction or any other reference. The namespace would usually correspond to the requested `docType`.
152
+ * `intentToRetain` (Optional): When set to `true`, the holder will be indicated that the verifier intends to retain this claim beyond the verification workflow. Defaults to `false` when not specified.
153
+
146
154
  > The API supports including multiple query objects in the `credentialQuery` array in a single request. For simplicity, this example only includes a single query object.
147
155
 
156
+ In this example the `credentialQuery` query will request for the `birthdate`, `portrait` and `resident_postal_code` claims from any credentials whose `profile` is `mobile` and `docType` is `org.iso.18013.5.1.mDL`.
157
+
158
+ It also sets `intentToRetain` as `false` for all claims, indicating to the holder that the verifier will not retain any of these claims.
159
+
160
+ > While `intentToRetain` defaults to false, it is explicitly set to `false` in the example above for clarity purposes. If there is no intention to retain a claim, it is sufficient to simply exclude `intentToRetain` from the query.
161
+
148
162
  ## Generate challenge
149
163
 
150
164
  The Verifier Web SDK passes a unique challenge to the MATTR VII verifier tenant with every request to create a new presentation session. The purpose of the challenge is to ensure the security and integrity of the credential verification process by preventing replay attacks and verifying the authenticity of each request and response. You can either:
@@ -7,7 +7,7 @@
7
7
  * Do Not Translate or Localize
8
8
  *
9
9
  * Bundle of @mattrglobal/verifier-sdk-web
10
- * Generated: 2025-01-21
10
+ * Generated: 2025-01-22
11
11
  * Version: 1.1.0
12
12
  * Dependencies:
13
13
  */
@@ -7,7 +7,7 @@
7
7
  * Do Not Translate or Localize
8
8
  *
9
9
  * Bundle of @mattrglobal/verifier-sdk-web
10
- * Generated: 2025-01-21
10
+ * Generated: 2025-01-22
11
11
  * Version: 1.1.0
12
12
  * Dependencies:
13
13
  *
@@ -7,7 +7,7 @@
7
7
  * Do Not Translate or Localize
8
8
  *
9
9
  * Bundle of @mattrglobal/verifier-sdk-web
10
- * Generated: 2025-01-21
10
+ * Generated: 2025-01-22
11
11
  * Version: 1.1.0
12
12
  * Dependencies:
13
13
  *
@@ -7,7 +7,7 @@
7
7
  * Do Not Translate or Localize
8
8
  *
9
9
  * Bundle of @mattrglobal/verifier-sdk-web
10
- * Generated: 2025-01-21
10
+ * Generated: 2025-01-22
11
11
  * Version: 1.1.0
12
12
  * Dependencies:
13
13
  *
@@ -7,7 +7,7 @@
7
7
  * Do Not Translate or Localize
8
8
  *
9
9
  * Bundle of @mattrglobal/verifier-sdk-web
10
- * Generated: 2025-01-21
10
+ * Generated: 2025-01-22
11
11
  * Version: 1.1.0
12
12
  * Dependencies:
13
13
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mattrglobal/verifier-sdk-web",
3
- "version": "1.1.1-unstable.28+e3817b59",
3
+ "version": "1.1.1-unstable.29+1ed6b005",
4
4
  "main": "dist/lib/verifier-js.cjs.js",
5
5
  "types": "dist/typings/index.d.ts",
6
6
  "module": "dist/verifier-js.production.esm.js",
@@ -30,5 +30,5 @@
30
30
  "docs": "rm -rf generatedDoc/ && typedoc && cp CHANGELOG_PUBLIC.md generatedDoc/CHANGELOG.md",
31
31
  "docs:html": "NAME=\"MATTR Verifier Web SDK\" ../../scripts/generateHtmlDocs.sh"
32
32
  },
33
- "gitHead": "e3817b5910cf058b158dd0fe07a51178843584b2"
33
+ "gitHead": "1ed6b005fb23e4297aeea99d3581a0d517d2357c"
34
34
  }