@reclaimprotocol/client 0.1.0 → 0.1.2
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 +37 -35
- package/lib/enckeys.d.ts +38 -31
- package/lib/enckeys.js +88 -13
- package/lib/encoding.d.ts +5 -0
- package/lib/encoding.js +19 -3
- package/lib/index.d.ts +3 -3
- package/lib/index.js +2 -2
- package/lib/keypair.d.ts +3 -2
- package/lib/keypair.js +15 -1
- package/lib/reclaim.d.ts +35 -32
- package/lib/reclaim.js +19 -15
- package/lib/result.d.ts +20 -16
- package/lib/result.js +68 -54
- package/lib/routes.gen.d.ts +60 -12
- package/lib/routes.gen.js +16 -4
- package/lib/secp.d.ts +1 -2
- package/lib/secp.js +1 -1
- package/lib/types/openapi.d.ts +2 -2
- package/lib/types/openapi.gen.d.ts +916 -129
- package/package.json +7 -2
- package/src/enckeys.ts +114 -35
- package/src/encoding.ts +21 -3
- package/src/index.ts +6 -3
- package/src/keypair.ts +20 -3
- package/src/reclaim.ts +54 -51
- package/src/result.ts +86 -65
- package/src/routes.gen.ts +16 -4
- package/src/secp.ts +1 -1
- package/src/types/openapi.gen.ts +916 -129
- package/src/types/openapi.ts +2 -2
|
@@ -30,7 +30,10 @@ export interface paths {
|
|
|
30
30
|
path?: never;
|
|
31
31
|
cookie?: never;
|
|
32
32
|
};
|
|
33
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Discover home — search a website to verify
|
|
35
|
+
* @description Default home page. A website-first search: the visitor types a website and picks one to continue to `/site/{domain}`, where they choose what data to prove. Renders popular websites below the search.
|
|
36
|
+
*/
|
|
34
37
|
get: operations["Index"];
|
|
35
38
|
put?: never;
|
|
36
39
|
post?: never;
|
|
@@ -101,6 +104,212 @@ export interface paths {
|
|
|
101
104
|
patch?: never;
|
|
102
105
|
trace?: never;
|
|
103
106
|
};
|
|
107
|
+
"/discover/websites": {
|
|
108
|
+
parameters: {
|
|
109
|
+
query?: never;
|
|
110
|
+
header?: never;
|
|
111
|
+
path?: never;
|
|
112
|
+
cookie?: never;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Suggest websites for the Discover flow
|
|
116
|
+
* @description Website-first autocomplete that backs the Discover home page (`/`). Returns the distinct websites (one entry per domain) that have at least one verification the caller can see, ranked by relevance to `q`. Each entry carries the aggregated list of data points provable for that website. With no `q`, returns popular websites (most verifications first).
|
|
117
|
+
*
|
|
118
|
+
* HTML / HTMX callers receive a fragment list (swapped into the search dropdown); JSON / SDK callers receive the suggestions document.
|
|
119
|
+
*/
|
|
120
|
+
get: operations["DiscoverWebsites"];
|
|
121
|
+
put?: never;
|
|
122
|
+
post?: never;
|
|
123
|
+
delete?: never;
|
|
124
|
+
options?: never;
|
|
125
|
+
head?: never;
|
|
126
|
+
patch?: never;
|
|
127
|
+
trace?: never;
|
|
128
|
+
};
|
|
129
|
+
"/site/{domain}": {
|
|
130
|
+
parameters: {
|
|
131
|
+
query?: never;
|
|
132
|
+
header?: never;
|
|
133
|
+
path?: never;
|
|
134
|
+
cookie?: never;
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
* Website landing & data-point selection page
|
|
138
|
+
* @description SEO landing page for a website, and the data-point selection step of the Discover flow. Lists every data point Reclaim can currently prove for `{domain}` (aggregated across all verifications the caller can see) so a visitor can pick what to verify and continue. Organic search traffic ("verify github username") and the in-app `/` → website-select flow converge on this single canonical URL.
|
|
139
|
+
*
|
|
140
|
+
* HTML callers receive the full page; when `q` is present and the request is an HTMX request, only the filtered data-point list fragment is returned. JSON / SDK callers receive the website's data points as a document.
|
|
141
|
+
*/
|
|
142
|
+
get: operations["SitePage"];
|
|
143
|
+
put?: never;
|
|
144
|
+
post?: never;
|
|
145
|
+
delete?: never;
|
|
146
|
+
options?: never;
|
|
147
|
+
head?: never;
|
|
148
|
+
patch?: never;
|
|
149
|
+
trace?: never;
|
|
150
|
+
};
|
|
151
|
+
"/site/{domain}/panel": {
|
|
152
|
+
parameters: {
|
|
153
|
+
query?: never;
|
|
154
|
+
header?: never;
|
|
155
|
+
path?: never;
|
|
156
|
+
cookie?: never;
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* Discover summary panel fragment (htmx)
|
|
160
|
+
* @description HTMX-only fragment for the Discover site page. The data-point form fires this on every selection change (checkbox / mode / source pin), carrying the whole selection in the query string. Returns the summary panel aside (the swap target) plus an out-of-band swap of the Advanced source picker.
|
|
161
|
+
*/
|
|
162
|
+
get: operations["SitePanel"];
|
|
163
|
+
put?: never;
|
|
164
|
+
post?: never;
|
|
165
|
+
delete?: never;
|
|
166
|
+
options?: never;
|
|
167
|
+
head?: never;
|
|
168
|
+
patch?: never;
|
|
169
|
+
trace?: never;
|
|
170
|
+
};
|
|
171
|
+
"/site/{domain}/build": {
|
|
172
|
+
parameters: {
|
|
173
|
+
query?: never;
|
|
174
|
+
header?: never;
|
|
175
|
+
path?: never;
|
|
176
|
+
cookie?: never;
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* Build page — providers, try, and integration guide for a selection
|
|
180
|
+
* @description The step after data-point selection on `/site/{domain}`. Given the selected data points (plus optional pinned sources, provided values, and a resolution `mode`), shows which existing verification providers cover the selection, a member-only "Try verification" action, and a ready-to-paste integration guide. The whole selection travels in the query string so the page is server-rendered and back-navigable.
|
|
181
|
+
*/
|
|
182
|
+
get: operations["SiteBuild"];
|
|
183
|
+
put?: never;
|
|
184
|
+
post?: never;
|
|
185
|
+
delete?: never;
|
|
186
|
+
options?: never;
|
|
187
|
+
head?: never;
|
|
188
|
+
patch?: never;
|
|
189
|
+
trace?: never;
|
|
190
|
+
};
|
|
191
|
+
"/site/{domain}/try": {
|
|
192
|
+
parameters: {
|
|
193
|
+
query?: never;
|
|
194
|
+
header?: never;
|
|
195
|
+
path?: never;
|
|
196
|
+
cookie?: never;
|
|
197
|
+
};
|
|
198
|
+
get?: never;
|
|
199
|
+
put?: never;
|
|
200
|
+
/**
|
|
201
|
+
* Mint a SANDBOX test verification session for the selection
|
|
202
|
+
* @description Creates a real SANDBOX verification session under the signed-in member's personal organization for the selected data points, so they can test the flow on `/v/{sessionId}` without registering a callback subscription. Requires a signed-in member (session cookie); the provider set is recomputed server-side from the selection.
|
|
203
|
+
*/
|
|
204
|
+
post: operations["SiteBuildTry"];
|
|
205
|
+
delete?: never;
|
|
206
|
+
options?: never;
|
|
207
|
+
head?: never;
|
|
208
|
+
patch?: never;
|
|
209
|
+
trace?: never;
|
|
210
|
+
};
|
|
211
|
+
"/site/{domain}/repair": {
|
|
212
|
+
parameters: {
|
|
213
|
+
query?: never;
|
|
214
|
+
header?: never;
|
|
215
|
+
path?: never;
|
|
216
|
+
cookie?: never;
|
|
217
|
+
};
|
|
218
|
+
/**
|
|
219
|
+
* Failure-aware "Repair with an AI coding agent" wizard fragment
|
|
220
|
+
* @description Body of the build page's repair dialog, lazy-loaded after a sandbox Try fails so the agent prompt includes the REAL failure (which provider(s) failed + the error reason, read from the session's event log) and the resolved provider set. HTML / HTMX fragment.
|
|
221
|
+
*/
|
|
222
|
+
get: operations["SiteBuildRepair"];
|
|
223
|
+
put?: never;
|
|
224
|
+
post?: never;
|
|
225
|
+
delete?: never;
|
|
226
|
+
options?: never;
|
|
227
|
+
head?: never;
|
|
228
|
+
patch?: never;
|
|
229
|
+
trace?: never;
|
|
230
|
+
};
|
|
231
|
+
"/site/{domain}/alternative": {
|
|
232
|
+
parameters: {
|
|
233
|
+
query?: never;
|
|
234
|
+
header?: never;
|
|
235
|
+
path?: never;
|
|
236
|
+
cookie?: never;
|
|
237
|
+
};
|
|
238
|
+
/**
|
|
239
|
+
* Re-resolve excluding a failed provider, else hand off to repair
|
|
240
|
+
* @description After a sandbox Try fails, reads which provider(s) failed from the session analytics and re-resolves the selection with them excluded. If the rest still cover it, responds with an `HX-Redirect` to the build page (failed providers excluded — the alternative set). Otherwise emits an `openRepair` HX-Trigger so the client opens the repair wizard.
|
|
241
|
+
*/
|
|
242
|
+
get: operations["SiteBuildAlternative"];
|
|
243
|
+
put?: never;
|
|
244
|
+
post?: never;
|
|
245
|
+
delete?: never;
|
|
246
|
+
options?: never;
|
|
247
|
+
head?: never;
|
|
248
|
+
patch?: never;
|
|
249
|
+
trace?: never;
|
|
250
|
+
};
|
|
251
|
+
"/discover/teach": {
|
|
252
|
+
parameters: {
|
|
253
|
+
query?: never;
|
|
254
|
+
header?: never;
|
|
255
|
+
path?: never;
|
|
256
|
+
cookie?: never;
|
|
257
|
+
};
|
|
258
|
+
/**
|
|
259
|
+
* “Teach our agent” instructions for a missing website / data point
|
|
260
|
+
* @description Returns the "Teach our agent" panel shown when a website or data point a user wants does not exist yet: steps to install the Reclaim MCP server plus a ready-to-copy prompt, templated with the requested `domain` and (optionally) `dataPoint`, that instructs an agent to author the missing verification. HTML / HTMX only (a dialog fragment).
|
|
261
|
+
*/
|
|
262
|
+
get: operations["DiscoverTeachAgent"];
|
|
263
|
+
put?: never;
|
|
264
|
+
post?: never;
|
|
265
|
+
delete?: never;
|
|
266
|
+
options?: never;
|
|
267
|
+
head?: never;
|
|
268
|
+
patch?: never;
|
|
269
|
+
trace?: never;
|
|
270
|
+
};
|
|
271
|
+
"/discover/resolve": {
|
|
272
|
+
parameters: {
|
|
273
|
+
query?: never;
|
|
274
|
+
header?: never;
|
|
275
|
+
path?: never;
|
|
276
|
+
cookie?: never;
|
|
277
|
+
};
|
|
278
|
+
/**
|
|
279
|
+
* Resolve a website + data points to verification providers
|
|
280
|
+
* @description Provider resolution: given a website and the data points the user wants their users to prove, return the smallest set of existing providers whose data points COVER the selection (greedy combine), the `requiredContext` inputs the consumer must supply, and any `uncovered` points no provider exposes yet (`needsCreation` is true then — author a provider with the agent tools). When the chosen providers can be fused into one (same start page, no clashing page scripts) `merge.mergeable` is true.
|
|
281
|
+
*
|
|
282
|
+
* Agent flow: pick a website (`GET /discover/data-points` lists what's verifiable there), confirm the data points with the user, call this to get the `providers` + `requiredContext`, collect those context values from the user, then `POST /verifications/sessions` with `providers` (pass every id) and `context` to mint a verification.
|
|
283
|
+
*/
|
|
284
|
+
get: operations["DiscoverResolve"];
|
|
285
|
+
put?: never;
|
|
286
|
+
post?: never;
|
|
287
|
+
delete?: never;
|
|
288
|
+
options?: never;
|
|
289
|
+
head?: never;
|
|
290
|
+
patch?: never;
|
|
291
|
+
trace?: never;
|
|
292
|
+
};
|
|
293
|
+
"/discover/data-points": {
|
|
294
|
+
parameters: {
|
|
295
|
+
query?: never;
|
|
296
|
+
header?: never;
|
|
297
|
+
path?: never;
|
|
298
|
+
cookie?: never;
|
|
299
|
+
};
|
|
300
|
+
/**
|
|
301
|
+
* List the verifiable data points on a website
|
|
302
|
+
* @description The data points existing providers can prove on a website — the menu to pick from before `GET /discover/resolve`. Optionally filter by `q`.
|
|
303
|
+
*/
|
|
304
|
+
get: operations["DiscoverDataPoints"];
|
|
305
|
+
put?: never;
|
|
306
|
+
post?: never;
|
|
307
|
+
delete?: never;
|
|
308
|
+
options?: never;
|
|
309
|
+
head?: never;
|
|
310
|
+
patch?: never;
|
|
311
|
+
trace?: never;
|
|
312
|
+
};
|
|
104
313
|
"/providers/{providerId}/preview.png": {
|
|
105
314
|
parameters: {
|
|
106
315
|
query?: never;
|
|
@@ -392,6 +601,26 @@ export interface paths {
|
|
|
392
601
|
patch?: never;
|
|
393
602
|
trace?: never;
|
|
394
603
|
};
|
|
604
|
+
"/v/{sessionId}/dispose": {
|
|
605
|
+
parameters: {
|
|
606
|
+
query?: never;
|
|
607
|
+
header?: never;
|
|
608
|
+
path?: never;
|
|
609
|
+
cookie?: never;
|
|
610
|
+
};
|
|
611
|
+
get?: never;
|
|
612
|
+
put?: never;
|
|
613
|
+
/**
|
|
614
|
+
* Dispose the session's remote browser
|
|
615
|
+
* @description Tears down the Popcorn remote-browser session backing this verification and cancels any in-flight run. Called by the verification page's "close" button (and safe to call after a session is already terminal — the dispose is idempotent). Popcorn sessions are a scarce, expensive resource, so freeing them promptly rather than waiting for their TTL matters. Same model as the status fragment: possession of the session id; no body.
|
|
616
|
+
*/
|
|
617
|
+
post: operations["DisposeVerificationSession"];
|
|
618
|
+
delete?: never;
|
|
619
|
+
options?: never;
|
|
620
|
+
head?: never;
|
|
621
|
+
patch?: never;
|
|
622
|
+
trace?: never;
|
|
623
|
+
};
|
|
395
624
|
"/v/{sessionId}/sse": {
|
|
396
625
|
parameters: {
|
|
397
626
|
query?: never;
|
|
@@ -563,8 +792,7 @@ export interface paths {
|
|
|
563
792
|
delete?: never;
|
|
564
793
|
options?: never;
|
|
565
794
|
head?: never;
|
|
566
|
-
|
|
567
|
-
patch: operations["UpdateMe"];
|
|
795
|
+
patch?: never;
|
|
568
796
|
trace?: never;
|
|
569
797
|
};
|
|
570
798
|
"/users/{userId}": {
|
|
@@ -640,7 +868,11 @@ export interface paths {
|
|
|
640
868
|
path?: never;
|
|
641
869
|
cookie?: never;
|
|
642
870
|
};
|
|
643
|
-
|
|
871
|
+
/**
|
|
872
|
+
* List organization members, optionally filtered by email
|
|
873
|
+
* @description Returns the organization's members, optionally filtered by an email substring (`q`). Renders the members-list fragment for the org page's live filter; same visibility as the org page.
|
|
874
|
+
*/
|
|
875
|
+
get: operations["SearchOrgMembers"];
|
|
644
876
|
put?: never;
|
|
645
877
|
/**
|
|
646
878
|
* Invite a member to an organization
|
|
@@ -738,7 +970,7 @@ export interface paths {
|
|
|
738
970
|
patch: operations["UpdateTheme"];
|
|
739
971
|
trace?: never;
|
|
740
972
|
};
|
|
741
|
-
"/orgs/{orgId}/
|
|
973
|
+
"/orgs/{orgId}/keypair": {
|
|
742
974
|
parameters: {
|
|
743
975
|
query?: never;
|
|
744
976
|
header?: never;
|
|
@@ -746,21 +978,21 @@ export interface paths {
|
|
|
746
978
|
cookie?: never;
|
|
747
979
|
};
|
|
748
980
|
/**
|
|
749
|
-
* Get the organization's encryption
|
|
750
|
-
* @description Returns the organization's single
|
|
981
|
+
* Get the organization's encryption keypair
|
|
982
|
+
* @description Returns the organization's single Ethereum (secp256k1) encryption keypair — its public JWK, derived eth address, and `canEncryptResult` flag — or `404` when none is set (the org is keyless ⇒ plaintext delivery). Authenticated by the org's `OrgToken` or a human `BearerAuth` session for an active member of the org.
|
|
751
983
|
*/
|
|
752
|
-
get: operations["
|
|
984
|
+
get: operations["GetOrgKeypair"];
|
|
753
985
|
/**
|
|
754
|
-
* Set (or
|
|
755
|
-
* @description Upserts the organization's single
|
|
986
|
+
* Set (or rotate) the organization's encryption keypair
|
|
987
|
+
* @description Upserts the organization's single Ethereum (secp256k1) encryption keypair. The body carries the org's **eth public key** — as an uncompressed hex string (`0x04`+128 hex) or a secp256k1 public JWK (`{kty:'EC', crv:'secp256k1', x, y}`) — and `canEncryptResult`. The matching private key never leaves the consumer. Setting overwrites the single row (and creates it for a keyless org). When `canEncryptResult` is true, terminal results are delivered as an ECIES ciphertext encrypted to this key; otherwise plaintext. Authenticated by the org's `OrgToken` or a human `BearerAuth` session for an active member of the org.
|
|
756
988
|
*/
|
|
757
|
-
put: operations["
|
|
989
|
+
put: operations["SetOrgKeypair"];
|
|
758
990
|
post?: never;
|
|
759
991
|
/**
|
|
760
|
-
* Clear the organization's encryption
|
|
761
|
-
* @description Removes the organization's encryption
|
|
992
|
+
* Clear the organization's encryption keypair
|
|
993
|
+
* @description Removes the organization's encryption keypair (the org reverts to keyless ⇒ plaintext delivery, and loses its eth identity address) until a new keypair is set. Authenticated by the org's `OrgToken` or a human `BearerAuth` session for an active member of the org.
|
|
762
994
|
*/
|
|
763
|
-
delete: operations["
|
|
995
|
+
delete: operations["DeleteOrgKeypair"];
|
|
764
996
|
options?: never;
|
|
765
997
|
head?: never;
|
|
766
998
|
patch?: never;
|
|
@@ -878,6 +1110,26 @@ export interface paths {
|
|
|
878
1110
|
patch?: never;
|
|
879
1111
|
trace?: never;
|
|
880
1112
|
};
|
|
1113
|
+
"/attach": {
|
|
1114
|
+
parameters: {
|
|
1115
|
+
query?: never;
|
|
1116
|
+
header?: never;
|
|
1117
|
+
path?: never;
|
|
1118
|
+
cookie?: never;
|
|
1119
|
+
};
|
|
1120
|
+
/**
|
|
1121
|
+
* Device-pairing landing page
|
|
1122
|
+
* @description Page where a user enters the 5-character pairing code shown by their CLI / MCP. Submitting the form (`?code=`) redirects to the canonical `/attach/{code}` page; an invalid code re-renders the form with an error.
|
|
1123
|
+
*/
|
|
1124
|
+
get: operations["AttachLanding"];
|
|
1125
|
+
put?: never;
|
|
1126
|
+
post?: never;
|
|
1127
|
+
delete?: never;
|
|
1128
|
+
options?: never;
|
|
1129
|
+
head?: never;
|
|
1130
|
+
patch?: never;
|
|
1131
|
+
trace?: never;
|
|
1132
|
+
};
|
|
881
1133
|
"/attach/{code}": {
|
|
882
1134
|
parameters: {
|
|
883
1135
|
query?: never;
|
|
@@ -1194,9 +1446,9 @@ export interface paths {
|
|
|
1194
1446
|
* the presented `OrgToken` resolves to. The body is just `callbackUrl`
|
|
1195
1447
|
* and `events`. At least one subscription must exist for the org before a
|
|
1196
1448
|
* verification session can be created. Delivery is scoped by org: terminal
|
|
1197
|
-
* results are encrypted
|
|
1198
|
-
*
|
|
1199
|
-
* as plaintext.
|
|
1449
|
+
* results are ECIES-encrypted to the org's eth public key when its
|
|
1450
|
+
* `canEncryptResult` is enabled (see `PUT /orgs/{orgId}/keypair`), else
|
|
1451
|
+
* delivered as plaintext.
|
|
1200
1452
|
*/
|
|
1201
1453
|
post: operations["CreateCallbackSubscription"];
|
|
1202
1454
|
delete?: never;
|
|
@@ -1390,8 +1642,8 @@ export interface paths {
|
|
|
1390
1642
|
cookie?: never;
|
|
1391
1643
|
};
|
|
1392
1644
|
/**
|
|
1393
|
-
* Get the resolved provider
|
|
1394
|
-
* @description Returns the resolved provider
|
|
1645
|
+
* Get the resolved provider recipes for a session
|
|
1646
|
+
* @description Returns the session's resolved provider versions' recipes (`initialUrl` + `requests` per provider), in run order — what the Verification Client needs to run the session (each provider sequentially in one browser session). Authorized for the Verification Client (`X-VC-Token` service token) or the session creator (authenticated by the consumer's `OrgToken`; the resolved org must match the session), so it works regardless of the provider's visibility (unlike `GetProvider`, which 404s on PRIVATE providers for non-members).
|
|
1395
1647
|
*/
|
|
1396
1648
|
get: operations["GetVerificationRecipe"];
|
|
1397
1649
|
put?: never;
|
|
@@ -1500,7 +1752,7 @@ export interface paths {
|
|
|
1500
1752
|
};
|
|
1501
1753
|
/**
|
|
1502
1754
|
* List callback encryption keys for a session
|
|
1503
|
-
* @description Used by the Verification Client (X-VC-Token) after the terminal event: returns the session org's callback subscriptions that subscribe to that terminal event. Each item carries the org's `publicKeyJwk` (
|
|
1755
|
+
* @description Used by the Verification Client (X-VC-Token) after the terminal event: returns the session org's callback subscriptions that subscribe to that terminal event. Each item carries the org's `publicKeyJwk` (secp256k1) to ECIES-encrypt the result to when the org's `canEncryptResult` is enabled, or none (deliver plaintext).
|
|
1504
1756
|
*/
|
|
1505
1757
|
get: operations["ListSessionCallbackKeys"];
|
|
1506
1758
|
put?: never;
|
|
@@ -1526,7 +1778,7 @@ export interface paths {
|
|
|
1526
1778
|
put?: never;
|
|
1527
1779
|
/**
|
|
1528
1780
|
* Submit the signed, encrypted verification result
|
|
1529
|
-
* @description Used by the Verification Client (X-VC-Token) to submit the result after a terminal event. The VC signs the JWS and
|
|
1781
|
+
* @description Used by the Verification Client (X-VC-Token) to submit the result after a terminal event. The VC signs the JWS and, when the org's `canEncryptResult` is enabled, ECIES-encrypts it to the org's eth public key (from the callback-keys endpoint); it submits one payload per subscription. The Builder stores each payload, enqueues it for the delivery worker (retry → DLQ), and never sees the plaintext. The Verification Client does not contact the Consumer.
|
|
1530
1782
|
*/
|
|
1531
1783
|
post: operations["SubmitVerificationResult"];
|
|
1532
1784
|
delete?: never;
|
|
@@ -1617,18 +1869,18 @@ export interface webhooks {
|
|
|
1617
1869
|
* `timestamp` are *plaintext routing hints* so the consumer can
|
|
1618
1870
|
* route and dedupe before doing any crypto. Everything derived
|
|
1619
1871
|
* from the end-user (claims, extracted parameters, proofs,
|
|
1620
|
-
* context) is inside `data`:
|
|
1621
|
-
* result when the org
|
|
1872
|
+
* context) is inside `data`: an ECIES ciphertext wrapping the signed JWS
|
|
1873
|
+
* result when the org's `canEncryptResult` is enabled, else the
|
|
1622
1874
|
* plaintext signed JWS. The envelope is **not authenticated** —
|
|
1623
1875
|
* act only on the decrypted and signature-verified JWS contents,
|
|
1624
1876
|
* and check that its `reclaimSessionId` matches the session you
|
|
1625
1877
|
* expect.
|
|
1626
1878
|
*
|
|
1627
|
-
* **Decrypting `data`.** When the org
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1879
|
+
* **Decrypting `data`.** When the org's `canEncryptResult` is enabled,
|
|
1880
|
+
* `data` is an ECIES ciphertext (base64url, secp256k1 + AES-256-GCM);
|
|
1881
|
+
* decrypt it with the matching eth private key to recover the inner
|
|
1882
|
+
* JWS. When the org is keyless or the flag is off, `data` is the JWS
|
|
1883
|
+
* directly.
|
|
1632
1884
|
* The JWS is an RFC 7515 result in General JSON serialization
|
|
1633
1885
|
* (`alg: ES256K`); verify it against
|
|
1634
1886
|
* `GET /.well-known/jwks.json` (`kid` = the signer's ETH address).
|
|
@@ -1855,8 +2107,8 @@ export interface components {
|
|
|
1855
2107
|
providers?: components["schemas"]["ProviderListItem"][];
|
|
1856
2108
|
/** @description Themes owned by this organization. */
|
|
1857
2109
|
themes?: components["schemas"]["Theme"][];
|
|
1858
|
-
/** @description The organization's single
|
|
1859
|
-
|
|
2110
|
+
/** @description The organization's single Ethereum (secp256k1) encryption keypair, if set. Only populated on the org-detail endpoint and only visible to active members. Absent ⇒ the org is keyless and results are delivered as plaintext. */
|
|
2111
|
+
keypair?: components["schemas"]["OrgKeypair"];
|
|
1860
2112
|
/** @description Billing record attached to the org, if any. Owner-visible only; absent for members. Presence promotes the org to production mode. */
|
|
1861
2113
|
billing?: components["schemas"]["OrgBilling"];
|
|
1862
2114
|
createMetadata: components["schemas"]["ActorMetadata"];
|
|
@@ -1887,26 +2139,43 @@ export interface components {
|
|
|
1887
2139
|
*/
|
|
1888
2140
|
status: components["schemas"]["EntityStatus"];
|
|
1889
2141
|
};
|
|
1890
|
-
/** @description
|
|
1891
|
-
|
|
2142
|
+
/** @description A secp256k1 (Ethereum) public key in JWK form (`{kty:'EC', crv:'secp256k1', x, y}`), used to ECIES-encrypt delivered verification results and to identify the org. The matching private key never leaves the consumer. Same shape published by the signing JWKS. */
|
|
2143
|
+
JwkSecp256k1Public: {
|
|
1892
2144
|
/** @enum {string} */
|
|
1893
|
-
kty: "
|
|
2145
|
+
kty: "EC";
|
|
1894
2146
|
/** @enum {string} */
|
|
1895
|
-
crv: "
|
|
1896
|
-
/** @description base64url-encoded
|
|
2147
|
+
crv: "secp256k1";
|
|
2148
|
+
/** @description base64url-encoded X coordinate (32 bytes). */
|
|
1897
2149
|
x: string;
|
|
1898
|
-
|
|
1899
|
-
|
|
1900
|
-
|
|
1901
|
-
|
|
1902
|
-
|
|
2150
|
+
/** @description base64url-encoded Y coordinate (32 bytes). */
|
|
2151
|
+
y: string;
|
|
2152
|
+
};
|
|
2153
|
+
/** @description An organization's single Ethereum (secp256k1) encryption keypair: the public JWK, its derived eth address (which also identifies the org), and the `canEncryptResult` toggle. One per org, set/rotated via `PUT /orgs/{orgId}/keypair`. Absent ⇒ the org is keyless (plaintext delivery). */
|
|
2154
|
+
OrgKeypair: {
|
|
2155
|
+
publicKeyJwk: components["schemas"]["JwkSecp256k1Public"];
|
|
2156
|
+
/** @description Lowercase 0x eth address derived from the public key. */
|
|
2157
|
+
ethAddress: string;
|
|
2158
|
+
/** @description When true, terminal results are ECIES-encrypted to this key; when false (the default), they are delivered as plaintext. */
|
|
2159
|
+
canEncryptResult: boolean;
|
|
2160
|
+
/** @description Optional human-readable label set when the keypair was stored. */
|
|
1903
2161
|
label?: string;
|
|
1904
2162
|
createMetadata: components["schemas"]["ActorMetadata"];
|
|
1905
2163
|
updateMetadata: components["schemas"]["ActorMetadata"];
|
|
1906
2164
|
};
|
|
1907
|
-
|
|
1908
|
-
|
|
1909
|
-
|
|
2165
|
+
OrgKeypairRequest: components["schemas"]["OrgKeypairHexRequest"] | components["schemas"]["OrgKeypairJwkRequest"];
|
|
2166
|
+
/** @description Body for `PUT /orgs/{orgId}/keypair`. Carries the org's eth public key as an uncompressed hex string (`0x04` + 128 hex) — the eth-native form wallets/ethers emit. The matching private key never leaves the consumer. */
|
|
2167
|
+
OrgKeypairHexRequest: {
|
|
2168
|
+
/** @description Uncompressed secp256k1 public key, `0x04` + 128 hex. */
|
|
2169
|
+
publicKey: string;
|
|
2170
|
+
/** @default false */
|
|
2171
|
+
canEncryptResult: boolean;
|
|
2172
|
+
label?: string;
|
|
2173
|
+
};
|
|
2174
|
+
/** @description Body for `PUT /orgs/{orgId}/keypair`. Carries the org's eth public key as a secp256k1 public JWK. */
|
|
2175
|
+
OrgKeypairJwkRequest: {
|
|
2176
|
+
publicKeyJwk: components["schemas"]["JwkSecp256k1Public"];
|
|
2177
|
+
/** @default false */
|
|
2178
|
+
canEncryptResult: boolean;
|
|
1910
2179
|
label?: string;
|
|
1911
2180
|
};
|
|
1912
2181
|
/** @description Response of `POST /orgs/{orgId}/token`. The plaintext `orgSecret` is shown **only once** here; the server stores only its HMAC. Use it as `Authorization: Bearer <orgSecret>` (the `OrgToken` scheme). */
|
|
@@ -1992,8 +2261,10 @@ export interface components {
|
|
|
1992
2261
|
writeRedactionMode?: components["schemas"]["WriteRedactionMode"];
|
|
1993
2262
|
/** @description Apply TLS configuration when creating the tunnel to the attestor. */
|
|
1994
2263
|
additionalClientOptions?: components["schemas"]["AdditionalTlsClientOptions"];
|
|
1995
|
-
/** @description
|
|
1996
|
-
|
|
2264
|
+
/** @description Conditions the (redacted) response must satisfy for the proof to be valid. Each runs against the union of the portions revealed by `responseRedactions` (or the whole response when there are none). Mirrors attestor-core `responseMatches`. */
|
|
2265
|
+
responseMatches?: components["schemas"]["ResponseMatch"][];
|
|
2266
|
+
/** @description Portions to select/reveal from the response, applied in order (xPath => jsonPath => regex). Done client-side; only the selected portions (plus the first response line) are sent to the attestor. An independent ordered list — NOT paired 1:1 with `responseMatches`. Mirrors attestor-core `responseRedactions`. */
|
|
2267
|
+
responseRedactions?: components["schemas"]["ResponseRedaction"][];
|
|
1997
2268
|
};
|
|
1998
2269
|
/** @description A template for selecting request */
|
|
1999
2270
|
RequestSelectionTemplate: components["schemas"]["RequestSelection"] & {
|
|
@@ -2041,11 +2312,9 @@ export interface components {
|
|
|
2041
2312
|
type: "regex" | "contains";
|
|
2042
2313
|
/** @description The pattern or value to look for in the response. When `type` is 'contains', supports template variable declaration using `{{variable}}` syntax. When `type` is 'regex', can be used to extract variables using regex named groups. */
|
|
2043
2314
|
value: string;
|
|
2044
|
-
/** @description Optional extractor describing which portion of the response to pin to the proof. When absent, the match runs against the raw response body. */
|
|
2045
|
-
extract?: components["schemas"]["ExtractDataSpecifier"];
|
|
2046
2315
|
};
|
|
2047
2316
|
/** @description Which portions to select from a response. These are selected in order, xpath => jsonPath => regex * These redactions are done client side and only the selected portions are sent to the attestor. The attestor will only be able to see the selected portions alongside the first line of the HTTP response (i.e. "HTTP/1.1 200 OK") */
|
|
2048
|
-
|
|
2317
|
+
ResponseRedaction: {
|
|
2049
2318
|
/** @description expect an HTML response, and to contain a certain xpath for eg. "/html/body/div.a1/div.a2/span.a5" */
|
|
2050
2319
|
xPath?: string;
|
|
2051
2320
|
/** @description expect a JSON response, retrieve the item at this path using dot notation for e.g. 'email.addresses.0' */
|
|
@@ -2221,6 +2490,43 @@ export interface components {
|
|
|
2221
2490
|
primaryDataPoint?: string;
|
|
2222
2491
|
dataPoints: string[];
|
|
2223
2492
|
};
|
|
2493
|
+
/** @description One website (distinct domain) in the Discover search results. Aggregates, across every verification the caller can see on that domain, the brand display fields and the union of provable data points. */
|
|
2494
|
+
WebsiteSuggestion: {
|
|
2495
|
+
/**
|
|
2496
|
+
* Format: hostname
|
|
2497
|
+
* @description Canonical root domain (e.g. `github.com`).
|
|
2498
|
+
*/
|
|
2499
|
+
domain: string;
|
|
2500
|
+
/** @description Display name for the website (scraped site name or derived from the domain). */
|
|
2501
|
+
brandName: string;
|
|
2502
|
+
/**
|
|
2503
|
+
* Format: uri
|
|
2504
|
+
* @description Favicon URL for the website.
|
|
2505
|
+
*/
|
|
2506
|
+
iconUrl?: string;
|
|
2507
|
+
/** @description Deduplicated names of every data point provable for this website. */
|
|
2508
|
+
dataPoints: string[];
|
|
2509
|
+
/** @description Number of verifications backing this website that the caller can see. */
|
|
2510
|
+
providerCount: number;
|
|
2511
|
+
};
|
|
2512
|
+
/** @description Body for `POST /site/{domain}/try`. Only the verification `context` (values for the resolved providers' `requiredContext` inputs). The selection (dataPoints / mode / pins) travels in the query string. */
|
|
2513
|
+
SiteBuildTryBody: {
|
|
2514
|
+
/** @description Input key → value the consumer's app supplies. */
|
|
2515
|
+
context?: {
|
|
2516
|
+
[key: string]: string;
|
|
2517
|
+
};
|
|
2518
|
+
};
|
|
2519
|
+
/** @description A single data point selectable on the `/site/{domain}` page, with how many visible verifications expose it and one example verification slug. */
|
|
2520
|
+
DataPointItem: {
|
|
2521
|
+
/** @description Data-point name (e.g. `username`, `followers_count`). */
|
|
2522
|
+
name: string;
|
|
2523
|
+
/** @description Human description of the data point, taken from the response match that declares it. Absent when no match supplies one. */
|
|
2524
|
+
description?: string;
|
|
2525
|
+
/** @description Number of visible verifications on the domain that expose this data point. */
|
|
2526
|
+
providerCount: number;
|
|
2527
|
+
/** @description Slug of one verification that exposes this data point. */
|
|
2528
|
+
exampleProviderSlug?: string;
|
|
2529
|
+
};
|
|
2224
2530
|
InterceptorOptions: {
|
|
2225
2531
|
/**
|
|
2226
2532
|
* @description How traffic interception is implemented.
|
|
@@ -2411,12 +2717,16 @@ export interface components {
|
|
|
2411
2717
|
/** @description Opaque bearer token. Send as `Authorization: Bearer <token>` on every authenticated request. */
|
|
2412
2718
|
token: string;
|
|
2413
2719
|
};
|
|
2414
|
-
/** @description
|
|
2415
|
-
UpdateUserRequest: {
|
|
2416
|
-
name?: string;
|
|
2417
|
-
};
|
|
2720
|
+
/** @description Body for `POST /orgs`. Explicitly-created orgs must declare their Ethereum (secp256k1) encryption public key — it identifies the org and, when `canEncryptResult` is enabled, encrypts delivered results. */
|
|
2418
2721
|
CreateOrgRequest: {
|
|
2419
2722
|
name: string;
|
|
2723
|
+
/** @description The org's eth public key, uncompressed hex (`0x04` + 128 hex) — the eth-native form wallets/ethers emit. The matching private key never leaves the consumer. */
|
|
2724
|
+
publicKey: string;
|
|
2725
|
+
/**
|
|
2726
|
+
* @description When true, terminal results are ECIES-encrypted to this key; when false (the default), they are delivered as plaintext.
|
|
2727
|
+
* @default false
|
|
2728
|
+
*/
|
|
2729
|
+
canEncryptResult: boolean;
|
|
2420
2730
|
};
|
|
2421
2731
|
UpdateOrgRequest: {
|
|
2422
2732
|
name?: string;
|
|
@@ -2606,9 +2916,10 @@ export interface components {
|
|
|
2606
2916
|
* @description Lifecycle event reported for a verification session. A healthy run
|
|
2607
2917
|
* proceeds through these in order; reading the gaps locates where a
|
|
2608
2918
|
* session stalled. Session-level terminal events trigger callback
|
|
2609
|
-
* delivery; request-level events are progress pings carrying a
|
|
2610
|
-
* `
|
|
2611
|
-
* clients MUST tolerate unknown
|
|
2919
|
+
* delivery; provider-/request-level events are progress pings carrying a
|
|
2920
|
+
* `provider_id` (and `request_id` for request-level ones) in their event
|
|
2921
|
+
* data. New values may be added over time; clients MUST tolerate unknown
|
|
2922
|
+
* values in responses.
|
|
2612
2923
|
*
|
|
2613
2924
|
* - `session_pending`: Session created; awaiting the end-user.
|
|
2614
2925
|
*
|
|
@@ -2617,6 +2928,10 @@ export interface components {
|
|
|
2617
2928
|
*
|
|
2618
2929
|
* - `verification_client_ready`: The client initialized.
|
|
2619
2930
|
*
|
|
2931
|
+
* - `verification_provider_started`: The client began verifying a provider
|
|
2932
|
+
* (`provider_id`/`resolved_version`/`ordinal` in `eventData`). One per
|
|
2933
|
+
* provider, in run order, for multi-provider sessions.
|
|
2934
|
+
*
|
|
2620
2935
|
* - `request_matched`: The target request was captured on the provider
|
|
2621
2936
|
* site. Absent (after opened) ⇒ the user didn't complete the journey.
|
|
2622
2937
|
*
|
|
@@ -2637,7 +2952,7 @@ export interface components {
|
|
|
2637
2952
|
* - `session_expired`: `expiresAt` passed before a terminal event.
|
|
2638
2953
|
* @enum {string}
|
|
2639
2954
|
*/
|
|
2640
|
-
VerificationEvent: "session_pending" | "verification_client_opened" | "verification_client_ready" | "request_matched" | "request_claim_created" | "request_claim_completed" | "request_claim_rejected" | "request_claim_failed" | "verification_success" | "verification_rejected" | "verification_error" | "session_expired";
|
|
2955
|
+
VerificationEvent: "session_pending" | "verification_client_opened" | "verification_client_ready" | "verification_provider_started" | "request_matched" | "request_claim_created" | "request_claim_completed" | "request_claim_rejected" | "request_claim_failed" | "verification_success" | "verification_rejected" | "verification_error" | "session_expired";
|
|
2641
2956
|
/**
|
|
2642
2957
|
* @description Status of a verification session, derived from its events. New values
|
|
2643
2958
|
* may be added over time; clients MUST tolerate unknown values in
|
|
@@ -2674,7 +2989,7 @@ export interface components {
|
|
|
2674
2989
|
* @enum {string}
|
|
2675
2990
|
*/
|
|
2676
2991
|
CallbackDeliveryStatus: "pending" | "delivered" | "attempt_failed" | "failed";
|
|
2677
|
-
/** @description A pre-registered destination for verification results, owned by an organization. A session's results go to every subscription on the session's org whose `events` include the terminal event. At least one subscription must exist for the org before a session can be created. Terminal results are encrypted
|
|
2992
|
+
/** @description A pre-registered destination for verification results, owned by an organization. A session's results go to every subscription on the session's org whose `events` include the terminal event. At least one subscription must exist for the org before a session can be created. Terminal results are ECIES-encrypted to the org's eth public key when its `canEncryptResult` is enabled (see `OrgKeypair`), else delivered as plaintext. */
|
|
2678
2993
|
CallbackSubscription: {
|
|
2679
2994
|
/** Format: uuid */
|
|
2680
2995
|
id: string;
|
|
@@ -2717,11 +3032,8 @@ export interface components {
|
|
|
2717
3032
|
* @description UUID v7 session id (also echoed in context as `reclaimSessionId`).
|
|
2718
3033
|
*/
|
|
2719
3034
|
id: string;
|
|
2720
|
-
|
|
2721
|
-
|
|
2722
|
-
version?: string;
|
|
2723
|
-
/** @description Exact version resolved at creation time. */
|
|
2724
|
-
resolvedVersion: string;
|
|
3035
|
+
/** @description The providers this session verifies, in run order. The Verification Client runs each (sequentially, in one browser session) and submits one combined result; all are required. */
|
|
3036
|
+
providers: components["schemas"]["SessionProvider"][];
|
|
2725
3037
|
/** @description The organization that owns this session. */
|
|
2726
3038
|
orgId?: components["schemas"]["OrgID"];
|
|
2727
3039
|
/**
|
|
@@ -2748,16 +3060,29 @@ export interface components {
|
|
|
2748
3060
|
mode: components["schemas"]["CredentialMode"];
|
|
2749
3061
|
sandboxLimits?: components["schemas"]["SandboxLimits"];
|
|
2750
3062
|
};
|
|
2751
|
-
/** @description
|
|
2752
|
-
|
|
3063
|
+
/** @description One provider a session verifies, with its resolved version. */
|
|
3064
|
+
SessionProvider: {
|
|
3065
|
+
providerId: components["schemas"]["ProviderID"];
|
|
3066
|
+
/** @description Version constraint requested by the Consumer (empty = latest). */
|
|
3067
|
+
version?: string;
|
|
3068
|
+
/** @description Exact version resolved at creation time. */
|
|
3069
|
+
resolvedVersion: string;
|
|
3070
|
+
};
|
|
3071
|
+
/** @description A provider (+ optional version) to verify in a session. */
|
|
3072
|
+
SessionProviderInput: {
|
|
2753
3073
|
providerId: components["schemas"]["ProviderID"];
|
|
2754
3074
|
/** @description Semver constraint; empty resolves to the latest trunk version. */
|
|
2755
3075
|
version?: string;
|
|
2756
|
-
|
|
3076
|
+
};
|
|
3077
|
+
/** @description Body for `POST /verifications/sessions`. Authenticated by the consumer's `OrgToken`. Carries no callback URLs — they come from the org's callback subscriptions. The one shared `context` is validated against every provider's `requiredContext`. */
|
|
3078
|
+
CreateVerificationSessionRequest: {
|
|
3079
|
+
/** @description Providers to verify, in run order. The Verification Client runs each sequentially in one browser session and submits one combined result; all are required. */
|
|
3080
|
+
providers: components["schemas"]["SessionProviderInput"][];
|
|
3081
|
+
/** @description Consumer context, shared by all providers. Validated against EACH resolved provider version's `requiredContext` JSON Schema (a 400 is returned on mismatch); extra fields are always allowed. Recipe requests reference these values as `{{context.<key>}}`. Echoed back (plus `reclaimSessionId`) in the result. */
|
|
2757
3082
|
context: {
|
|
2758
3083
|
[key: string]: unknown;
|
|
2759
3084
|
};
|
|
2760
|
-
/** @description Must contain a `{sessionId}` placeholder. */
|
|
3085
|
+
/** @description Must contain a `{sessionId}` placeholder. Must be an http(s) URL. */
|
|
2761
3086
|
verificationClientUrl: string;
|
|
2762
3087
|
};
|
|
2763
3088
|
/** @description Body for `POST /verifications/sessions/{sessionId}/events`. Status ping only — never carries the proof (use the result endpoint for that). */
|
|
@@ -2801,7 +3126,7 @@ export interface components {
|
|
|
2801
3126
|
/** @description The event that produced this delivery. */
|
|
2802
3127
|
event: components["schemas"]["VerificationEvent"];
|
|
2803
3128
|
timestamp: components["schemas"]["Timestamp"];
|
|
2804
|
-
/** @description Payload interpreted per `event`. Terminal events: the signed result —
|
|
3129
|
+
/** @description Payload interpreted per `event`. Terminal events: the signed result — an **ECIES ciphertext** (base64url, secp256k1 + AES-256-GCM) wrapping the signed JWS when the org's `canEncryptResult` is enabled (decrypt with the matching eth private key to recover the inner JWS), else the JWS directly; the inner JWS parses as the `Jws` schema with payload `VerificationResultPayload`. Non-terminal events: plaintext JSON `{ event, eventData }` (unsigned). */
|
|
2805
3130
|
data: string;
|
|
2806
3131
|
};
|
|
2807
3132
|
/** @description The decoded JWS payload of a delivered verification result (the JWS itself is the `Jws` schema, signed ES256K by the key published at `/.well-known/jwks.json`). Consumers MUST check `reclaimSessionId` against the session they created and `verification_session.status` for the outcome. `results` is present on success; `problem` (RFC 9457 shape) is set when the run failed. */
|
|
@@ -2820,8 +3145,13 @@ export interface components {
|
|
|
2820
3145
|
verification_session: {
|
|
2821
3146
|
/** @enum {string} */
|
|
2822
3147
|
status: "success" | "rejected" | "error";
|
|
2823
|
-
|
|
2824
|
-
|
|
3148
|
+
/** @description The providers verified in this session, in run order. */
|
|
3149
|
+
providers: ({
|
|
3150
|
+
provider_id: components["schemas"]["ProviderID"];
|
|
3151
|
+
resolved_version: string;
|
|
3152
|
+
} & {
|
|
3153
|
+
[key: string]: unknown;
|
|
3154
|
+
})[];
|
|
2825
3155
|
/** Format: uuid */
|
|
2826
3156
|
org_id?: string | null;
|
|
2827
3157
|
/** Format: uuid */
|
|
@@ -2830,19 +3160,26 @@ export interface components {
|
|
|
2830
3160
|
} & {
|
|
2831
3161
|
[key: string]: unknown;
|
|
2832
3162
|
};
|
|
2833
|
-
/** @description One entry per
|
|
3163
|
+
/** @description One entry per verified provider (success only), in run order. Each carries that provider's proven requests. */
|
|
2834
3164
|
results?: ({
|
|
2835
|
-
|
|
2836
|
-
|
|
2837
|
-
|
|
2838
|
-
|
|
3165
|
+
provider_id: components["schemas"]["ProviderID"];
|
|
3166
|
+
resolved_version: string;
|
|
3167
|
+
/** @description One entry per proven request for this provider. */
|
|
3168
|
+
requests: ({
|
|
3169
|
+
request_id?: string;
|
|
3170
|
+
url?: string;
|
|
3171
|
+
method?: string;
|
|
3172
|
+
extracted_parameters?: {
|
|
3173
|
+
[key: string]: unknown;
|
|
3174
|
+
};
|
|
3175
|
+
content_hash?: string;
|
|
3176
|
+
identifier?: string;
|
|
3177
|
+
owner?: string;
|
|
3178
|
+
/** @description Base64url-encoded nested JWS (attestor proof). */
|
|
3179
|
+
proof?: unknown;
|
|
3180
|
+
} & {
|
|
2839
3181
|
[key: string]: unknown;
|
|
2840
|
-
};
|
|
2841
|
-
content_hash?: string;
|
|
2842
|
-
identifier?: string;
|
|
2843
|
-
owner?: string;
|
|
2844
|
-
/** @description Base64url-encoded nested JWS (attestor proof). */
|
|
2845
|
-
proof?: unknown;
|
|
3182
|
+
})[];
|
|
2846
3183
|
} & {
|
|
2847
3184
|
[key: string]: unknown;
|
|
2848
3185
|
})[];
|
|
@@ -2853,18 +3190,18 @@ export interface components {
|
|
|
2853
3190
|
} & {
|
|
2854
3191
|
[key: string]: unknown;
|
|
2855
3192
|
};
|
|
2856
|
-
/** @description A callback subscription's delivery key, returned to the Verification Client. When `publicKeyJwk` is present the VC
|
|
3193
|
+
/** @description A callback subscription's delivery key, returned to the Verification Client. When `publicKeyJwk` is present the VC ECIES-encrypts the result for that org (its `canEncryptResult` is enabled); when absent the VC submits the plaintext signed JWS. */
|
|
2857
3194
|
CallbackKey: {
|
|
2858
3195
|
/** Format: uuid */
|
|
2859
3196
|
subscriptionId: string;
|
|
2860
|
-
/** @description
|
|
2861
|
-
publicKeyJwk?: components["schemas"]["
|
|
3197
|
+
/** @description The org's secp256k1 (eth) public JWK to ECIES-encrypt the result to. Absent ⇒ deliver plaintext. */
|
|
3198
|
+
publicKeyJwk?: components["schemas"]["JwkSecp256k1Public"];
|
|
2862
3199
|
};
|
|
2863
|
-
/** @description One result payload for one callback subscription. The Verification Client signs the JWS and, when the org
|
|
3200
|
+
/** @description One result payload for one callback subscription. The Verification Client signs the JWS and, when the org's `canEncryptResult` is enabled, ECIES-encrypts it to the org's eth public key; otherwise it submits the plaintext JWS. Either way the payload is carried in `payload` and the Builder stores + delivers it as a blind relay. */
|
|
2864
3201
|
CallbackDelivery: {
|
|
2865
3202
|
/** Format: uuid */
|
|
2866
3203
|
subscriptionId: string;
|
|
2867
|
-
/** @description The signed result payload, as raw text
|
|
3204
|
+
/** @description The signed result payload, as raw text — an ECIES ciphertext (base64url) when the org's `canEncryptResult` is enabled, otherwise the plaintext JWS JSON. Same raw form the callback envelope's `data` carries. */
|
|
2868
3205
|
payload: string;
|
|
2869
3206
|
};
|
|
2870
3207
|
/** @description Body for `POST /verifications/sessions/{sessionId}/result`. The Verification Client signs the JWS, encrypts it per callback subscription (keys fetched from the callback-keys endpoint), and submits one ciphertext per subscription. The Builder stores + delivers them; it never sees the plaintext result. */
|
|
@@ -3003,7 +3340,7 @@ export interface operations {
|
|
|
3003
3340
|
Providers: {
|
|
3004
3341
|
parameters: {
|
|
3005
3342
|
query?: {
|
|
3006
|
-
/** @description Free-text search across `title`, `description`, `domain`, `primaryDataPoint`, `dataPoints`, and the latest version's `initialUrl`. Matched case-insensitively; returns results ranked by relevance (e.g., data point matches rank higher than description matches). */
|
|
3343
|
+
/** @description Free-text search across `title`, `description`, `domain`, `primaryDataPoint`, `dataPoints`, and the latest version's `initialUrl`. Matched case-insensitively; returns results ranked by relevance (e.g., data point matches rank higher than description matches). An empty value is treated as no query (the handler redirects to the bare catalog). */
|
|
3007
3344
|
q?: string;
|
|
3008
3345
|
/** @description Filter by tag. Repeat the parameter to OR multiple tags (a provider matching any of them is returned). Combined with `q` via AND. */
|
|
3009
3346
|
tag?: components["schemas"]["Tag"][];
|
|
@@ -3088,21 +3425,414 @@ export interface operations {
|
|
|
3088
3425
|
default: components["responses"]["ProblemResponse"];
|
|
3089
3426
|
};
|
|
3090
3427
|
};
|
|
3091
|
-
|
|
3428
|
+
DiscoverWebsites: {
|
|
3092
3429
|
parameters: {
|
|
3093
3430
|
query?: {
|
|
3094
|
-
/** @description
|
|
3095
|
-
|
|
3431
|
+
/** @description Free-text query matched against website domain, data points, brand title, and description. Omit for the popular-websites list. */
|
|
3432
|
+
q?: string;
|
|
3096
3433
|
};
|
|
3097
3434
|
header?: never;
|
|
3098
|
-
path
|
|
3099
|
-
providerId: components["schemas"]["ProviderID"];
|
|
3100
|
-
};
|
|
3435
|
+
path?: never;
|
|
3101
3436
|
cookie?: never;
|
|
3102
3437
|
};
|
|
3103
3438
|
requestBody?: never;
|
|
3104
3439
|
responses: {
|
|
3105
|
-
/** @description
|
|
3440
|
+
/** @description Website suggestions. */
|
|
3441
|
+
200: {
|
|
3442
|
+
headers: {
|
|
3443
|
+
[name: string]: unknown;
|
|
3444
|
+
};
|
|
3445
|
+
content: {
|
|
3446
|
+
"application/json": {
|
|
3447
|
+
items: components["schemas"]["WebsiteSuggestion"][];
|
|
3448
|
+
};
|
|
3449
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3450
|
+
};
|
|
3451
|
+
};
|
|
3452
|
+
default: components["responses"]["ProblemResponse"];
|
|
3453
|
+
};
|
|
3454
|
+
};
|
|
3455
|
+
SitePage: {
|
|
3456
|
+
parameters: {
|
|
3457
|
+
query?: {
|
|
3458
|
+
/** @description Case-insensitive substring filter on data-point names. Empty = no filter, so clearing the box doesn't need a client workaround. */
|
|
3459
|
+
q?: string;
|
|
3460
|
+
/** @description Currently selected data-point names — from a deep-link (the provider page's "Use provider") or the form's own htmx round-trips. Repeat to pass several; renders the summary panel and pre-checks the boxes. */
|
|
3461
|
+
dataPoints?: string[];
|
|
3462
|
+
/** @description Resolution mode reflected in the Continue URL. */
|
|
3463
|
+
mode?: "list" | "combine";
|
|
3464
|
+
/** @description Source pins from the form: `pins[<dataPoint>]=id,id`. Maps each data-point name to a comma-joined list of preferred providerIds (empty = Auto). */
|
|
3465
|
+
pins?: {
|
|
3466
|
+
[key: string]: string;
|
|
3467
|
+
};
|
|
3468
|
+
};
|
|
3469
|
+
header?: never;
|
|
3470
|
+
path: {
|
|
3471
|
+
/** @description Website domain (e.g. `github.com`). Normalized server-side (scheme / `www.` / port / path stripped). */
|
|
3472
|
+
domain: string;
|
|
3473
|
+
};
|
|
3474
|
+
cookie?: never;
|
|
3475
|
+
};
|
|
3476
|
+
requestBody?: never;
|
|
3477
|
+
responses: {
|
|
3478
|
+
/** @description The website's provable data points. */
|
|
3479
|
+
200: {
|
|
3480
|
+
headers: {
|
|
3481
|
+
[name: string]: unknown;
|
|
3482
|
+
};
|
|
3483
|
+
content: {
|
|
3484
|
+
"application/json": {
|
|
3485
|
+
/** Format: hostname */
|
|
3486
|
+
domain: string;
|
|
3487
|
+
brandName: string;
|
|
3488
|
+
/** Format: uri */
|
|
3489
|
+
iconUrl?: string;
|
|
3490
|
+
dataPoints: components["schemas"]["DataPointItem"][];
|
|
3491
|
+
};
|
|
3492
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3493
|
+
};
|
|
3494
|
+
};
|
|
3495
|
+
404: components["responses"]["ProblemResponse"];
|
|
3496
|
+
default: components["responses"]["ProblemResponse"];
|
|
3497
|
+
};
|
|
3498
|
+
};
|
|
3499
|
+
SitePanel: {
|
|
3500
|
+
parameters: {
|
|
3501
|
+
query?: {
|
|
3502
|
+
/** @description Selected data-point names. Repeat to pass several. */
|
|
3503
|
+
dataPoints?: string[];
|
|
3504
|
+
/** @description Resolution mode reflected in the Continue URL. */
|
|
3505
|
+
mode?: "list" | "combine";
|
|
3506
|
+
/** @description Source pins from the form: `pins[<dataPoint>]=id,id`. Maps each data-point name to a comma-joined list of preferred providerIds (empty = Auto). */
|
|
3507
|
+
pins?: {
|
|
3508
|
+
[key: string]: string;
|
|
3509
|
+
};
|
|
3510
|
+
/** @description The data-point filter input rides along in the form submit; accepted and ignored here (the panel doesn't filter). */
|
|
3511
|
+
q?: string;
|
|
3512
|
+
};
|
|
3513
|
+
header?: never;
|
|
3514
|
+
path: {
|
|
3515
|
+
/** @description Website domain (normalized server-side). */
|
|
3516
|
+
domain: string;
|
|
3517
|
+
};
|
|
3518
|
+
cookie?: never;
|
|
3519
|
+
};
|
|
3520
|
+
requestBody?: never;
|
|
3521
|
+
responses: {
|
|
3522
|
+
/** @description The summary-panel fragment. */
|
|
3523
|
+
200: {
|
|
3524
|
+
headers: {
|
|
3525
|
+
[name: string]: unknown;
|
|
3526
|
+
};
|
|
3527
|
+
content: {
|
|
3528
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3529
|
+
};
|
|
3530
|
+
};
|
|
3531
|
+
404: components["responses"]["ProblemResponse"];
|
|
3532
|
+
default: components["responses"]["ProblemResponse"];
|
|
3533
|
+
};
|
|
3534
|
+
};
|
|
3535
|
+
SiteBuild: {
|
|
3536
|
+
parameters: {
|
|
3537
|
+
query: {
|
|
3538
|
+
/** @description Selected data-point names. Repeat to pass several. */
|
|
3539
|
+
dataPoints: string[];
|
|
3540
|
+
/** @description `combine` (default) minimizes to the fewest providers (set-cover); `ai` is a forward-compat alias that currently resolves like combine. */
|
|
3541
|
+
mode?: "combine" | "ai";
|
|
3542
|
+
/** @description Source pins: `pins[<dataPoint>]=id,id`. Maps each data-point name to a comma-joined list of preferred providerIds. Omit for Auto. */
|
|
3543
|
+
pins?: {
|
|
3544
|
+
[key: string]: string;
|
|
3545
|
+
};
|
|
3546
|
+
/** @description Data-point names the consumer opts to SUPPLY themselves (as verification `context`) instead of having a provider prove — shrinks the provider set. Repeat to pass several. Only names that are a provider input are honoured. Subset of `dataPoints`. */
|
|
3547
|
+
provided?: string[];
|
|
3548
|
+
/** @description ProviderIds to EXCLUDE from resolution (set after a sandbox Try fails, so a different provider / merge is picked). Repeat to pass several. */
|
|
3549
|
+
exclude?: components["schemas"]["ProviderID"][];
|
|
3550
|
+
};
|
|
3551
|
+
header?: never;
|
|
3552
|
+
path: {
|
|
3553
|
+
/** @description Website domain (normalized server-side). */
|
|
3554
|
+
domain: string;
|
|
3555
|
+
};
|
|
3556
|
+
cookie?: never;
|
|
3557
|
+
};
|
|
3558
|
+
requestBody?: never;
|
|
3559
|
+
responses: {
|
|
3560
|
+
/** @description The build page. */
|
|
3561
|
+
200: {
|
|
3562
|
+
headers: {
|
|
3563
|
+
[name: string]: unknown;
|
|
3564
|
+
};
|
|
3565
|
+
content: {
|
|
3566
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3567
|
+
};
|
|
3568
|
+
};
|
|
3569
|
+
404: components["responses"]["ProblemResponse"];
|
|
3570
|
+
default: components["responses"]["ProblemResponse"];
|
|
3571
|
+
};
|
|
3572
|
+
};
|
|
3573
|
+
SiteBuildTry: {
|
|
3574
|
+
parameters: {
|
|
3575
|
+
query: {
|
|
3576
|
+
/** @description Selected data-point names. Repeat to pass several. */
|
|
3577
|
+
dataPoints: string[];
|
|
3578
|
+
/** @description Resolution mode (`combine` default | `list`). */
|
|
3579
|
+
mode?: "combine" | "ai";
|
|
3580
|
+
/** @description Source pins: `pins[<dataPoint>]=id,id`. Maps each data-point name to a comma-joined list of preferred providerIds. */
|
|
3581
|
+
pins?: {
|
|
3582
|
+
[key: string]: string;
|
|
3583
|
+
};
|
|
3584
|
+
/** @description Data-point names the consumer supplies themselves (as `context`) instead of proving. Repeat to pass several. Subset of `dataPoints`. */
|
|
3585
|
+
provided?: string[];
|
|
3586
|
+
/** @description ProviderIds to exclude from resolution. Repeat to pass several. */
|
|
3587
|
+
exclude?: components["schemas"]["ProviderID"][];
|
|
3588
|
+
};
|
|
3589
|
+
header?: never;
|
|
3590
|
+
path: {
|
|
3591
|
+
/** @description Website domain (normalized server-side). */
|
|
3592
|
+
domain: string;
|
|
3593
|
+
};
|
|
3594
|
+
cookie?: never;
|
|
3595
|
+
};
|
|
3596
|
+
/** @description The verification `context` — values for the resolved providers' requiredContext inputs (the build page's input fields). The selection itself travels in the query string. */
|
|
3597
|
+
requestBody?: {
|
|
3598
|
+
content: {
|
|
3599
|
+
"application/x-www-form-urlencoded": components["schemas"]["SiteBuildTryBody"];
|
|
3600
|
+
"application/json": components["schemas"]["SiteBuildTryBody"];
|
|
3601
|
+
};
|
|
3602
|
+
};
|
|
3603
|
+
responses: {
|
|
3604
|
+
/** @description Session created. */
|
|
3605
|
+
201: {
|
|
3606
|
+
headers: {
|
|
3607
|
+
[name: string]: unknown;
|
|
3608
|
+
};
|
|
3609
|
+
content: {
|
|
3610
|
+
"application/json": components["schemas"]["VerificationSession"];
|
|
3611
|
+
};
|
|
3612
|
+
};
|
|
3613
|
+
401: components["responses"]["ProblemResponse"];
|
|
3614
|
+
/** @description One or more selected data points are not covered by any provider. */
|
|
3615
|
+
422: {
|
|
3616
|
+
headers: {
|
|
3617
|
+
[name: string]: unknown;
|
|
3618
|
+
};
|
|
3619
|
+
content: {
|
|
3620
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
3621
|
+
};
|
|
3622
|
+
};
|
|
3623
|
+
/** @description Sandbox verification quota exceeded. */
|
|
3624
|
+
429: {
|
|
3625
|
+
headers: {
|
|
3626
|
+
[name: string]: unknown;
|
|
3627
|
+
};
|
|
3628
|
+
content: {
|
|
3629
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
3630
|
+
};
|
|
3631
|
+
};
|
|
3632
|
+
default: components["responses"]["ProblemResponse"];
|
|
3633
|
+
};
|
|
3634
|
+
};
|
|
3635
|
+
SiteBuildRepair: {
|
|
3636
|
+
parameters: {
|
|
3637
|
+
query: {
|
|
3638
|
+
/** @description The failing sandbox session whose analytics seed the prompt. */
|
|
3639
|
+
sessionId: components["schemas"]["SessionID"];
|
|
3640
|
+
dataPoints?: string[];
|
|
3641
|
+
mode?: "combine" | "ai";
|
|
3642
|
+
provided?: string[];
|
|
3643
|
+
pins?: {
|
|
3644
|
+
[key: string]: string;
|
|
3645
|
+
};
|
|
3646
|
+
exclude?: components["schemas"]["ProviderID"][];
|
|
3647
|
+
};
|
|
3648
|
+
header?: never;
|
|
3649
|
+
path: {
|
|
3650
|
+
domain: string;
|
|
3651
|
+
};
|
|
3652
|
+
cookie?: never;
|
|
3653
|
+
};
|
|
3654
|
+
requestBody?: never;
|
|
3655
|
+
responses: {
|
|
3656
|
+
/** @description The repair wizard fragment. */
|
|
3657
|
+
200: {
|
|
3658
|
+
headers: {
|
|
3659
|
+
[name: string]: unknown;
|
|
3660
|
+
};
|
|
3661
|
+
content: {
|
|
3662
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3663
|
+
};
|
|
3664
|
+
};
|
|
3665
|
+
default: components["responses"]["ProblemResponse"];
|
|
3666
|
+
};
|
|
3667
|
+
};
|
|
3668
|
+
SiteBuildAlternative: {
|
|
3669
|
+
parameters: {
|
|
3670
|
+
query: {
|
|
3671
|
+
/** @description The failing sandbox session to analyze. */
|
|
3672
|
+
sessionId: components["schemas"]["SessionID"];
|
|
3673
|
+
dataPoints?: string[];
|
|
3674
|
+
mode?: "combine" | "ai";
|
|
3675
|
+
provided?: string[];
|
|
3676
|
+
pins?: {
|
|
3677
|
+
[key: string]: string;
|
|
3678
|
+
};
|
|
3679
|
+
exclude?: components["schemas"]["ProviderID"][];
|
|
3680
|
+
};
|
|
3681
|
+
header?: never;
|
|
3682
|
+
path: {
|
|
3683
|
+
domain: string;
|
|
3684
|
+
};
|
|
3685
|
+
cookie?: never;
|
|
3686
|
+
};
|
|
3687
|
+
requestBody?: never;
|
|
3688
|
+
responses: {
|
|
3689
|
+
/** @description No alternative — a fragment + `openRepair` HX-Trigger. */
|
|
3690
|
+
200: {
|
|
3691
|
+
headers: {
|
|
3692
|
+
[name: string]: unknown;
|
|
3693
|
+
};
|
|
3694
|
+
content: {
|
|
3695
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
3696
|
+
};
|
|
3697
|
+
};
|
|
3698
|
+
/** @description Alternative found — `HX-Redirect` to the build page. */
|
|
3699
|
+
204: {
|
|
3700
|
+
headers: {
|
|
3701
|
+
[name: string]: unknown;
|
|
3702
|
+
};
|
|
3703
|
+
content?: never;
|
|
3704
|
+
};
|
|
3705
|
+
default: components["responses"]["ProblemResponse"];
|
|
3706
|
+
};
|
|
3707
|
+
};
|
|
3708
|
+
DiscoverTeachAgent: {
|
|
3709
|
+
parameters: {
|
|
3710
|
+
query?: {
|
|
3711
|
+
/** @description Website the user wanted to verify data from. */
|
|
3712
|
+
domain?: string;
|
|
3713
|
+
/** @description Specific data point the user could not find. */
|
|
3714
|
+
dataPoint?: string;
|
|
3715
|
+
};
|
|
3716
|
+
header?: never;
|
|
3717
|
+
path?: never;
|
|
3718
|
+
cookie?: never;
|
|
3719
|
+
};
|
|
3720
|
+
requestBody?: never;
|
|
3721
|
+
responses: {
|
|
3722
|
+
200: components["responses"]["HTMLResponse"];
|
|
3723
|
+
default: components["responses"]["ProblemResponse"];
|
|
3724
|
+
};
|
|
3725
|
+
};
|
|
3726
|
+
DiscoverResolve: {
|
|
3727
|
+
parameters: {
|
|
3728
|
+
query: {
|
|
3729
|
+
/** @description Website domain (normalized server-side). */
|
|
3730
|
+
domain: string;
|
|
3731
|
+
/** @description Selected data-point names. Repeat to pass several. */
|
|
3732
|
+
dataPoints: string[];
|
|
3733
|
+
/** @description Resolution mode. `combine` (default) uses the fewest providers; `ai` is a forward-compat alias that resolves like combine for now. */
|
|
3734
|
+
mode?: "combine" | "ai";
|
|
3735
|
+
};
|
|
3736
|
+
header?: never;
|
|
3737
|
+
path?: never;
|
|
3738
|
+
cookie?: never;
|
|
3739
|
+
};
|
|
3740
|
+
requestBody?: never;
|
|
3741
|
+
responses: {
|
|
3742
|
+
/** @description Resolved providers (possibly none). */
|
|
3743
|
+
200: {
|
|
3744
|
+
headers: {
|
|
3745
|
+
[name: string]: unknown;
|
|
3746
|
+
};
|
|
3747
|
+
content: {
|
|
3748
|
+
"application/json": {
|
|
3749
|
+
/** @description The first resolved provider's id, if any — a convenience for the common single-provider case. */
|
|
3750
|
+
providerId?: components["schemas"]["ProviderID"];
|
|
3751
|
+
/** @description True when some selected data point has no provider (see `uncovered`) — a new provider must be authored. */
|
|
3752
|
+
needsCreation: boolean;
|
|
3753
|
+
providers: {
|
|
3754
|
+
providerId: components["schemas"]["ProviderID"];
|
|
3755
|
+
slug: string;
|
|
3756
|
+
/** @description The selected data points this provider covers. */
|
|
3757
|
+
dataPoints: string[];
|
|
3758
|
+
/** @description Recent verification health for this provider (last 30 days). Present only when there is enough history (a minimum number of attempts) to be meaningful; absent for new or rarely-used providers. Used to break ranking ties between providers covering the same data points. */
|
|
3759
|
+
reliability?: {
|
|
3760
|
+
/**
|
|
3761
|
+
* Format: float
|
|
3762
|
+
* @description Fraction of recent sessions that started this provider and completed its claim without failure.
|
|
3763
|
+
*/
|
|
3764
|
+
recentSuccessRate: number;
|
|
3765
|
+
/** @description Number of recent sessions that started this provider (the sample size behind `recentSuccessRate`). */
|
|
3766
|
+
attempts: number;
|
|
3767
|
+
};
|
|
3768
|
+
}[];
|
|
3769
|
+
/** @description Selected data points no existing provider exposes. */
|
|
3770
|
+
uncovered: string[];
|
|
3771
|
+
/** @description Inputs the consumer must supply at verification time (passed as session `context`). Collect these from the user. */
|
|
3772
|
+
requiredContext: {
|
|
3773
|
+
key: string;
|
|
3774
|
+
required: boolean;
|
|
3775
|
+
description?: string;
|
|
3776
|
+
}[];
|
|
3777
|
+
/** @description Whether the resolved providers fuse into one. Informational — `POST /verifications/sessions` already accepts the whole `providers` array. */
|
|
3778
|
+
merge: {
|
|
3779
|
+
mergeable: boolean;
|
|
3780
|
+
/** @description True when merging removes duplicate requests to the same endpoint (saved overfetch). */
|
|
3781
|
+
dedupedSomeRequests?: boolean;
|
|
3782
|
+
};
|
|
3783
|
+
};
|
|
3784
|
+
};
|
|
3785
|
+
};
|
|
3786
|
+
default: components["responses"]["ProblemResponse"];
|
|
3787
|
+
};
|
|
3788
|
+
};
|
|
3789
|
+
DiscoverDataPoints: {
|
|
3790
|
+
parameters: {
|
|
3791
|
+
query: {
|
|
3792
|
+
/** @description Website domain (normalized server-side). */
|
|
3793
|
+
domain: string;
|
|
3794
|
+
/** @description Case-insensitive filter over data-point names. */
|
|
3795
|
+
q?: string;
|
|
3796
|
+
};
|
|
3797
|
+
header?: never;
|
|
3798
|
+
path?: never;
|
|
3799
|
+
cookie?: never;
|
|
3800
|
+
};
|
|
3801
|
+
requestBody?: never;
|
|
3802
|
+
responses: {
|
|
3803
|
+
/** @description Verifiable data points (possibly none). */
|
|
3804
|
+
200: {
|
|
3805
|
+
headers: {
|
|
3806
|
+
[name: string]: unknown;
|
|
3807
|
+
};
|
|
3808
|
+
content: {
|
|
3809
|
+
"application/json": {
|
|
3810
|
+
dataPoints: {
|
|
3811
|
+
name: string;
|
|
3812
|
+
description?: string;
|
|
3813
|
+
providerCount: number;
|
|
3814
|
+
}[];
|
|
3815
|
+
};
|
|
3816
|
+
};
|
|
3817
|
+
};
|
|
3818
|
+
default: components["responses"]["ProblemResponse"];
|
|
3819
|
+
};
|
|
3820
|
+
};
|
|
3821
|
+
ProviderPreviewImage: {
|
|
3822
|
+
parameters: {
|
|
3823
|
+
query?: {
|
|
3824
|
+
/** @description Cache buster. The server includes the current ETag here on the canonical URL; stale values still return the current image but without long cache headers. */
|
|
3825
|
+
v?: string;
|
|
3826
|
+
};
|
|
3827
|
+
header?: never;
|
|
3828
|
+
path: {
|
|
3829
|
+
providerId: components["schemas"]["ProviderID"];
|
|
3830
|
+
};
|
|
3831
|
+
cookie?: never;
|
|
3832
|
+
};
|
|
3833
|
+
requestBody?: never;
|
|
3834
|
+
responses: {
|
|
3835
|
+
/** @description PNG bytes */
|
|
3106
3836
|
200: {
|
|
3107
3837
|
headers: {
|
|
3108
3838
|
"Cache-Control"?: string;
|
|
@@ -3475,6 +4205,27 @@ export interface operations {
|
|
|
3475
4205
|
default: components["responses"]["ProblemResponse"];
|
|
3476
4206
|
};
|
|
3477
4207
|
};
|
|
4208
|
+
DisposeVerificationSession: {
|
|
4209
|
+
parameters: {
|
|
4210
|
+
query?: never;
|
|
4211
|
+
header?: never;
|
|
4212
|
+
path: {
|
|
4213
|
+
sessionId: components["schemas"]["SessionID"];
|
|
4214
|
+
};
|
|
4215
|
+
cookie?: never;
|
|
4216
|
+
};
|
|
4217
|
+
requestBody?: never;
|
|
4218
|
+
responses: {
|
|
4219
|
+
/** @description Dispose requested. */
|
|
4220
|
+
204: {
|
|
4221
|
+
headers: {
|
|
4222
|
+
[name: string]: unknown;
|
|
4223
|
+
};
|
|
4224
|
+
content?: never;
|
|
4225
|
+
};
|
|
4226
|
+
default: components["responses"]["ProblemResponse"];
|
|
4227
|
+
};
|
|
4228
|
+
};
|
|
3478
4229
|
VerificationSessionSse: {
|
|
3479
4230
|
parameters: {
|
|
3480
4231
|
query?: never;
|
|
@@ -3655,31 +4406,6 @@ export interface operations {
|
|
|
3655
4406
|
default: components["responses"]["ProblemResponse"];
|
|
3656
4407
|
};
|
|
3657
4408
|
};
|
|
3658
|
-
UpdateMe: {
|
|
3659
|
-
parameters: {
|
|
3660
|
-
query?: never;
|
|
3661
|
-
header?: never;
|
|
3662
|
-
path?: never;
|
|
3663
|
-
cookie?: never;
|
|
3664
|
-
};
|
|
3665
|
-
requestBody: {
|
|
3666
|
-
content: {
|
|
3667
|
-
"application/json": components["schemas"]["UpdateUserRequest"];
|
|
3668
|
-
};
|
|
3669
|
-
};
|
|
3670
|
-
responses: {
|
|
3671
|
-
/** @description Updated */
|
|
3672
|
-
200: {
|
|
3673
|
-
headers: {
|
|
3674
|
-
[name: string]: unknown;
|
|
3675
|
-
};
|
|
3676
|
-
content: {
|
|
3677
|
-
"application/json": components["schemas"]["User"];
|
|
3678
|
-
};
|
|
3679
|
-
};
|
|
3680
|
-
default: components["responses"]["ProblemResponse"];
|
|
3681
|
-
};
|
|
3682
|
-
};
|
|
3683
4409
|
GetUser: {
|
|
3684
4410
|
parameters: {
|
|
3685
4411
|
query?: never;
|
|
@@ -3759,7 +4485,10 @@ export interface operations {
|
|
|
3759
4485
|
};
|
|
3760
4486
|
GetOrg: {
|
|
3761
4487
|
parameters: {
|
|
3762
|
-
query?:
|
|
4488
|
+
query?: {
|
|
4489
|
+
/** @description Which section to show (server-rendered tab); unknown values fall back to the first. */
|
|
4490
|
+
tab?: "connect" | "providers" | "members" | "themes" | "sessions" | "billing";
|
|
4491
|
+
};
|
|
3763
4492
|
header?: never;
|
|
3764
4493
|
path: {
|
|
3765
4494
|
orgId: components["schemas"]["OrgID"];
|
|
@@ -3832,6 +4561,32 @@ export interface operations {
|
|
|
3832
4561
|
default: components["responses"]["ProblemResponse"];
|
|
3833
4562
|
};
|
|
3834
4563
|
};
|
|
4564
|
+
SearchOrgMembers: {
|
|
4565
|
+
parameters: {
|
|
4566
|
+
query?: {
|
|
4567
|
+
/** @description Case-insensitive email substring to filter by. */
|
|
4568
|
+
q?: string;
|
|
4569
|
+
};
|
|
4570
|
+
header?: never;
|
|
4571
|
+
path: {
|
|
4572
|
+
orgId: components["schemas"]["OrgID"];
|
|
4573
|
+
};
|
|
4574
|
+
cookie?: never;
|
|
4575
|
+
};
|
|
4576
|
+
requestBody?: never;
|
|
4577
|
+
responses: {
|
|
4578
|
+
/** @description The members-list fragment. */
|
|
4579
|
+
200: {
|
|
4580
|
+
headers: {
|
|
4581
|
+
[name: string]: unknown;
|
|
4582
|
+
};
|
|
4583
|
+
content: {
|
|
4584
|
+
"text/html": components["schemas"]["HtmlContent"];
|
|
4585
|
+
};
|
|
4586
|
+
};
|
|
4587
|
+
default: components["responses"]["ProblemResponse"];
|
|
4588
|
+
};
|
|
4589
|
+
};
|
|
3835
4590
|
AddOrgMember: {
|
|
3836
4591
|
parameters: {
|
|
3837
4592
|
query?: never;
|
|
@@ -4105,7 +4860,7 @@ export interface operations {
|
|
|
4105
4860
|
default: components["responses"]["ProblemResponse"];
|
|
4106
4861
|
};
|
|
4107
4862
|
};
|
|
4108
|
-
|
|
4863
|
+
GetOrgKeypair: {
|
|
4109
4864
|
parameters: {
|
|
4110
4865
|
query?: never;
|
|
4111
4866
|
header?: never;
|
|
@@ -4122,7 +4877,7 @@ export interface operations {
|
|
|
4122
4877
|
[name: string]: unknown;
|
|
4123
4878
|
};
|
|
4124
4879
|
content: {
|
|
4125
|
-
"application/json": components["schemas"]["
|
|
4880
|
+
"application/json": components["schemas"]["OrgKeypair"];
|
|
4126
4881
|
};
|
|
4127
4882
|
};
|
|
4128
4883
|
403: components["responses"]["ForbiddenResponse"];
|
|
@@ -4130,7 +4885,7 @@ export interface operations {
|
|
|
4130
4885
|
default: components["responses"]["ProblemResponse"];
|
|
4131
4886
|
};
|
|
4132
4887
|
};
|
|
4133
|
-
|
|
4888
|
+
SetOrgKeypair: {
|
|
4134
4889
|
parameters: {
|
|
4135
4890
|
query?: never;
|
|
4136
4891
|
header?: never;
|
|
@@ -4141,7 +4896,7 @@ export interface operations {
|
|
|
4141
4896
|
};
|
|
4142
4897
|
requestBody: {
|
|
4143
4898
|
content: {
|
|
4144
|
-
"application/json": components["schemas"]["
|
|
4899
|
+
"application/json": components["schemas"]["OrgKeypairRequest"];
|
|
4145
4900
|
};
|
|
4146
4901
|
};
|
|
4147
4902
|
responses: {
|
|
@@ -4151,7 +4906,7 @@ export interface operations {
|
|
|
4151
4906
|
[name: string]: unknown;
|
|
4152
4907
|
};
|
|
4153
4908
|
content: {
|
|
4154
|
-
"application/json": components["schemas"]["
|
|
4909
|
+
"application/json": components["schemas"]["OrgKeypair"];
|
|
4155
4910
|
};
|
|
4156
4911
|
};
|
|
4157
4912
|
400: components["responses"]["ProblemResponse"];
|
|
@@ -4159,7 +4914,7 @@ export interface operations {
|
|
|
4159
4914
|
default: components["responses"]["ProblemResponse"];
|
|
4160
4915
|
};
|
|
4161
4916
|
};
|
|
4162
|
-
|
|
4917
|
+
DeleteOrgKeypair: {
|
|
4163
4918
|
parameters: {
|
|
4164
4919
|
query?: never;
|
|
4165
4920
|
header?: never;
|
|
@@ -4380,6 +5135,29 @@ export interface operations {
|
|
|
4380
5135
|
default: components["responses"]["ProblemResponse"];
|
|
4381
5136
|
};
|
|
4382
5137
|
};
|
|
5138
|
+
AttachLanding: {
|
|
5139
|
+
parameters: {
|
|
5140
|
+
query?: {
|
|
5141
|
+
/** @description A submitted pairing code; redirects to `/attach/{code}`. */
|
|
5142
|
+
code?: string;
|
|
5143
|
+
};
|
|
5144
|
+
header?: never;
|
|
5145
|
+
path?: never;
|
|
5146
|
+
cookie?: never;
|
|
5147
|
+
};
|
|
5148
|
+
requestBody?: never;
|
|
5149
|
+
responses: {
|
|
5150
|
+
200: components["responses"]["HTMLResponse"];
|
|
5151
|
+
/** @description Redirect to the canonical `/attach/{code}` URL. */
|
|
5152
|
+
302: {
|
|
5153
|
+
headers: {
|
|
5154
|
+
[name: string]: unknown;
|
|
5155
|
+
};
|
|
5156
|
+
content?: never;
|
|
5157
|
+
};
|
|
5158
|
+
default: components["responses"]["ProblemResponse"];
|
|
5159
|
+
};
|
|
5160
|
+
};
|
|
4383
5161
|
AttachPage: {
|
|
4384
5162
|
parameters: {
|
|
4385
5163
|
query?: never;
|
|
@@ -5237,9 +6015,18 @@ export interface operations {
|
|
|
5237
6015
|
};
|
|
5238
6016
|
content: {
|
|
5239
6017
|
"application/json": {
|
|
5240
|
-
|
|
5241
|
-
|
|
5242
|
-
|
|
6018
|
+
/** @description One recipe per session provider, in run order. */
|
|
6019
|
+
recipes: {
|
|
6020
|
+
providerId: components["schemas"]["ProviderID"];
|
|
6021
|
+
resolvedVersion: string;
|
|
6022
|
+
initialUrl: string;
|
|
6023
|
+
/** @description The version's webSettings geoLocation template (`{{DYNAMIC_GEO}}` / '' / ISO code), applied to this provider's requests. */
|
|
6024
|
+
geoLocation?: string;
|
|
6025
|
+
/** @description The version's webSettings.jsUserScripts — page JavaScript the Verification Client installs to run before every page load (before navigating to initialUrl), to drive login/navigation so the target requests fire. */
|
|
6026
|
+
jsUserScripts?: string;
|
|
6027
|
+
requests: {
|
|
6028
|
+
[key: string]: unknown;
|
|
6029
|
+
}[];
|
|
5243
6030
|
}[];
|
|
5244
6031
|
};
|
|
5245
6032
|
};
|
|
@@ -5383,7 +6170,7 @@ export interface operations {
|
|
|
5383
6170
|
/** Format: uuid */
|
|
5384
6171
|
subscriptionId: string;
|
|
5385
6172
|
event: components["schemas"]["VerificationEvent"];
|
|
5386
|
-
/** @description The result payload, as raw text
|
|
6173
|
+
/** @description The result payload, as raw text: an ECIES ciphertext (base64url) wrapping the signed result JWS when the org's `canEncryptResult` is enabled, else the plaintext signed JWS JSON. */
|
|
5387
6174
|
payload: string;
|
|
5388
6175
|
deliveryStatus: components["schemas"]["CallbackDeliveryStatus"];
|
|
5389
6176
|
createdAt: components["schemas"]["Timestamp"];
|