@procivis/react-native-one-core 1.95657.0 → 1.101239.0

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.
@@ -21,6 +21,7 @@ export interface CertificateDetail {
21
21
  chain: string;
22
22
  key?: KeyListItem;
23
23
  x509Attributes: CertificateX509Attributes;
24
+ roles: Array<CertificateRole>;
24
25
  }
25
26
  export interface CertificateX509Attributes {
26
27
  serialNumber: string;
@@ -57,28 +58,50 @@ export interface ClaimSchema {
57
58
  claims: Array<ClaimSchema>;
58
59
  }
59
60
  export interface Config {
61
+ /** Credential formats. */
60
62
  format: Record<string, string>;
63
+ /** Protocols used for issuance. */
61
64
  issuanceProtocol: Record<string, string>;
65
+ /** Protocols used for presentation and verification. */
62
66
  verificationProtocol: Record<string, string>;
67
+ /** Protocols used for communicating. */
63
68
  transport: Record<string, string>;
69
+ /** Methods for managing credential status. */
64
70
  revocation: Record<string, string>;
71
+ /** DID methods for identifying agents. */
65
72
  did: Record<string, string>;
73
+ /** Identifier types for representing agent's identities. */
66
74
  identifier: Record<string, string>;
75
+ /** Data types for validation. */
67
76
  datatype: Record<string, string>;
77
+ /** Key algorithms used for signatures. */
68
78
  keyAlgorithm: Record<string, string>;
79
+ /** Storage options for keys. */
69
80
  keyStorage: Record<string, string>;
81
+ /** Trust management solutions. */
70
82
  trustManagement: Record<string, string>;
83
+ /** Entities held in temporary storage. */
71
84
  cacheEntities: Record<string, string>;
85
+ /** Tasks which can be run via the `runTask` method. */
72
86
  task: Record<string, string>;
87
+ /** Configuration for wallet-initiated issuance flows. */
73
88
  credentialIssuer: Record<string, string>;
89
+ /**
90
+ * Configurations from the Wallet Provider, including version
91
+ * management, trust collections, and feature flags.
92
+ */
74
93
  walletProvider: Record<string, string>;
75
94
  }
76
95
  export interface ContinueIssuanceResponse {
77
96
  /** For reference. */
78
97
  interactionId: string;
98
+ /** Key storage required to complete issuance. */
79
99
  keyStorageSecurityLevels?: Array<KeyStorageSecurity>;
100
+ /** Key algorithms suitable for issuance. */
80
101
  keyAlgorithms?: Array<string>;
102
+ /** Whether a valid WIA is required to complete issuance. */
81
103
  requiresWalletInstanceAttestation: boolean;
104
+ /** Protocol used for issuance. */
82
105
  protocol: string;
83
106
  }
84
107
  export interface CreateCertificateAuthorityRequest {
@@ -91,6 +114,7 @@ export interface CreateCertificateRequest {
91
114
  name?: string;
92
115
  chain: string;
93
116
  keyId: string;
117
+ roles: Array<CertificateRole>;
94
118
  }
95
119
  export interface CreateDidRequest {
96
120
  organisationId: string;
@@ -117,10 +141,16 @@ export interface CreateIdentifierRequest {
117
141
  did?: CreateIdentifierDidRequest;
118
142
  certificates?: Array<CreateCertificateRequest>;
119
143
  certificateAuthorities?: Array<CreateCertificateAuthorityRequest>;
144
+ trustInformation: Array<CreateIdentifierTrustInformationRequest>;
145
+ }
146
+ export interface CreateIdentifierTrustInformationRequest {
147
+ data: string;
148
+ type: IdentifierTrustInformationType;
120
149
  }
121
150
  export interface CreateOrganisationRequest {
151
+ /** If no UUID is passed, one will be created. */
122
152
  id?: string;
123
- name?: string;
153
+ parentOrganisation?: string;
124
154
  }
125
155
  /**
126
156
  * If protocol is `ISO_MDL`, specify the device engagement type
@@ -130,16 +160,47 @@ export interface CreateOrganisationRequest {
130
160
  * `nfc_read_iso_mdl_engagement`.
131
161
  */
132
162
  export interface CreateProofRequest {
163
+ /** Choose a proof schema to use. */
133
164
  proofSchemaId: string;
165
+ /** Deprecated. Use `verifierIdentifierId`. */
134
166
  verifierDidId?: string;
167
+ /** Choose the identifier to use to make the request. */
135
168
  verifierIdentifierId?: string;
169
+ /**
170
+ * Choose the protocol to use for verification. Check the
171
+ * `verificationProtocol` object of your configuration for
172
+ * supported options and reference the configuration instance.
173
+ */
136
174
  protocol: string;
175
+ /**
176
+ * When a shared proof is accepted, the wallet will be redirected
177
+ * to the resource specified here, if redirects are enabled in the
178
+ * configuration. The URI must use a scheme that is allowed by the
179
+ * configuration.
180
+ */
137
181
  redirectUri?: string;
182
+ /**
183
+ * If the identifier contains multiple keys, use this to specify
184
+ * which key to use. If omitted, the first suitable key is used.
185
+ */
138
186
  verifierKey?: string;
187
+ /**
188
+ * If the identifier contains multiple certificates, use this to
189
+ * specify which key to use. If omitted, the first suitable
190
+ * certificate is used.
191
+ */
139
192
  verifierCertificate?: string;
193
+ /** Use to specify device engagement type. */
140
194
  isoMdlEngagement?: string;
195
+ /**
196
+ * Choose the transport protocol for the exchange. Check the
197
+ * `transport` object of your configuration for supported
198
+ * options and reference the configuration instance.
199
+ */
141
200
  transport?: Array<string>;
201
+ /** Country profile to associate with this request. */
142
202
  profile?: string;
203
+ /** Use for ISO mDL verification over BLE. */
143
204
  engagement?: string;
144
205
  }
145
206
  export interface CreateProofSchemaInput {
@@ -154,6 +215,7 @@ export interface CreateProofSchemaRequest {
154
215
  name: string;
155
216
  organisationId: string;
156
217
  expireDuration: number;
218
+ /** Set of all claims to request. */
157
219
  proofInputSchemas: Array<CreateProofSchemaInput>;
158
220
  }
159
221
  export interface CreateRemoteTrustEntityRequest {
@@ -211,16 +273,30 @@ export interface CredentialDetail {
211
273
  issuanceDate?: string;
212
274
  lastModified: string;
213
275
  revocationDate?: string;
276
+ /** Credential issuer metadata. */
214
277
  issuer?: IdentifierListItem;
278
+ /** Credential holder metadata. */
215
279
  holder?: IdentifierListItem;
280
+ /** State representation of the credential in the system. */
216
281
  state: CredentialState;
282
+ /** Schema of the credential. */
217
283
  schema: CredentialSchemaListItem;
218
284
  claims: Array<Claim>;
219
285
  redirectUri?: string;
286
+ /**
287
+ * The role the system has in relation to the credential. For example,
288
+ * if the system received the credential as a wallet this value will
289
+ * be `HOLDER`. If the system verified this credential during a presentation,
290
+ * this value will be `VERIFIER`.
291
+ */
220
292
  role: CredentialRole;
293
+ /** Scheduled date for credential reactivation. */
221
294
  suspendEndDate?: string;
295
+ /** Validity details for ISO mdocs. */
222
296
  mdocMsoValidity?: MdocMsoValidity;
297
+ /** Protocol used to issue the credential. */
223
298
  protocol: string;
299
+ /** Country profile associated with the credential. */
224
300
  profile?: string;
225
301
  }
226
302
  export interface CredentialList {
@@ -234,37 +310,105 @@ export interface CredentialListItem {
234
310
  issuanceDate?: string;
235
311
  lastModified: string;
236
312
  revocationDate?: string;
313
+ /** Credential issuer metadata. */
237
314
  issuer?: string;
315
+ /** State representation of the credential in the system. */
238
316
  state: CredentialState;
317
+ /** Schema of the credential. */
239
318
  schema: CredentialSchemaListItem;
319
+ /**
320
+ * The role the system has in relation to the credential. For example,
321
+ * if the system received the credential as a wallet this value will
322
+ * be `HOLDER`. If the system verified this credential during a presentation,
323
+ * this value will be `VERIFIER`.
324
+ */
240
325
  role: CredentialRole;
326
+ /** Scheduled date for credential reactivation. */
241
327
  suspendEndDate?: string;
328
+ /** Protocol used to issue the credential. */
242
329
  protocol: string;
330
+ /** Country profile associated with the credential. */
243
331
  profile?: string;
244
332
  }
245
333
  export interface CredentialListQuery {
334
+ /** Page number to retrieve (0-based indexing). */
246
335
  page: number;
336
+ /** Number of items to return per page. */
247
337
  pageSize: number;
338
+ /** Field value to sort results by. */
248
339
  sort?: SortableCredentialColumn;
340
+ /** Direction to sort results by. */
249
341
  sortDirection?: SortDirection;
342
+ /** Specifies the organizational context for this operation. */
250
343
  organisationId: string;
344
+ /** Return only credentials with a name starting with this string. */
251
345
  name?: string;
346
+ /** Filter by one or more country profiles. */
252
347
  profiles?: Array<string>;
348
+ /** Search for a string. */
253
349
  searchText?: string;
350
+ /**
351
+ * Changes where `searchText` is searched. Choose one or more
352
+ * `searchType`s and pass a `searchText`.
353
+ */
254
354
  searchType?: Array<CredentialListQuerySearchType>;
355
+ /** Set which filters apply in an exact way. */
255
356
  exact?: Array<CredentialListQueryExactColumn>;
357
+ /**
358
+ * Filter credentials by one or more roles: issued by the system,
359
+ * verified by the system, or held by the system as a wallet.
360
+ */
256
361
  roles?: Array<CredentialRole>;
362
+ /** Filter by one or more UUIDs. */
257
363
  ids?: Array<string>;
364
+ /** Filter by one or more credential states. */
258
365
  states?: Array<CredentialState>;
366
+ /**
367
+ * Additional fields to include in response objects. Omitting
368
+ * this keeps responses shorter.
369
+ */
259
370
  include?: Array<CredentialListIncludeEntityType>;
371
+ /** Return only credentials with the specified credential schema(s). */
260
372
  credentialSchemaIds?: Array<string>;
373
+ /**
374
+ * Return only credentials created after this time. Timestamp in
375
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
376
+ */
261
377
  createdDateAfter?: string;
378
+ /**
379
+ * Return only credentials created before this time. Timestamp in
380
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
381
+ */
262
382
  createdDateBefore?: string;
383
+ /**
384
+ * Return only credentials last modified after this time. Timestamp in
385
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
386
+ */
263
387
  lastModifiedAfter?: string;
388
+ /**
389
+ * Return only credentials last modified before this time. Timestamp in
390
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
391
+ */
264
392
  lastModifiedBefore?: string;
393
+ /**
394
+ * Return only credentials issued after this time. Timestamp in
395
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
396
+ */
265
397
  issuanceDateAfter?: string;
398
+ /**
399
+ * Return only credentials issued before this time. Timestamp in
400
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
401
+ */
266
402
  issuanceDateBefore?: string;
403
+ /**
404
+ * Return only credentials revoked after this time. Timestamp in
405
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
406
+ */
267
407
  revocationDateAfter?: string;
408
+ /**
409
+ * Return only credentials revoked before this time. Timestamp in
410
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
411
+ */
268
412
  revocationDateBefore?: string;
269
413
  }
270
414
  export interface CredentialQuery {
@@ -439,11 +583,47 @@ export interface ErrorResponse {
439
583
  message: string;
440
584
  cause?: Cause;
441
585
  }
586
+ export interface EudiIntermediary {
587
+ name?: string;
588
+ identifier: string;
589
+ website: string;
590
+ email?: string;
591
+ phone?: string;
592
+ country: string;
593
+ }
594
+ export interface EudiSupervisoryAuthority {
595
+ email: string;
596
+ phone: string;
597
+ uri: string;
598
+ }
599
+ export interface EudiTrustInformation {
600
+ name: string;
601
+ website: string;
602
+ email?: string;
603
+ phone?: string;
604
+ country: string;
605
+ identifier: string;
606
+ serviceDescription: Array<Record<string, string>>;
607
+ supervisoryAuthority: EudiSupervisoryAuthority;
608
+ intermediary?: EudiIntermediary;
609
+ isPublicSector: boolean;
610
+ }
442
611
  export interface GenerateKeyRequest {
612
+ /** Specifies the organizational context of this operation. */
443
613
  organisationId: string;
614
+ /**
615
+ * Choose which key algorithm to use to create the key pair. Check
616
+ * `keyAlgorithm` of your configuration for supported options and
617
+ * reference the configured instance.
618
+ */
444
619
  keyType: string;
445
620
  keyParams: Record<string, string>;
621
+ /** Internal label for created key pair. */
446
622
  name: string;
623
+ /**
624
+ * Choose how to store the key. Check `keyStorage` of your configuration
625
+ * for supported options and reference the configured instance.
626
+ */
447
627
  storageType: string;
448
628
  storageParams: Record<string, string>;
449
629
  }
@@ -457,6 +637,7 @@ export interface HandleInvitationRequest {
457
637
  * verifier. For example: "https://example.com/credential-offer".
458
638
  */
459
639
  url: string;
640
+ /** Specifies the organizational context for this operation. */
460
641
  organisationId: string;
461
642
  /**
462
643
  * For configurations with multiple transport protocols enabled you
@@ -494,19 +675,45 @@ export interface HistoryListItem {
494
675
  user?: string;
495
676
  }
496
677
  export interface HistoryListQuery {
678
+ /** Page number to retrieve (0-based indexing). */
497
679
  page: number;
680
+ /** Number of items to return per page. */
498
681
  pageSize: number;
682
+ /** Field value to sort results by. */
683
+ sort?: SortableHistoryColumn;
684
+ /** Direction to sort results by. */
685
+ sortDirection?: SortDirection;
686
+ /** Specifies the organizational context for this operation. */
499
687
  organisationId: string;
688
+ /** Return only events associated with the provided entity IDs. */
500
689
  entityIds?: Array<string>;
690
+ /** Return only events associated with the provided entity types. */
501
691
  entityTypes?: Array<HistoryEntityType>;
692
+ /** Return only the provided events. */
502
693
  actions?: Array<HistoryAction>;
694
+ /**
695
+ * Return only entries created after this time. Timestamp in
696
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
697
+ */
503
698
  createdDateAfter?: string;
699
+ /**
700
+ * Return only entries created before this time. Timestamp in
701
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
702
+ */
504
703
  createdDateBefore?: string;
704
+ /** Return only events associated with the provided identifier ID. */
505
705
  identifierId?: string;
706
+ /** Return only events associated with the provided credential ID. */
506
707
  credentialId?: string;
708
+ /** Return only events associated with the provided credential schema ID. */
507
709
  credentialSchemaId?: string;
710
+ /** Return only events associated with the provided proof ID. */
711
+ proofId?: string;
712
+ /** Return only events associated with the provided proof schema ID. */
508
713
  proofSchemaId?: string;
714
+ /** Search for a string. */
509
715
  search?: HistorySearch;
716
+ /** Return only events associated with the provided user(s). */
510
717
  users?: Array<string>;
511
718
  }
512
719
  export interface HistorySearch {
@@ -514,16 +721,24 @@ export interface HistorySearch {
514
721
  type?: HistorySearchType;
515
722
  }
516
723
  export interface HolderAcceptCredentialRequest {
724
+ /** ID for this issuance. */
517
725
  interactionId: string;
726
+ /** Deprecated. Use `identifierId`. */
518
727
  didId?: string;
519
728
  identifierId?: string;
729
+ /**
730
+ * If you are using an identifier with multiple keys for authentication,
731
+ * specify which key to use. If no key is specified, the first suitable
732
+ * key listed will be used.
733
+ */
520
734
  keyId?: string;
735
+ /** User-provided transaction code. */
521
736
  txCode?: string;
522
- holderWalletUnitId?: string;
523
737
  }
524
738
  export interface HolderRegisterWalletUnitRequest {
739
+ /** The wallet unit's organization. */
525
740
  organisationId: string;
526
- /** Reference the `walletProvider` configuration of the Wallet Provider. */
741
+ /** Reference the `walletProvider` configuration. */
527
742
  walletProvider: WalletProvider;
528
743
  keyType: string;
529
744
  }
@@ -557,6 +772,7 @@ export interface IdentifierDetail {
557
772
  did?: DidDetail;
558
773
  key?: KeyDetail;
559
774
  certificates?: Array<CertificateDetail>;
775
+ trustInformation: Array<IdentifierTrustInformationResponseDto>;
560
776
  }
561
777
  export interface IdentifierList {
562
778
  values: Array<IdentifierListItem>;
@@ -579,6 +795,7 @@ export interface IdentifierListQuery {
579
795
  sort?: SortableIdentifierColumn;
580
796
  sortDirection?: SortDirection;
581
797
  organisationId: string;
798
+ ids?: Array<string>;
582
799
  name?: string;
583
800
  types?: Array<IdentifierType>;
584
801
  states?: Array<IdentifierState>;
@@ -588,11 +805,21 @@ export interface IdentifierListQuery {
588
805
  keyAlgorithms?: Array<string>;
589
806
  keyRoles?: Array<KeyRole>;
590
807
  keyStorages?: Array<string>;
808
+ certificateRoles?: Array<CertificateRole>;
809
+ certificateRolesMatchMode?: CertificateRolesMatchMode;
810
+ trustIssuanceSchemaId?: string;
811
+ trustVerificationSchemaId?: string;
591
812
  createdDateAfter?: string;
592
813
  createdDateBefore?: string;
593
814
  lastModifiedAfter?: string;
594
815
  lastModifiedBefore?: string;
595
816
  }
817
+ export interface IdentifierTrustInformationResponseDto {
818
+ data: string;
819
+ type: IdentifierTrustInformationType;
820
+ validFrom?: string;
821
+ validTo?: string;
822
+ }
596
823
  export interface ImportCredentialSchemaClaimSchema {
597
824
  id: string;
598
825
  createdDate: string;
@@ -643,9 +870,17 @@ export interface ImportProofSchema {
643
870
  createdDate: string;
644
871
  lastModified: string;
645
872
  name: string;
873
+ /** Specifies the organizational context for this operation. */
646
874
  organisationId: string;
875
+ /**
876
+ * Defines how long the system will store data received from wallets. After
877
+ * the defined duration, the received proof and its data are deleted from
878
+ * the system. If 0, proofs received when using this schema will not be
879
+ * deleted.
880
+ */
647
881
  expireDuration: number;
648
882
  importedSourceUrl: string;
883
+ /** Set of all claims to request. */
649
884
  proofInputSchemas: Array<ImportProofSchemaInputSchema>;
650
885
  }
651
886
  export interface ImportProofSchemaClaimSchema {
@@ -682,8 +917,11 @@ export interface ImportProofSchemaRequest {
682
917
  organisationId: string;
683
918
  }
684
919
  export interface InitParams {
920
+ /** Pass a serialized JSON to override the default configuration. */
685
921
  configJson?: string;
922
+ /** Create an instance of the native implementation of Secure Element and pass it here. */
686
923
  nativeSecureElement?: NativeKeyStorage;
924
+ /** Create a custom implementation of HSM and pass it. */
687
925
  remoteSecureElement?: NativeKeyStorage;
688
926
  bleCentral?: BleCentral;
689
927
  blePeripheral?: BlePeripheral;
@@ -695,12 +933,19 @@ export interface InitiateIssuanceAuthorizationDetail {
695
933
  credentialConfigurationId: string;
696
934
  }
697
935
  export interface InitiateIssuanceRequest {
936
+ /** Specifies the organizational context for this operation. */
698
937
  organisationId: string;
938
+ /** Choose a protocol to complete issuance. */
699
939
  protocol: string;
940
+ /** OpenID4VCI authorization request parameter. */
700
941
  issuer: string;
942
+ /** OpenID4VCI authorization request parameter. */
701
943
  clientId: string;
944
+ /** OpenID4VCI authorization request parameter. */
702
945
  redirectUri?: string;
946
+ /** OpenID4VCI authorization request parameter. */
703
947
  scope?: Array<string>;
948
+ /** OpenID4VCI authorization request parameter. */
704
949
  authorizationDetails?: Array<InitiateIssuanceAuthorizationDetail>;
705
950
  }
706
951
  export interface InitiateIssuanceResponse {
@@ -735,15 +980,25 @@ export interface Metadata {
735
980
  dbHash: string;
736
981
  createdAt: string;
737
982
  }
738
- /** Optional messages to be displayed on (iOS) system overlay */
983
+ export interface MultiLangString {
984
+ lang: string;
985
+ value: string;
986
+ }
987
+ /** Optional messages to be displayed on (iOS) system overlay. */
739
988
  export interface NfcScanRequest {
740
989
  inProgressMessage?: string;
741
990
  failureMessage?: string;
742
991
  successMessage?: string;
743
992
  }
744
993
  export interface OpenId4vciTxCode {
994
+ /** For validation. */
745
995
  inputMode: OpenId4vciTxCodeInputMode;
996
+ /** Character length of code, to assist the user. */
746
997
  length?: number;
998
+ /**
999
+ * Guidance text displayed in the wallet, describing how to
1000
+ * obtain the transaction code.
1001
+ */
747
1002
  description?: string;
748
1003
  }
749
1004
  export interface PeripheralDiscoveryData {
@@ -816,11 +1071,19 @@ export interface PresentationDefinitionV2Credential {
816
1071
  profile?: string;
817
1072
  }
818
1073
  export interface PresentationSubmitCredentialRequest {
1074
+ /** ID of the credential to submit. */
819
1075
  credentialId: string;
820
1076
  submitClaims: Array<string>;
821
1077
  }
822
1078
  export interface PresentationSubmitV2CredentialRequest {
1079
+ /** ID of the credential to submit. */
823
1080
  credentialId: string;
1081
+ /**
1082
+ * Array of claim paths for claims where `userSelection: true` that the
1083
+ * holder chooses to share. Only include paths for optional claims the
1084
+ * holder selects. Omit entirely or use an empty array if withholding all
1085
+ * optional claims.
1086
+ */
824
1087
  userSelections: Array<string>;
825
1088
  }
826
1089
  export interface ProofClaim {
@@ -840,24 +1103,47 @@ export interface ProofDetail {
840
1103
  id: string;
841
1104
  createdDate: string;
842
1105
  lastModified: string;
1106
+ /** Identifier of the verifier of this request. */
843
1107
  verifier?: IdentifierListItem;
844
1108
  state: ProofState;
1109
+ /** The role the system has in relation to this request. */
845
1110
  role: ProofRole;
1111
+ /** Schema used for this request. */
846
1112
  proofSchema?: ProofSchemaListItem;
1113
+ /** Protocol used for verification. */
847
1114
  protocol: string;
1115
+ /** Engagement method used for this request. */
848
1116
  engagement?: string;
1117
+ /** Channel used for this request. */
849
1118
  transport: string;
1119
+ /**
1120
+ * The wallet is redirected to this resource once a shared proof
1121
+ * is accepted.
1122
+ */
850
1123
  redirectUri?: string;
1124
+ /** Credential and claim data shared by the wallet holder. */
851
1125
  proofInputs: Array<ProofInput>;
1126
+ /**
1127
+ * Time at which the data shared by the wallet holder for this request
1128
+ * will be deleted. Determined by the `expireDuration` parameter of the
1129
+ * proof schema.
1130
+ */
852
1131
  retainUntilDate?: string;
1132
+ /** When the request was shared with the wallet holder. */
853
1133
  requestedDate?: string;
1134
+ /** When the wallet holder submitted valid proof. */
854
1135
  completedDate?: string;
1136
+ /** When claim data was deleted. */
855
1137
  claimsRemovedAt?: string;
1138
+ /** Country profile associated with this request. */
856
1139
  profile?: string;
857
1140
  }
858
1141
  export interface ProofInput {
1142
+ /** Set of claims asserted by the shared credential. */
859
1143
  claims: Array<ProofClaim>;
1144
+ /** Shared credential metadata. */
860
1145
  credential?: CredentialDetail;
1146
+ /** Credential schema metadata. */
861
1147
  credentialSchema: CredentialSchemaListItem;
862
1148
  }
863
1149
  export interface ProofInputSchema {
@@ -874,37 +1160,96 @@ export interface ProofListItem {
874
1160
  createdDate: string;
875
1161
  lastModified: string;
876
1162
  requestedDate?: string;
1163
+ /** When the wallet holder submitted valid proof. */
877
1164
  completedDate?: string;
878
1165
  verifier?: string;
1166
+ /** Protocol used for verification. */
879
1167
  protocol: string;
1168
+ /** Channel used for this request. */
880
1169
  transport: string;
1170
+ /** Engagement method used for this request. */
881
1171
  engagement?: string;
1172
+ /** State representation of this request. */
882
1173
  state: ProofState;
1174
+ /** The role the system has in relation to this request. */
883
1175
  role: ProofRole;
884
1176
  schema?: ProofSchemaListItem;
1177
+ /**
1178
+ * Time at which the data shared by the wallet holder for this request
1179
+ * will be deleted. Determined by the `expireDuration` parameter of the
1180
+ * proof schema.
1181
+ */
885
1182
  retainUntilDate?: string;
1183
+ /** Country profile associated with this request. */
886
1184
  profile?: string;
887
1185
  }
888
1186
  export interface ProofListQuery {
1187
+ /** Page number to retrieve (0-based indexing). */
889
1188
  page: number;
1189
+ /** Number of items to return per page. */
890
1190
  pageSize: number;
1191
+ /** Specifies the organizational context for this operation. */
891
1192
  organisationId: string;
1193
+ /** Field value to sort results by. */
892
1194
  sort?: SortableProofColumn;
1195
+ /** Direction to sort results by. */
893
1196
  sortDirection?: SortDirection;
1197
+ /** Return only proof requests with a name starting with this string. */
894
1198
  name?: string;
1199
+ /** Filter by one or more country profiles. */
895
1200
  profiles?: Array<string>;
1201
+ /** Filter by one or more UUIDs. */
896
1202
  ids?: Array<string>;
1203
+ /** Filter by one or more proof request states. */
897
1204
  proofStates?: Array<ProofState>;
1205
+ /**
1206
+ * Filter proof requests by one or more roles: requested by the
1207
+ * system (`VERIFIER`) or received by the system (`HOLDER`).
1208
+ */
898
1209
  proofRoles?: Array<ProofRole>;
1210
+ /** Filter by associated proof schemas. */
899
1211
  proofSchemaIds?: Array<string>;
1212
+ /** Set which filters apply in an exact way. */
900
1213
  exact?: Array<ProofListQueryExactColumn>;
1214
+ /**
1215
+ * Return only proof requests created after this time. Timestamp in
1216
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1217
+ */
901
1218
  createdDateAfter?: string;
1219
+ /**
1220
+ * Return only proof requests created before this time. Timestamp in
1221
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1222
+ */
902
1223
  createdDateBefore?: string;
1224
+ /**
1225
+ * Return only proof requests last modified after this time. Timestamp in
1226
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1227
+ */
903
1228
  lastModifiedAfter?: string;
1229
+ /**
1230
+ * Return only proof requests last modified before this time. Timestamp in
1231
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1232
+ */
904
1233
  lastModifiedBefore?: string;
1234
+ /**
1235
+ * Return only proofs requested after this time. Timestamp in
1236
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1237
+ */
905
1238
  requestedDateAfter?: string;
1239
+ /**
1240
+ * Return only proofs requested before this time. Timestamp in
1241
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1242
+ */
906
1243
  requestedDateBefore?: string;
1244
+ /**
1245
+ * Return only proofs requested completed after this time. Timestamp in
1246
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1247
+ */
907
1248
  completedDateAfter?: string;
1249
+ /**
1250
+ * Return only proofs requested completed before this time. Timestamp in
1251
+ * RFC 3339 format (for example `2023-06-09T14:19:57.000Z`).
1252
+ */
908
1253
  completedDateBefore?: string;
909
1254
  }
910
1255
  export interface ProofSchemaDetail {
@@ -912,9 +1257,18 @@ export interface ProofSchemaDetail {
912
1257
  createdDate: string;
913
1258
  lastModified: string;
914
1259
  name: string;
1260
+ /** Specifies organizational context for this operation. */
915
1261
  organisationId: string;
1262
+ /**
1263
+ * Defines how long the system will store data received from wallets. After
1264
+ * the defined duration, the received proof and its data are deleted from
1265
+ * the system. If 0, proofs received when using this schema will not be
1266
+ * deleted.
1267
+ */
916
1268
  expireDuration: number;
1269
+ /** Set of requested claims. */
917
1270
  proofInputSchemas: Array<ProofInputSchema>;
1271
+ /** Source URL for imported schema. */
918
1272
  importedSourceUrl?: string;
919
1273
  }
920
1274
  export interface ProofSchemaList {
@@ -928,6 +1282,12 @@ export interface ProofSchemaListItem {
928
1282
  lastModified: string;
929
1283
  deletedAt?: string;
930
1284
  name: string;
1285
+ /**
1286
+ * Defines how long the system will store data received from wallets. After
1287
+ * the defined duration, the received proof and its data are deleted from
1288
+ * the system. If 0, proofs received when using this schema will not be
1289
+ * deleted.
1290
+ */
931
1291
  expireDuration: number;
932
1292
  }
933
1293
  export interface ProofSchemaListQuery {
@@ -959,6 +1319,17 @@ export interface ProposeProofResponse {
959
1319
  interactionId: string;
960
1320
  url?: string;
961
1321
  }
1322
+ export interface RegisterVerifierInstanceRequest {
1323
+ /** The verifier unit's organization. */
1324
+ organisationId: string;
1325
+ /** The Verifier Provider's reference URL. */
1326
+ verifierProviderUrl: string;
1327
+ /** Reference a configured `verifierProvider` instance. */
1328
+ type: string;
1329
+ }
1330
+ export interface RegisterVerifierInstanceResponse {
1331
+ id: string;
1332
+ }
962
1333
  export interface RemoteTrustEntityDetail {
963
1334
  id: string;
964
1335
  organisationId?: string;
@@ -998,6 +1369,11 @@ export interface ShareProofRequest {
998
1369
  params?: ShareProofRequestParams;
999
1370
  }
1000
1371
  export interface ShareProofRequestParams {
1372
+ /**
1373
+ * For requests made with OpenID4VC, a Client ID Scheme can be
1374
+ * specified here. If no scheme is specified the default scheme
1375
+ * from the configuration is used.
1376
+ */
1001
1377
  clientIdScheme?: ClientIdScheme;
1002
1378
  }
1003
1379
  export interface ShareProofResponse {
@@ -1123,6 +1499,13 @@ export interface TrustEntityListQuery {
1123
1499
  lastModifiedAfter?: string;
1124
1500
  lastModifiedBefore?: string;
1125
1501
  }
1502
+ export interface TrustInformationDetail {
1503
+ /**
1504
+ * EUDI trust information received from Access Certificates, Registration
1505
+ * Certificates, or National Registry public APIs.
1506
+ */
1507
+ eudiEcosystem?: EudiTrustInformation;
1508
+ }
1126
1509
  export interface UnexportableEntities {
1127
1510
  credentials: Array<CredentialDetail>;
1128
1511
  keys: Array<KeyListItem>;
@@ -1143,12 +1526,19 @@ export interface UpdateRemoteTrustEntityRequest {
1143
1526
  privacyUrl?: string | null;
1144
1527
  role?: TrustEntityRole;
1145
1528
  }
1529
+ export interface UpdateVerifierInstanceRequest {
1530
+ trustCollections: Array<string>;
1531
+ }
1146
1532
  export interface UpsertOrganisationRequest {
1533
+ /** Unique identifier of the organization to create or update. */
1147
1534
  id: string;
1148
- name?: string;
1535
+ /** Set to `true` to deactivate the organization. */
1149
1536
  deactivate?: boolean;
1537
+ /** Wallet Provider use only. */
1150
1538
  walletProvider?: string | null;
1539
+ /** Wallet Provider use only. */
1151
1540
  walletProviderIssuer?: string | null;
1541
+ parentOrganisation?: string | null;
1152
1542
  }
1153
1543
  export interface Version {
1154
1544
  target: string;
@@ -1163,9 +1553,13 @@ export interface WalletProvider {
1163
1553
  url: string;
1164
1554
  type: WalletProviderType;
1165
1555
  }
1556
+ export interface WalletRelyingPartyMetadata {
1557
+ name: string;
1558
+ }
1166
1559
  export type ApplicableCredentialOrFailureHint = {
1167
1560
  type_: "APPLICABLE_CREDENTIALS";
1168
1561
  applicableCredentials: Array<PresentationDefinitionV2Credential>;
1562
+ purpose?: Record<string, string>;
1169
1563
  } | {
1170
1564
  type_: "FAILURE_HINT";
1171
1565
  failureHint: CredentialQueryFailureHint;
@@ -1223,7 +1617,17 @@ export declare enum CacheType {
1223
1617
  TRUST_LIST = "TRUST_LIST",
1224
1618
  X509_CRL = "X509_CRL",
1225
1619
  ANDROID_ATTESTATION_CRL = "ANDROID_ATTESTATION_CRL",
1226
- OPEN_ID_METADATA = "OPEN_ID_METADATA"
1620
+ OPEN_ID_METADATA_HOLDER = "OPEN_ID_METADATA_HOLDER",
1621
+ OPEN_ID_METADATA_ISSUER = "OPEN_ID_METADATA_ISSUER"
1622
+ }
1623
+ export declare enum CertificateRole {
1624
+ AUTHENTICATION = "AUTHENTICATION",
1625
+ ASSERTION_METHOD = "ASSERTION_METHOD"
1626
+ }
1627
+ /** The mode used to match certificate roles. Default any. */
1628
+ export declare enum CertificateRolesMatchMode {
1629
+ ALL = "ALL",
1630
+ ANY = "ANY"
1227
1631
  }
1228
1632
  export declare enum CertificateState {
1229
1633
  NOT_YET_ACTIVE = "NOT_YET_ACTIVE",
@@ -1336,7 +1740,9 @@ export type HandleInvitationResponse = {
1336
1740
  type_: "CREDENTIAL_ISSUANCE";
1337
1741
  /** For reference. */
1338
1742
  interactionId: string;
1743
+ /** Key storage required to complete issuance. */
1339
1744
  keyStorageSecurityLevels?: Array<KeyStorageSecurity>;
1745
+ /** Key algorithms suitable for issuance. */
1340
1746
  keyAlgorithms?: Array<string>;
1341
1747
  /**
1342
1748
  * Metadata for entering a transaction code
@@ -1345,7 +1751,9 @@ export type HandleInvitationResponse = {
1345
1751
  * This code is typically sent through a separate channel such as SMS or email.
1346
1752
  */
1347
1753
  txCode?: OpenId4vciTxCode;
1754
+ /** Protocol used for issuance. */
1348
1755
  protocol: string;
1756
+ /** Whether a valid WIA is required to complete issuance. */
1349
1757
  requiresWalletInstanceAttestation: boolean;
1350
1758
  } | {
1351
1759
  type_: "AUTHORIZATION_CODE_FLOW";
@@ -1356,6 +1764,7 @@ export type HandleInvitationResponse = {
1356
1764
  * the authorization process with the authorization server.
1357
1765
  */
1358
1766
  authorizationCodeFlowUrl: string;
1767
+ /** Protocol used for issuance. */
1359
1768
  protocol: string;
1360
1769
  } | {
1361
1770
  type_: "PROOF_REQUEST";
@@ -1363,6 +1772,7 @@ export type HandleInvitationResponse = {
1363
1772
  interactionId: string;
1364
1773
  /** Proof request. */
1365
1774
  proofId: string;
1775
+ /** Protocol used for issuance. */
1366
1776
  protocol: string;
1367
1777
  };
1368
1778
  export declare enum HistoryAction {
@@ -1393,7 +1803,10 @@ export declare enum HistoryAction {
1393
1803
  INTERACTION_CREATED = "INTERACTION_CREATED",
1394
1804
  INTERACTION_ERRORED = "INTERACTION_ERRORED",
1395
1805
  INTERACTION_EXPIRED = "INTERACTION_EXPIRED",
1396
- DELIVERED = "DELIVERED"
1806
+ DELIVERED = "DELIVERED",
1807
+ WRP_AC_RECEIVED = "WRP_AC_RECEIVED",
1808
+ WRP_RC_RECEIVED = "WRP_RC_RECEIVED",
1809
+ WRP_NR_RECEIVED = "WRP_NR_RECEIVED"
1397
1810
  }
1398
1811
  export declare enum HistoryEntityType {
1399
1812
  KEY = "KEY",
@@ -1422,7 +1835,8 @@ export declare enum HistoryEntityType {
1422
1835
  SUPERVISORY_AUTHORITY = "SUPERVISORY_AUTHORITY",
1423
1836
  TRUST_LIST_PUBLICATION = "TRUST_LIST_PUBLICATION",
1424
1837
  TRUST_COLLECTION = "TRUST_COLLECTION",
1425
- TRUST_LIST_SUBSCRIPTION = "TRUST_LIST_SUBSCRIPTION"
1838
+ TRUST_LIST_SUBSCRIPTION = "TRUST_LIST_SUBSCRIPTION",
1839
+ VERIFIER_INSTANCE = "VERIFIER_INSTANCE"
1426
1840
  }
1427
1841
  export type HistoryMetadata = {
1428
1842
  type_: "UNEXPORTABLE_ENTITIES";
@@ -1433,8 +1847,12 @@ export type HistoryMetadata = {
1433
1847
  } | {
1434
1848
  type_: "WALLET_UNIT_JWT";
1435
1849
  value: [string];
1850
+ } | {
1851
+ type_: "WALLET_RELYING_PARTY";
1852
+ value: WalletRelyingPartyMetadata;
1436
1853
  };
1437
1854
  export declare enum HistorySearchType {
1855
+ ALL = "ALL",
1438
1856
  CLAIM_NAME = "CLAIM_NAME",
1439
1857
  CLAIM_VALUE = "CLAIM_VALUE",
1440
1858
  CREDENTIAL_SCHEMA_NAME = "CREDENTIAL_SCHEMA_NAME",
@@ -1451,6 +1869,9 @@ export declare enum IdentifierState {
1451
1869
  ACTIVE = "ACTIVE",
1452
1870
  DEACTIVATED = "DEACTIVATED"
1453
1871
  }
1872
+ export declare enum IdentifierTrustInformationType {
1873
+ REGISTRATION_CERTIFICATE = "REGISTRATION_CERTIFICATE"
1874
+ }
1454
1875
  export declare enum IdentifierType {
1455
1876
  KEY = "KEY",
1456
1877
  DID = "DID",
@@ -1581,6 +2002,14 @@ export declare enum SortableDidColumn {
1581
2002
  DID = "DID",
1582
2003
  DEACTIVATED = "DEACTIVATED"
1583
2004
  }
2005
+ export declare enum SortableHistoryColumn {
2006
+ CREATED_DATE = "CREATED_DATE",
2007
+ ACTION = "ACTION",
2008
+ ENTITY_TYPE = "ENTITY_TYPE",
2009
+ SOURCE = "SOURCE",
2010
+ USER = "USER",
2011
+ ORGANISATION_ID = "ORGANISATION_ID"
2012
+ }
1584
2013
  export declare enum SortableIdentifierColumn {
1585
2014
  NAME = "NAME",
1586
2015
  CREATED_DATE = "CREATED_DATE",
@@ -1736,7 +2165,22 @@ export interface NfcScanner {
1736
2165
  transceive(commandApdu: number[]): Promise<number[]>;
1737
2166
  }
1738
2167
  export interface OneCore {
2168
+ /**
2169
+ * Returns information about items that will be excluded from the
2170
+ * export.
2171
+ */
1739
2172
  backupInfo(): Promise<UnexportableEntities>;
2173
+ /**
2174
+ * Checks whether a held credential has been suspended or revoked.
2175
+ *
2176
+ * For list-based revocation methods, the signed lists and any DID
2177
+ * documents containing public keys used to verify the lists are
2178
+ * cached. Use `forceRefresh` to force the system to retrieve these
2179
+ * from the external resource.
2180
+ *
2181
+ * For modcs, use `forceRefresh` to force the system to request a
2182
+ * new MSO.
2183
+ */
1740
2184
  checkRevocation(credentialIds: Array<string>, forceRefresh: boolean | undefined): Promise<Array<CredentialRevocationCheckResponse>>;
1741
2185
  /**
1742
2186
  * For wallet-initiated flows, continues the OpenID4VCI issuance
@@ -1747,39 +2191,88 @@ export interface OneCore {
1747
2191
  * `myapp://example/credential-offer?code=xxx&clientId=myWallet&...`
1748
2192
  */
1749
2193
  continueIssuance(url: string): Promise<ContinueIssuanceResponse>;
2194
+ /** Creates a backup of the current database and writes it to a file. */
1750
2195
  createBackup(password: string, outputPath: string): Promise<CreatedBackup>;
2196
+ /** Deprecated. Use the `createIdentifier` method. */
1751
2197
  createDid(request: CreateDidRequest): Promise<string>;
2198
+ /** Creates a new identifier. */
1752
2199
  createIdentifier(request: CreateIdentifierRequest): Promise<string>;
2200
+ /** Creates an organization. */
1753
2201
  createOrganisation(request: CreateOrganisationRequest): Promise<string>;
1754
- /** For verifiers, creates a proof request. */
2202
+ /**
2203
+ * For verifiers, creates a proof request. Choose what information to
2204
+ * request via a proof schema, an identifier, and which protocol to use
2205
+ * for making the request.
2206
+ */
1755
2207
  createProof(request: CreateProofRequest): Promise<string>;
2208
+ /**
2209
+ * Creates a proof schema, which defines the credentials and claims to
2210
+ * request from a wallet. Proof schemas reference credential schemas
2211
+ * already created in your own system; create or import those first
2212
+ * before building a proof schema that includes their claims.
2213
+ */
1756
2214
  createProofSchema(request: CreateProofSchemaRequest): Promise<string>;
1757
2215
  createRemoteTrustEntity(request: CreateRemoteTrustEntityRequest): Promise<string>;
1758
2216
  createTrustAnchor(anchor: CreateTrustAnchorRequest): Promise<string>;
1759
2217
  createTrustEntity(request: CreateTrustEntityRequest): Promise<string>;
2218
+ /**
2219
+ * Deletes the system cache. See the
2220
+ * [Caching](https://docs.procivis.ch/configure/caching#cached-entities)
2221
+ * guide for details on cached entities.
2222
+ */
1760
2223
  deleteCache(types: Array<CacheType> | undefined): Promise<void>;
1761
2224
  deleteCredential(credentialId: string): Promise<void>;
2225
+ /** Permanently removes a credential schema. */
1762
2226
  deleteCredentialSchema(credentialSchemaId: string): Promise<void>;
1763
2227
  deleteIdentifier(id: string): Promise<void>;
2228
+ /**
2229
+ * Deletes an incomplete proof request. If the request is in `REQUESTED`
2230
+ * state the proof is retracted instead, retaining history of the interaction.
2231
+ */
1764
2232
  deleteProof(proofId: string): Promise<void>;
1765
2233
  deleteProofClaims(proofId: string): Promise<void>;
1766
2234
  deleteProofSchema(proofSchemaId: string): Promise<void>;
1767
2235
  deleteTrustAnchor(anchorId: string): Promise<void>;
2236
+ /**
2237
+ * Commits to the restored database, replacing the original. The old
2238
+ * database is deleted.
2239
+ */
1768
2240
  finalizeImport(): Promise<void>;
1769
2241
  generateKey(request: GenerateKeyRequest): Promise<string>;
2242
+ /** Returns the system configuration. */
1770
2243
  getConfig(): Promise<Config>;
2244
+ /** Returns detailed information about a credential in the system. */
1771
2245
  getCredential(credentialId: string): Promise<CredentialDetail>;
2246
+ /**
2247
+ * Returns detailed information about a credential schema.
2248
+ * A credential schema defines the structure and format of a credential,
2249
+ * including the attributes that issuers make claims about. Schemas also
2250
+ * specify how issued credentials should be presented in wallets, whether
2251
+ * a revocation method is used to manage credential status, and issuer
2252
+ * preferences for suitable key storage types for wallets to use.
2253
+ */
1772
2254
  getCredentialSchema(credentialSchemaId: string): Promise<CredentialSchemaDetail>;
2255
+ /** Returns detailed trust information about a credential issuer. */
2256
+ getCredentialTrustInformation(credentialId: string): Promise<TrustInformationDetail>;
2257
+ /** Returns details on a single event. */
1773
2258
  getHistoryEntry(historyId: string): Promise<HistoryListItem>;
1774
2259
  getIdentifier(id: string): Promise<IdentifierDetail>;
1775
2260
  getPresentationDefinition(proofId: string): Promise<PresentationDefinition>;
1776
2261
  getPresentationDefinitionV2(proofId: string): Promise<PresentationDefinitionV2>;
2262
+ /** Returns detailed information about a proof request. */
1777
2263
  getProof(proofId: string): Promise<ProofDetail>;
1778
2264
  getProofSchema(proofSchemaId: string): Promise<ProofSchemaDetail>;
2265
+ /**
2266
+ * Returns detailed trust information about the requesting entity for a
2267
+ * proof request.
2268
+ */
2269
+ getProofTrustInformation(proofId: string): Promise<TrustInformationDetail>;
1779
2270
  getRemoteTrustEntity(didId: string): Promise<RemoteTrustEntityDetail>;
1780
2271
  getTrustAnchor(trustAnchorId: string): Promise<TrustAnchorDetail>;
1781
2272
  getTrustEntity(trustEntityId: string): Promise<TrustEntityDetail>;
1782
2273
  getTrustEntityByDid(didId: string): Promise<TrustEntityDetail>;
2274
+ /** Returns trust collections curated by the Verifier Provider. */
2275
+ getVerifierInstanceTrustCollections(id: string): Promise<TrustCollections>;
1783
2276
  /**
1784
2277
  * For a wallet, handles the interaction once the wallet connects to a share
1785
2278
  * endpoint URL (for example, scans the QR code of an offered credential or
@@ -1792,38 +2285,59 @@ export interface OneCore {
1792
2285
  * you can specify an existing identifier.
1793
2286
  */
1794
2287
  holderAcceptCredential(request: HolderAcceptCredentialRequest): Promise<string>;
2288
+ /** Returns wallet registration details from the Wallet Provider. */
1795
2289
  holderGetWalletUnit(id: string): Promise<HolderWalletUnit>;
2290
+ /** Returns trust collections curated by the Wallet Provider. */
1796
2291
  holderGetWalletUnitTrustCollections(id: string): Promise<TrustCollections>;
1797
- /** Register with a Wallet Provider. */
2292
+ /** Registers the wallet unit with a Wallet Provider. */
1798
2293
  holderRegisterWalletUnit(request: HolderRegisterWalletUnitRequest): Promise<HolderRegisterWalletUnitResponse>;
1799
2294
  /** Rejects an offered credential. */
1800
2295
  holderRejectCredential(interactionId: string): Promise<void>;
2296
+ /** Rejects a proof request. */
1801
2297
  holderRejectProof(interactionId: string): Promise<void>;
2298
+ /**
2299
+ * Submits a presentation using Presentation Exchange as the query
2300
+ * language; this should be used after `getPresentationDefinition`.
2301
+ */
1802
2302
  holderSubmitProof(interactionId: string, submitCredentials: Record<string, Array<PresentationSubmitCredentialRequest>>): Promise<void>;
2303
+ /**
2304
+ * Submits a presentation using DCQL as a query language; this should
2305
+ * be used after `getPresentationDefinitionv2`.
2306
+ */
1803
2307
  holderSubmitProofV2(interactionId: string, submission: Record<string, Array<PresentationSubmitV2CredentialRequest>>): Promise<void>;
1804
2308
  /**
1805
2309
  * Check status of wallet unit with the Wallet Provider. Will return an error
1806
2310
  * if the unit has been revoked.
1807
2311
  */
1808
2312
  holderWalletUnitStatus(id: string): Promise<void>;
1809
- /** Edit holder wallet unit */
2313
+ /** Modifies wallet unit's settings. */
1810
2314
  holderWalletUnitUpdate(id: string, request: HolderWalletUnitUpdateRequest): Promise<void>;
2315
+ /**
2316
+ * Imports a credential schema shared from another mobile verifier device
2317
+ * using the one-core.
2318
+ */
1811
2319
  importCredentialSchema(request: ImportCredentialSchemaRequest): Promise<string>;
1812
2320
  importProofSchema(request: ImportProofSchemaRequest): Promise<string>;
1813
2321
  /** For wallets, starts the OpenID4VCI Authorization Code Flow. */
1814
2322
  initiateIssuance(request: InitiateIssuanceRequest): Promise<InitiateIssuanceResponse>;
2323
+ /** Returns a filterable list of credential schemas. */
1815
2324
  listCredentialSchemas(query: CredentialSchemaListQuery): Promise<CredentialSchemaList>;
2325
+ /** Returns a filterable list of credentials in the system. */
1816
2326
  listCredentials(query: CredentialListQuery): Promise<CredentialList>;
2327
+ /** Deprecated. Use the `listIdentifiers` method. */
1817
2328
  listDids(query: DidListQuery): Promise<DidList>;
2329
+ /** Returns a filterable list of history events. */
1818
2330
  listHistory(query: HistoryListQuery): Promise<HistoryList>;
2331
+ /** Returns a filterable list of identifiers. */
1819
2332
  listIdentifiers(query: IdentifierListQuery): Promise<IdentifierList>;
1820
2333
  listProofSchemas(filter: ProofSchemaListQuery): Promise<ProofSchemaList>;
2334
+ /** Returns a filterable list of proof requests. */
1821
2335
  listProofs(query: ProofListQuery): Promise<ProofList>;
1822
2336
  listTrustAnchors(filters: TrustAnchorListQuery): Promise<TrustAnchorList>;
1823
2337
  listTrustEntities(filters: TrustEntityListQuery): Promise<TrustEntityList>;
1824
- /** Scan NFC for ISO 18013-5 engagment */
2338
+ /** Scan NFC for ISO 18013-5 engagment. */
1825
2339
  nfcReadIsoMdlEngagement(request: NfcScanRequest): Promise<string>;
1826
- /** Cancel previously started NFC scan via `nfc_read_iso_mdl_engagement` */
2340
+ /** Cancel previously started NFC scan via `nfc_read_iso_mdl_engagement`. */
1827
2341
  nfcStopIsoMdlEngagement(): Promise<void>;
1828
2342
  /**
1829
2343
  * For wallets, initiates device engagement for offline flows. Reference
@@ -1831,16 +2345,47 @@ export interface OneCore {
1831
2345
  * options for `engagement`.
1832
2346
  */
1833
2347
  proposeProof(request: ProposeProofRequest): Promise<ProposeProofResponse>;
2348
+ /** Registers the verifier unit with a Verifier Provider. */
2349
+ registerVerifierInstance(request: RegisterVerifierInstanceRequest): Promise<RegisterVerifierInstanceResponse>;
2350
+ /** Returns the @context of a JSON-LD credential. The result is cached. */
1834
2351
  resolveJsonldContext(url: string): Promise<ResolvedJsonLdContext>;
1835
2352
  resolveTrustEntityByIdentifier(request: ResolveTrustEntitiesRequest): Promise<Record<string, Array<ResolvedTrustEntity>>>;
2353
+ /** Discards the restored database and continues using the original. */
1836
2354
  rollbackImport(): Promise<void>;
2355
+ /**
2356
+ * Runs a task. Check the `task` object of your configuration and reference
2357
+ * the configured instance.
2358
+ */
1837
2359
  runTask(task: string, params: string | undefined): Promise<string>;
2360
+ /**
2361
+ * Produces a URL for sharing a credential schema with another mobile
2362
+ * verifier device using the one-core.
2363
+ */
1838
2364
  shareCredentialSchema(credentialSchemaId: string): Promise<CredentialSchemaShareResponse>;
2365
+ /**
2366
+ * Creates a share URL from a proof request. A wallet holder can use this
2367
+ * URL to access the request.
2368
+ */
1839
2369
  shareProof(proofId: string, params: ShareProofRequest): Promise<ShareProofResponse>;
1840
2370
  shareProofSchema(proofSchemaId: string): Promise<ProofSchemaShareResponse>;
2371
+ /**
2372
+ * Deleting data while uninitializing the Core erases all wallet data permanently.
2373
+ * If data is not deleted it is reused when Core is reinitialized.
2374
+ */
1841
2375
  uninitialize(deleteData: boolean): Promise<void>;
2376
+ /**
2377
+ * Makes the restored database active for calls.
2378
+ * Follow by calling either `finalizeImport` or `rollbackImport`.
2379
+ */
1842
2380
  unpackBackup(password: string, inputPath: string): Promise<Metadata>;
1843
2381
  updateRemoteTrustEntity(request: UpdateRemoteTrustEntityRequest): Promise<void>;
2382
+ /** Modifies verifier unit's settings. */
2383
+ updateVerifierInstance(id: string, request: UpdateVerifierInstanceRequest): Promise<void>;
2384
+ /**
2385
+ * Updates or deactivates an organization if it exists, otherwise
2386
+ * creates a new organization using the provided UUID and name.
2387
+ */
1844
2388
  upsertOrganisation(request: UpsertOrganisationRequest): Promise<void>;
2389
+ /** Returns build information. */
1845
2390
  version(): Version;
1846
2391
  }