@triveria/wallet 0.0.328 → 0.0.330
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/api.d.ts +1201 -191
- package/api.js +1403 -347
- package/package.json +1 -1
package/api.d.ts
CHANGED
|
@@ -126,6 +126,12 @@ export interface CredentialDraftMetadata {
|
|
|
126
126
|
'vcdmVersion'?: VcdmVersion;
|
|
127
127
|
'vcdmName'?: string;
|
|
128
128
|
'vcdmDescription'?: string;
|
|
129
|
+
/**
|
|
130
|
+
* The credential\'s VCDM `renderMethod` entries (W3C VCDM only): UNTP `RenderTemplate2024` (`type`, `name`, `mediaQuery`, `template`, `url`, `mediaType` `text/html` or `text/plain`, `digestMultibase`, nothing else, and a `template` or an https `url` with a `digestMultibase`) or W3C `TemplateRenderMethod` (`renderSuite` `html`, `card` or `nfc`, `renderProperty` JSON pointers, `template` a `data:` URL or an https URL, with a `digestMultibase` when remote). Other types are kept as given. Replaces the draft\'s render methods; an empty array removes them.
|
|
131
|
+
*/
|
|
132
|
+
'renderMethod'?: Array<{
|
|
133
|
+
[key: string]: any;
|
|
134
|
+
}>;
|
|
129
135
|
'credentialSchemaType'?: CredentialSchemaType;
|
|
130
136
|
'id': string;
|
|
131
137
|
'name': string;
|
|
@@ -175,6 +181,33 @@ export interface CredentialIssuanceInit {
|
|
|
175
181
|
export interface CredentialIssuanceInitResult {
|
|
176
182
|
'issuanceQueueItemId': string;
|
|
177
183
|
}
|
|
184
|
+
export interface CredentialIssueDirectPublishFailure {
|
|
185
|
+
'error': string;
|
|
186
|
+
'message': string;
|
|
187
|
+
'credentialId': string;
|
|
188
|
+
}
|
|
189
|
+
export interface CredentialIssueDirectRequest {
|
|
190
|
+
/**
|
|
191
|
+
* The wallet\'s credential issuer that signs, as in `issue/init`. Defaults to the draft\'s issuer, or the wallet\'s only one.
|
|
192
|
+
*/
|
|
193
|
+
'issuerId'?: string;
|
|
194
|
+
'publish'?: UntpLinkOptions;
|
|
195
|
+
}
|
|
196
|
+
export interface CredentialIssueDirectResult {
|
|
197
|
+
'credentialId': string;
|
|
198
|
+
/**
|
|
199
|
+
* The media type of `raw`, e.g. `application/vc+jwt`.
|
|
200
|
+
*/
|
|
201
|
+
'mediaType': string;
|
|
202
|
+
/**
|
|
203
|
+
* The signed credential.
|
|
204
|
+
*/
|
|
205
|
+
'raw': string;
|
|
206
|
+
/**
|
|
207
|
+
* The public URL of the credential, with `publish`.
|
|
208
|
+
*/
|
|
209
|
+
'publicUrl'?: string;
|
|
210
|
+
}
|
|
178
211
|
/**
|
|
179
212
|
* Default value of signingKeyIdentifier is DID.
|
|
180
213
|
*/
|
|
@@ -358,6 +391,12 @@ export interface CredentialPatchPayload {
|
|
|
358
391
|
'contexts'?: Array<any>;
|
|
359
392
|
'vcdmName'?: string;
|
|
360
393
|
'vcdmDescription'?: string;
|
|
394
|
+
/**
|
|
395
|
+
* The credential\'s VCDM `renderMethod` entries (W3C VCDM only): UNTP `RenderTemplate2024` (`type`, `name`, `mediaQuery`, `template`, `url`, `mediaType` `text/html` or `text/plain`, `digestMultibase`, nothing else, and a `template` or an https `url` with a `digestMultibase`) or W3C `TemplateRenderMethod` (`renderSuite` `html`, `card` or `nfc`, `renderProperty` JSON pointers, `template` a `data:` URL or an https URL, with a `digestMultibase` when remote). Other types are kept as given. Replaces the draft\'s render methods; an empty array removes them.
|
|
396
|
+
*/
|
|
397
|
+
'renderMethod'?: Array<{
|
|
398
|
+
[key: string]: any;
|
|
399
|
+
}>;
|
|
361
400
|
/**
|
|
362
401
|
* ID of the credential issuer (`CredentialIssuerDefinition.id`, from the wallet configuration or the trust framework) that issues the draft. When set, the draft can only be queued for issuance by this issuer.
|
|
363
402
|
*/
|
|
@@ -601,6 +640,76 @@ export declare const DeferredStatusEnum: {
|
|
|
601
640
|
readonly Error: "error";
|
|
602
641
|
};
|
|
603
642
|
export type DeferredStatusEnum = typeof DeferredStatusEnum[keyof typeof DeferredStatusEnum];
|
|
643
|
+
/**
|
|
644
|
+
* A change to the wallet\'s DID document.
|
|
645
|
+
*/
|
|
646
|
+
export interface DidDocumentPatch {
|
|
647
|
+
/**
|
|
648
|
+
* The subject\'s other identifiers, as absolute URIs. Replaces the current ones; empty removes them.
|
|
649
|
+
*/
|
|
650
|
+
'alsoKnownAs'?: Array<string>;
|
|
651
|
+
'addServices'?: Array<DidService>;
|
|
652
|
+
/**
|
|
653
|
+
* Ids of the services to remove, as fragments of the DID (without `#`).
|
|
654
|
+
*/
|
|
655
|
+
'removeServiceIds'?: Array<string>;
|
|
656
|
+
}
|
|
657
|
+
/**
|
|
658
|
+
* A DID document service (DID Core 1.0 §5.4).
|
|
659
|
+
*/
|
|
660
|
+
export interface DidService {
|
|
661
|
+
/**
|
|
662
|
+
* The service id as a fragment of the DID, without `#` (`[A-Za-z0-9:_.-]+`).
|
|
663
|
+
*/
|
|
664
|
+
'id': string;
|
|
665
|
+
/**
|
|
666
|
+
* The service type, e.g. the UNTP link type `https://test.uncefact.org/vocabulary/link-type/dia`.
|
|
667
|
+
*/
|
|
668
|
+
'type': string;
|
|
669
|
+
'serviceEndpoint': DidServiceEndpoint;
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* @type DidServiceEndpoint
|
|
673
|
+
* A service endpoint: an absolute URI, a link target, or a set of those. URIs are https, or http for localhost.
|
|
674
|
+
*/
|
|
675
|
+
export type DidServiceEndpoint = Array<DidServiceEndpointOneOfInner> | LinkTarget | string;
|
|
676
|
+
/**
|
|
677
|
+
* @type DidServiceEndpointOneOfInner
|
|
678
|
+
*/
|
|
679
|
+
export type DidServiceEndpointOneOfInner = LinkTarget | string;
|
|
680
|
+
export interface DidTrustFailure {
|
|
681
|
+
'subject': string;
|
|
682
|
+
'source'?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Why: e.g. `no recognition found`, `recognition credential invalid`, `invalid digital identity anchor`, `not listed in the recognition credential`, `trust anchor not active`, `trust anchor key mismatch`, `recognition chain too long`, `too many recognition candidates`, `recognition verification budget exhausted`, `register not allowed for the registrar`.
|
|
685
|
+
*/
|
|
686
|
+
'code': string;
|
|
687
|
+
'error': string;
|
|
688
|
+
}
|
|
689
|
+
export interface DidTrustPolicyResult {
|
|
690
|
+
'credentialType': string;
|
|
691
|
+
/**
|
|
692
|
+
* False when no policy is configured for the credential type.
|
|
693
|
+
*/
|
|
694
|
+
'evaluated': boolean;
|
|
695
|
+
'ok': boolean;
|
|
696
|
+
'reason'?: string;
|
|
697
|
+
}
|
|
698
|
+
/**
|
|
699
|
+
* Whether the wallet\'s trust framework trusts a DID, and how it established it.
|
|
700
|
+
*/
|
|
701
|
+
export interface DidVerification {
|
|
702
|
+
'did': string;
|
|
703
|
+
'trustFramework': TrustFrameworkType;
|
|
704
|
+
'trusted': boolean;
|
|
705
|
+
/**
|
|
706
|
+
* What did not hold, and why.
|
|
707
|
+
*/
|
|
708
|
+
'failures': Array<DidTrustFailure>;
|
|
709
|
+
'policy'?: DidTrustPolicyResult;
|
|
710
|
+
'untp'?: UntpDia;
|
|
711
|
+
'verifiedAt': string;
|
|
712
|
+
}
|
|
604
713
|
export interface DocumentSignatureValidity {
|
|
605
714
|
'verificationResult': DocumentSignatureValidityVerificationResultEnum;
|
|
606
715
|
/**
|
|
@@ -670,6 +779,36 @@ export interface EbsiSpecificWalletData {
|
|
|
670
779
|
'proxyUrl'?: string;
|
|
671
780
|
'configuration': EbsiConfiguration;
|
|
672
781
|
}
|
|
782
|
+
export interface EnrollmentInitPayload {
|
|
783
|
+
'wallet': WalletCreatePayload;
|
|
784
|
+
/**
|
|
785
|
+
* Seconds until the enrollment expires; the deployment\'s default (7 days) when unset, at most its maximum (30 days).
|
|
786
|
+
*/
|
|
787
|
+
'expiresIn'?: number;
|
|
788
|
+
}
|
|
789
|
+
export interface EnrollmentInitResponse {
|
|
790
|
+
/**
|
|
791
|
+
* The one-time enrollment state. Hand it to the user who enrolls; it is not shown again.
|
|
792
|
+
*/
|
|
793
|
+
'state': string;
|
|
794
|
+
/**
|
|
795
|
+
* Identifies the enrollment for listing and revoking.
|
|
796
|
+
*/
|
|
797
|
+
'enrollmentId': string;
|
|
798
|
+
'tenantId': string;
|
|
799
|
+
'expiresAt': string;
|
|
800
|
+
}
|
|
801
|
+
export interface EnrollmentListItem {
|
|
802
|
+
'enrollmentId': string;
|
|
803
|
+
'walletName': string;
|
|
804
|
+
'issuerProxyUrl'?: string;
|
|
805
|
+
/**
|
|
806
|
+
* The owner id of the Tenant Owner who created it.
|
|
807
|
+
*/
|
|
808
|
+
'createdBy': string;
|
|
809
|
+
'createdAt': string;
|
|
810
|
+
'expiresAt': string;
|
|
811
|
+
}
|
|
673
812
|
/**
|
|
674
813
|
* Prepares to accredit legal entity\'s DID
|
|
675
814
|
*/
|
|
@@ -895,6 +1034,26 @@ export type InteractionAuthorizationRequirementsRequirementTypeEnum = typeof Int
|
|
|
895
1034
|
export interface IssuanceRequirementsToVerify {
|
|
896
1035
|
'verifiedFields': Array<FieldsToVerify>;
|
|
897
1036
|
}
|
|
1037
|
+
export interface IssuerDetachedJwsSignRequest {
|
|
1038
|
+
/**
|
|
1039
|
+
* The payload to sign, base64url encoded; at most 64 KiB decoded.
|
|
1040
|
+
*/
|
|
1041
|
+
'payload': string;
|
|
1042
|
+
/**
|
|
1043
|
+
* The JWS `typ`, one of `issuer.jws.allowedTypes`.
|
|
1044
|
+
*/
|
|
1045
|
+
'typ': string;
|
|
1046
|
+
}
|
|
1047
|
+
export interface IssuerDetachedJwsSignResult {
|
|
1048
|
+
/**
|
|
1049
|
+
* The compact detached JWS, `<protected header>..<signature>`.
|
|
1050
|
+
*/
|
|
1051
|
+
'jws': string;
|
|
1052
|
+
/**
|
|
1053
|
+
* The verification method of the wallet\'s DID that signed.
|
|
1054
|
+
*/
|
|
1055
|
+
'kid': string;
|
|
1056
|
+
}
|
|
898
1057
|
export interface IssuerDisplayItem {
|
|
899
1058
|
'name'?: string;
|
|
900
1059
|
'locale'?: string;
|
|
@@ -904,18 +1063,18 @@ export interface IssuerLogo {
|
|
|
904
1063
|
'uri'?: string;
|
|
905
1064
|
'alt_text'?: string;
|
|
906
1065
|
}
|
|
907
|
-
|
|
908
|
-
|
|
909
|
-
|
|
910
|
-
|
|
911
|
-
|
|
912
|
-
|
|
913
|
-
'
|
|
914
|
-
'linkedVpUrl': string;
|
|
1066
|
+
/**
|
|
1067
|
+
* A link target (RFC 9264 §4.2) as UNTP uses it for service endpoints. Other members, e.g. `accessRole`, are kept.
|
|
1068
|
+
*/
|
|
1069
|
+
export interface LinkTarget {
|
|
1070
|
+
[key: string]: any;
|
|
1071
|
+
'href': string;
|
|
1072
|
+
'title'?: string;
|
|
915
1073
|
/**
|
|
916
|
-
*
|
|
1074
|
+
* The media type of the target, e.g. `application/vc+jwt`.
|
|
917
1075
|
*/
|
|
918
|
-
'
|
|
1076
|
+
'type'?: string;
|
|
1077
|
+
'hreflang'?: Array<string>;
|
|
919
1078
|
}
|
|
920
1079
|
/**
|
|
921
1080
|
* Sort flag controls the sort direction by the time created
|
|
@@ -1108,6 +1267,42 @@ export interface PresentationResponse {
|
|
|
1108
1267
|
*/
|
|
1109
1268
|
'redirectUri'?: string;
|
|
1110
1269
|
}
|
|
1270
|
+
export interface RenderMethodInfo {
|
|
1271
|
+
/**
|
|
1272
|
+
* The index of the method in the credential\'s `renderMethod`.
|
|
1273
|
+
*/
|
|
1274
|
+
'index': number;
|
|
1275
|
+
'kind': RenderMethodInfoKindEnum;
|
|
1276
|
+
/**
|
|
1277
|
+
* `template2024` for a `RenderTemplate2024`, the `renderSuite` of a `TemplateRenderMethod`.
|
|
1278
|
+
*/
|
|
1279
|
+
'renderSuite'?: string;
|
|
1280
|
+
'name'?: string;
|
|
1281
|
+
'mediaQuery'?: string;
|
|
1282
|
+
/**
|
|
1283
|
+
* The media type the method renders to.
|
|
1284
|
+
*/
|
|
1285
|
+
'mediaType'?: string;
|
|
1286
|
+
/**
|
|
1287
|
+
* Whether the wallet can render with the method.
|
|
1288
|
+
*/
|
|
1289
|
+
'renderable': boolean;
|
|
1290
|
+
}
|
|
1291
|
+
export declare const RenderMethodInfoKindEnum: {
|
|
1292
|
+
readonly RenderTemplate2024: "RenderTemplate2024";
|
|
1293
|
+
readonly TemplateRenderMethod: "TemplateRenderMethod";
|
|
1294
|
+
readonly Unknown: "unknown";
|
|
1295
|
+
};
|
|
1296
|
+
export type RenderMethodInfoKindEnum = typeof RenderMethodInfoKindEnum[keyof typeof RenderMethodInfoKindEnum];
|
|
1297
|
+
/**
|
|
1298
|
+
* A render suite; `template2024` is a UNTP `RenderTemplate2024`.
|
|
1299
|
+
*/
|
|
1300
|
+
export declare const RenderSuite: {
|
|
1301
|
+
readonly Html: "html";
|
|
1302
|
+
readonly Card: "card";
|
|
1303
|
+
readonly Template2024: "template2024";
|
|
1304
|
+
};
|
|
1305
|
+
export type RenderSuite = typeof RenderSuite[keyof typeof RenderSuite];
|
|
1111
1306
|
/**
|
|
1112
1307
|
* Info needed to revoke legal entity\'s DID
|
|
1113
1308
|
*/
|
|
@@ -1148,6 +1343,19 @@ export declare const SystemImpactStatusEnum: {
|
|
|
1148
1343
|
readonly Critical: "critical";
|
|
1149
1344
|
};
|
|
1150
1345
|
export type SystemImpactStatusEnum = typeof SystemImpactStatusEnum[keyof typeof SystemImpactStatusEnum];
|
|
1346
|
+
/**
|
|
1347
|
+
* The part of the wallet config that belongs to the wallet\'s tenant. A wallet joins a tenant only by enrollment, and only a Tenant Owner of that tenant changes this block, through PATCH /wallets/{wallet_id}. It is ignored on wallet create and, for anyone else, on wallet patch.
|
|
1348
|
+
*/
|
|
1349
|
+
export interface TenantConfig {
|
|
1350
|
+
/**
|
|
1351
|
+
* The tenant the wallet belongs to. It never changes.
|
|
1352
|
+
*/
|
|
1353
|
+
'tenantId'?: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* The issuer proxy the wallet\'s clients use: an absolute URL, https when the deployment runs with production=true. An empty string clears it. Not declared as format uri, which rejects the empty string; the wallet validates any other value and answers 400 when it is not such a URL.
|
|
1356
|
+
*/
|
|
1357
|
+
'issuerProxyUrl'?: string;
|
|
1358
|
+
}
|
|
1151
1359
|
/**
|
|
1152
1360
|
* A transaction_data object (OpenID4VP 1.0 §5.1). Type-specific fields are kept as given.
|
|
1153
1361
|
*/
|
|
@@ -1157,13 +1365,14 @@ export interface TransactionData {
|
|
|
1157
1365
|
'credential_ids': Array<string>;
|
|
1158
1366
|
}
|
|
1159
1367
|
/**
|
|
1160
|
-
* What trust framework should we use with this wallet. This property COULD NOT change later. Supported frameworks: EBSI - the European Blockchain Services Infrastructure, IDTL - IDUnion Trust List, EUDI - European Digital Identity wallet, Noop - personal key based no-op trust framework (mainly for the personal use)
|
|
1368
|
+
* What trust framework should we use with this wallet. This property COULD NOT change later. Supported frameworks: EBSI - the European Blockchain Services Infrastructure, IDTL - IDUnion Trust List, EUDI - European Digital Identity wallet, Noop - personal key based no-op trust framework (mainly for the personal use), UNTP - UN Transparency Protocol: a self-hosted did:web, and every DID the wallet resolves a key of must be anchored by a Digital Identity Anchor of a trusted registrar.
|
|
1161
1369
|
*/
|
|
1162
1370
|
export declare const TrustFrameworkType: {
|
|
1163
1371
|
readonly Ebsi: "EBSI";
|
|
1164
1372
|
readonly Idtl: "IDTL";
|
|
1165
1373
|
readonly Noop: "NOOP";
|
|
1166
1374
|
readonly Eudi: "EUDI";
|
|
1375
|
+
readonly Untp: "UNTP";
|
|
1167
1376
|
};
|
|
1168
1377
|
export type TrustFrameworkType = typeof TrustFrameworkType[keyof typeof TrustFrameworkType];
|
|
1169
1378
|
export interface TrustListAddRequest {
|
|
@@ -1206,6 +1415,263 @@ export interface TrustListSource {
|
|
|
1206
1415
|
export interface TrustListsResponse {
|
|
1207
1416
|
'trust_lists': Array<TrustListSource>;
|
|
1208
1417
|
}
|
|
1418
|
+
/**
|
|
1419
|
+
* Configuration of the UNTP trust framework. The wallet has a self-hosted did:web, and its `walletKeyIdentifier` must be `did`. Every DID it resolves a key of, to verify a credential, a status list or a presentation, must be anchored by a UNTP Digital Identity Anchor chained up to a trusted registrar: those of `untp.dia.trustedRegistrars` and `untp.dia.registryUrl`, and the wallet\'s own `trustedRegistrars`.
|
|
1420
|
+
*/
|
|
1421
|
+
export interface UntpConfiguration {
|
|
1422
|
+
/**
|
|
1423
|
+
* Whether the wallet holds a DIA of its own.
|
|
1424
|
+
*/
|
|
1425
|
+
'isOnboarded': boolean;
|
|
1426
|
+
/**
|
|
1427
|
+
* A `registrar` issues DIAs (to come); a `member` is anchored by one.
|
|
1428
|
+
*/
|
|
1429
|
+
'role'?: UntpConfigurationRoleEnum;
|
|
1430
|
+
/**
|
|
1431
|
+
* Registrars this wallet trusts besides the deployment\'s; they take precedence.
|
|
1432
|
+
*/
|
|
1433
|
+
'trustedRegistrars'?: Array<UntpRegistrarConfig>;
|
|
1434
|
+
/**
|
|
1435
|
+
* What `/verifier/did` requires of the issuers of a credential type; replaces the deployment\'s.
|
|
1436
|
+
*/
|
|
1437
|
+
'issuerPolicy'?: Array<UntpIssuerPolicy>;
|
|
1438
|
+
}
|
|
1439
|
+
export declare const UntpConfigurationRoleEnum: {
|
|
1440
|
+
readonly Member: "member";
|
|
1441
|
+
readonly Registrar: "registrar";
|
|
1442
|
+
};
|
|
1443
|
+
export type UntpConfigurationRoleEnum = typeof UntpConfigurationRoleEnum[keyof typeof UntpConfigurationRoleEnum];
|
|
1444
|
+
/**
|
|
1445
|
+
* How a UNTP wallet anchored a DID.
|
|
1446
|
+
*/
|
|
1447
|
+
export interface UntpDia {
|
|
1448
|
+
'registrar'?: UntpRegistrar;
|
|
1449
|
+
/**
|
|
1450
|
+
* The registrations of the DID\'s own DIA.
|
|
1451
|
+
*/
|
|
1452
|
+
'registrations'?: Array<UntpRegistration>;
|
|
1453
|
+
/**
|
|
1454
|
+
* The DIAs from the DID\'s own up to the one a trusted registrar issued.
|
|
1455
|
+
*/
|
|
1456
|
+
'chain': Array<UntpRecognition>;
|
|
1457
|
+
}
|
|
1458
|
+
export interface UntpFailure {
|
|
1459
|
+
'linkType': string;
|
|
1460
|
+
'href': string;
|
|
1461
|
+
/**
|
|
1462
|
+
* Why the credential failed: `fetch_failed`, `unsupported_media_type`, `too_large`, `too_many_links`, `format_unsupported`, `signature_invalid`, `issuer_key_unresolvable`, `trust_chain_failed`, `expired`, `not_yet_valid`, `revoked`, `suspended`, `status_check_failed`, `schema_invalid`, `schema_unavailable`, `jsonld_invalid` or `unknown`.
|
|
1463
|
+
*/
|
|
1464
|
+
'code': string;
|
|
1465
|
+
'error': string;
|
|
1466
|
+
}
|
|
1467
|
+
/**
|
|
1468
|
+
* A linked credential, verified (`credential`) or failed (`error` and `errorCode`).
|
|
1469
|
+
*/
|
|
1470
|
+
export interface UntpFetchedCredential {
|
|
1471
|
+
'linkType': string;
|
|
1472
|
+
'href': string;
|
|
1473
|
+
'credential'?: CredentialWrapper;
|
|
1474
|
+
'error'?: string;
|
|
1475
|
+
'errorCode'?: string;
|
|
1476
|
+
}
|
|
1477
|
+
export interface UntpIdentifier {
|
|
1478
|
+
/**
|
|
1479
|
+
* The kind of identifier; only `did` is resolved.
|
|
1480
|
+
*/
|
|
1481
|
+
'kind': string;
|
|
1482
|
+
'canonical': string;
|
|
1483
|
+
}
|
|
1484
|
+
/**
|
|
1485
|
+
* What a verifier requires of the issuers of a credential type.
|
|
1486
|
+
*/
|
|
1487
|
+
export interface UntpIssuerPolicy {
|
|
1488
|
+
'credentialType': string;
|
|
1489
|
+
'requireDia'?: boolean;
|
|
1490
|
+
'allowedRegisterTypes'?: Array<string>;
|
|
1491
|
+
/**
|
|
1492
|
+
* Recognition scope URIs the issuer must hold, at every level of its chain.
|
|
1493
|
+
*/
|
|
1494
|
+
'requiredScopes'?: Array<string>;
|
|
1495
|
+
'requireAuthoritativeRegistrar'?: boolean;
|
|
1496
|
+
'requireRegisterMandate'?: boolean;
|
|
1497
|
+
}
|
|
1498
|
+
/**
|
|
1499
|
+
* A credential published as a UNTP link.
|
|
1500
|
+
*/
|
|
1501
|
+
export interface UntpLink {
|
|
1502
|
+
/**
|
|
1503
|
+
* The id of the DID document service, `<did>#<fragment>`.
|
|
1504
|
+
*/
|
|
1505
|
+
'serviceId': string;
|
|
1506
|
+
/**
|
|
1507
|
+
* The public URL of the credential.
|
|
1508
|
+
*/
|
|
1509
|
+
'href': string;
|
|
1510
|
+
'linkType': string;
|
|
1511
|
+
'title'?: string;
|
|
1512
|
+
'credentialId': string;
|
|
1513
|
+
}
|
|
1514
|
+
/**
|
|
1515
|
+
* How to publish a credential as a UNTP link.
|
|
1516
|
+
*/
|
|
1517
|
+
export interface UntpLinkOptions {
|
|
1518
|
+
/**
|
|
1519
|
+
* The UNTP link type, e.g. `dpp`.
|
|
1520
|
+
*/
|
|
1521
|
+
'linkType': string;
|
|
1522
|
+
'title'?: string;
|
|
1523
|
+
'hreflang'?: Array<string>;
|
|
1524
|
+
}
|
|
1525
|
+
export interface UntpLinkPublishRequest {
|
|
1526
|
+
'credentialId': string;
|
|
1527
|
+
/**
|
|
1528
|
+
* The UNTP link type: `dpp`, `dcc`, `dfr`, `dte`, `dia` or `dcr`, its UNTP 0.8.0 IRI (`https://test.uncefact.org/vocabulary/link-type/dia`) or its UNTP 0.7 alias (`untp:dia`). The DID service is published with the 0.8.0 value, the IRI for every type but `dpp`.
|
|
1529
|
+
*/
|
|
1530
|
+
'linkType': string;
|
|
1531
|
+
/**
|
|
1532
|
+
* The title of the link. Defaults to the link type\'s, e.g. `Digital Product Passport`.
|
|
1533
|
+
*/
|
|
1534
|
+
'title'?: string;
|
|
1535
|
+
/**
|
|
1536
|
+
* The languages of the credential. Defaults to `[\"en\"]`.
|
|
1537
|
+
*/
|
|
1538
|
+
'hreflang'?: Array<string>;
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* One DIA of a recognition chain.
|
|
1542
|
+
*/
|
|
1543
|
+
export interface UntpRecognition {
|
|
1544
|
+
'subject': string;
|
|
1545
|
+
'issuer': string;
|
|
1546
|
+
/**
|
|
1547
|
+
* Where the DIA was found.
|
|
1548
|
+
*/
|
|
1549
|
+
'source'?: string;
|
|
1550
|
+
'credentialId'?: string;
|
|
1551
|
+
'types'?: Array<string>;
|
|
1552
|
+
'validFrom'?: string;
|
|
1553
|
+
'validUntil'?: string;
|
|
1554
|
+
/**
|
|
1555
|
+
* The W3C RecognizedEntity, every property as the DIA has it.
|
|
1556
|
+
*/
|
|
1557
|
+
'entity': {
|
|
1558
|
+
[key: string]: any;
|
|
1559
|
+
};
|
|
1560
|
+
}
|
|
1561
|
+
/**
|
|
1562
|
+
* What a registrar recognizes, as a definition it publishes.
|
|
1563
|
+
*/
|
|
1564
|
+
export interface UntpRecognitionScope {
|
|
1565
|
+
'id': string;
|
|
1566
|
+
'name'?: string;
|
|
1567
|
+
}
|
|
1568
|
+
/**
|
|
1569
|
+
* The register that holds a registration.
|
|
1570
|
+
*/
|
|
1571
|
+
export interface UntpRegister {
|
|
1572
|
+
'id': string;
|
|
1573
|
+
'name'?: string;
|
|
1574
|
+
'registerType': string;
|
|
1575
|
+
}
|
|
1576
|
+
/**
|
|
1577
|
+
* A registrar trusted to issue Digital Identity Anchors, modelled on the UN GRID entry.
|
|
1578
|
+
*/
|
|
1579
|
+
export interface UntpRegistrar {
|
|
1580
|
+
'did': string;
|
|
1581
|
+
'name'?: string;
|
|
1582
|
+
'domain'?: string;
|
|
1583
|
+
'registers'?: Array<string>;
|
|
1584
|
+
'registerTypes'?: Array<string>;
|
|
1585
|
+
'jurisdiction'?: string;
|
|
1586
|
+
'authoritative'?: boolean;
|
|
1587
|
+
'gridReference'?: string;
|
|
1588
|
+
'status'?: string;
|
|
1589
|
+
}
|
|
1590
|
+
/**
|
|
1591
|
+
* A registrar trusted to issue Digital Identity Anchors, modelled on the UN GRID entry.
|
|
1592
|
+
*/
|
|
1593
|
+
export interface UntpRegistrarConfig {
|
|
1594
|
+
'did': string;
|
|
1595
|
+
'name'?: string;
|
|
1596
|
+
/**
|
|
1597
|
+
* The host a did:web registrar DID must have.
|
|
1598
|
+
*/
|
|
1599
|
+
'domain'?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* The registers it maintains; a DIA it issues must name one.
|
|
1602
|
+
*/
|
|
1603
|
+
'registers'?: Array<string>;
|
|
1604
|
+
/**
|
|
1605
|
+
* The register types its DIAs may have.
|
|
1606
|
+
*/
|
|
1607
|
+
'registerTypes'?: Array<string>;
|
|
1608
|
+
'jurisdiction'?: string;
|
|
1609
|
+
/**
|
|
1610
|
+
* A GRID-listed sovereign register.
|
|
1611
|
+
*/
|
|
1612
|
+
'authoritative'?: boolean;
|
|
1613
|
+
'gridReference'?: string;
|
|
1614
|
+
'status'?: UntpRegistrarConfigStatusEnum;
|
|
1615
|
+
/**
|
|
1616
|
+
* The only JWKs its signatures may be made with.
|
|
1617
|
+
*/
|
|
1618
|
+
'publicKeys'?: Array<{
|
|
1619
|
+
[key: string]: any;
|
|
1620
|
+
}>;
|
|
1621
|
+
}
|
|
1622
|
+
export declare const UntpRegistrarConfigStatusEnum: {
|
|
1623
|
+
readonly Active: "Active";
|
|
1624
|
+
readonly Suspended: "Suspended";
|
|
1625
|
+
readonly KeyCompromised: "KeyCompromised";
|
|
1626
|
+
};
|
|
1627
|
+
export type UntpRegistrarConfigStatusEnum = typeof UntpRegistrarConfigStatusEnum[keyof typeof UntpRegistrarConfigStatusEnum];
|
|
1628
|
+
/**
|
|
1629
|
+
* A UNTP RegisteredIdentity of a DIA.
|
|
1630
|
+
*/
|
|
1631
|
+
export interface UntpRegistration {
|
|
1632
|
+
'id'?: string;
|
|
1633
|
+
'registeredId': string;
|
|
1634
|
+
'registeredName'?: string;
|
|
1635
|
+
'registeredDate'?: string;
|
|
1636
|
+
'register': UntpRegister;
|
|
1637
|
+
'controlType'?: string;
|
|
1638
|
+
'recognitionScope'?: Array<UntpRecognitionScope>;
|
|
1639
|
+
}
|
|
1640
|
+
export interface UntpRegistry {
|
|
1641
|
+
'registrars': Array<UntpRegistrar>;
|
|
1642
|
+
'self': UntpRegistrySelf;
|
|
1643
|
+
}
|
|
1644
|
+
export interface UntpRegistrySelf {
|
|
1645
|
+
'did'?: string;
|
|
1646
|
+
'listed': boolean;
|
|
1647
|
+
'authoritative'?: boolean;
|
|
1648
|
+
'status'?: string;
|
|
1649
|
+
}
|
|
1650
|
+
export interface UntpResolveResult {
|
|
1651
|
+
'identifier': UntpIdentifier;
|
|
1652
|
+
'anchor': string;
|
|
1653
|
+
/**
|
|
1654
|
+
* The RFC 9264 linkset of the identifier\'s UNTP links.
|
|
1655
|
+
*/
|
|
1656
|
+
'linkset': {
|
|
1657
|
+
[key: string]: any;
|
|
1658
|
+
};
|
|
1659
|
+
'verification'?: UntpVerification;
|
|
1660
|
+
'credentials'?: Array<UntpFetchedCredential>;
|
|
1661
|
+
'issuer'?: DidVerification;
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1664
|
+
* The verdict over every fetched credential, present with `fetch`.
|
|
1665
|
+
*/
|
|
1666
|
+
export interface UntpVerification {
|
|
1667
|
+
/**
|
|
1668
|
+
* True only when at least one credential was fetched and every fetched credential verified.
|
|
1669
|
+
*/
|
|
1670
|
+
'ok': boolean;
|
|
1671
|
+
'fetched': number;
|
|
1672
|
+
'verified': number;
|
|
1673
|
+
'failed': Array<UntpFailure>;
|
|
1674
|
+
}
|
|
1209
1675
|
export interface VPDrivenIssuerConfig {
|
|
1210
1676
|
/**
|
|
1211
1677
|
* ID of the verifier used for verification of presented credential.
|
|
@@ -1258,13 +1724,6 @@ export declare const VcdmVersion: {
|
|
|
1258
1724
|
readonly _20: "2.0";
|
|
1259
1725
|
};
|
|
1260
1726
|
export type VcdmVersion = typeof VcdmVersion[keyof typeof VcdmVersion];
|
|
1261
|
-
export interface VerifiedLinkedVp {
|
|
1262
|
-
'linkedVpId': string;
|
|
1263
|
-
/**
|
|
1264
|
-
* List of verified credentials. Raw signed credentials (`signedVc`) are not available for this endpoint due to response size.
|
|
1265
|
-
*/
|
|
1266
|
-
'credentials': Array<CredentialWrapper>;
|
|
1267
|
-
}
|
|
1268
1727
|
/**
|
|
1269
1728
|
* Wrapped result of successful verification interaction.
|
|
1270
1729
|
*/
|
|
@@ -1279,6 +1738,83 @@ export interface VerifiedWrapper {
|
|
|
1279
1738
|
*/
|
|
1280
1739
|
'holder': string;
|
|
1281
1740
|
}
|
|
1741
|
+
export interface VerifierCredentialCheck {
|
|
1742
|
+
/**
|
|
1743
|
+
* `fetch`, `signature`, `validity`, `jsonld`, `status`, `schema` or `issuerTrust`.
|
|
1744
|
+
*/
|
|
1745
|
+
'name': string;
|
|
1746
|
+
'ok': boolean;
|
|
1747
|
+
/**
|
|
1748
|
+
* Why it failed, as in `UntpFailure.code`.
|
|
1749
|
+
*/
|
|
1750
|
+
'code'?: string;
|
|
1751
|
+
'message'?: string;
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* The checks to run besides the signature and validity dates; each is on unless set false.
|
|
1755
|
+
*/
|
|
1756
|
+
export interface VerifierCredentialChecks {
|
|
1757
|
+
'schema'?: boolean;
|
|
1758
|
+
'jsonld'?: boolean;
|
|
1759
|
+
'status'?: boolean;
|
|
1760
|
+
'issuerTrust'?: boolean;
|
|
1761
|
+
}
|
|
1762
|
+
/**
|
|
1763
|
+
* The credential to verify, `raw` or `url`.
|
|
1764
|
+
*/
|
|
1765
|
+
export interface VerifierCredentialRequest {
|
|
1766
|
+
/**
|
|
1767
|
+
* The credential as received, e.g. a JWS.
|
|
1768
|
+
*/
|
|
1769
|
+
'raw'?: string;
|
|
1770
|
+
/**
|
|
1771
|
+
* Where to fetch the credential.
|
|
1772
|
+
*/
|
|
1773
|
+
'url'?: string;
|
|
1774
|
+
'checks'?: VerifierCredentialChecks;
|
|
1775
|
+
}
|
|
1776
|
+
export interface VerifierCredentialResult {
|
|
1777
|
+
/**
|
|
1778
|
+
* True when every check passed.
|
|
1779
|
+
*/
|
|
1780
|
+
'verified': boolean;
|
|
1781
|
+
/**
|
|
1782
|
+
* The credential format, e.g. `jwt_vc_vcdm`; empty when it did not parse.
|
|
1783
|
+
*/
|
|
1784
|
+
'format'?: string;
|
|
1785
|
+
'issuer'?: string;
|
|
1786
|
+
'checks': Array<VerifierCredentialCheck>;
|
|
1787
|
+
/**
|
|
1788
|
+
* The credential document, when it parsed.
|
|
1789
|
+
*/
|
|
1790
|
+
'payload'?: {
|
|
1791
|
+
[key: string]: any;
|
|
1792
|
+
};
|
|
1793
|
+
}
|
|
1794
|
+
/**
|
|
1795
|
+
* A credential to render, `signedVc` or `vc`, and which of its render methods to use.
|
|
1796
|
+
*/
|
|
1797
|
+
export interface VerifierRenderRequest {
|
|
1798
|
+
/**
|
|
1799
|
+
* A signed credential (compact JWS, SD-JWT), verified before it is rendered.
|
|
1800
|
+
*/
|
|
1801
|
+
'signedVc'?: string;
|
|
1802
|
+
/**
|
|
1803
|
+
* A credential document, rendered without verification.
|
|
1804
|
+
*/
|
|
1805
|
+
'vc'?: {
|
|
1806
|
+
[key: string]: any;
|
|
1807
|
+
};
|
|
1808
|
+
/**
|
|
1809
|
+
* The index of the render method to use.
|
|
1810
|
+
*/
|
|
1811
|
+
'index'?: number;
|
|
1812
|
+
'suite'?: RenderSuite;
|
|
1813
|
+
/**
|
|
1814
|
+
* Use the first render method with exactly this `mediaQuery`.
|
|
1815
|
+
*/
|
|
1816
|
+
'mediaQuery'?: string;
|
|
1817
|
+
}
|
|
1282
1818
|
/**
|
|
1283
1819
|
* Registers a new verification request. When `createUrl` is true, URL used by holder to present credentials to a verifier is created. Otherwise, the holder can use the verifier authorization endpoint with a custom scope to request credentials. In this case `holderEntityId` must be provided.
|
|
1284
1820
|
*/
|
|
@@ -1394,12 +1930,14 @@ export interface WalletConfig {
|
|
|
1394
1930
|
'EBSI'?: EbsiSpecificWalletData;
|
|
1395
1931
|
'EUDI'?: EudiConfiguration;
|
|
1396
1932
|
'IDTL'?: IdtlConfiguration;
|
|
1933
|
+
'UNTP'?: UntpConfiguration;
|
|
1397
1934
|
'walletKeyIdentifier': SigningKeyIdentifier;
|
|
1398
1935
|
'vaultType'?: VaultType;
|
|
1399
1936
|
/**
|
|
1400
1937
|
* Expiration time in seconds for credential status lists. Used only if the wallet is a credential issuer
|
|
1401
1938
|
*/
|
|
1402
1939
|
'statusListExpiration'?: number;
|
|
1940
|
+
'tenant'?: TenantConfig;
|
|
1403
1941
|
}
|
|
1404
1942
|
/**
|
|
1405
1943
|
* Payload to create a wallet
|
|
@@ -1427,6 +1965,10 @@ export interface WalletListItem {
|
|
|
1427
1965
|
'walletId': string;
|
|
1428
1966
|
'name': string;
|
|
1429
1967
|
'capabilities': Array<WalletCapability>;
|
|
1968
|
+
/**
|
|
1969
|
+
* The owner of the wallet. Set only when listing the wallets of a tenant.
|
|
1970
|
+
*/
|
|
1971
|
+
'ownerId'?: string;
|
|
1430
1972
|
}
|
|
1431
1973
|
export interface WalletNotification {
|
|
1432
1974
|
/**
|
|
@@ -1814,6 +2356,16 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1814
2356
|
* @throws {RequiredError}
|
|
1815
2357
|
*/
|
|
1816
2358
|
credentialIssuanceInit: (credentialId: string, walletId: string, credentialIssuanceInit?: CredentialIssuanceInit, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2359
|
+
/**
|
|
2360
|
+
* Issues a W3C VCDM draft as a credential of the wallet itself, with no holder and no OID4VCI: for a credential that is published rather than handed to anyone, such as a UNTP Digital Product Passport (EN 18246 Annex B.5). The credential gets the wallet\'s status list entry and envelope, and is stored issued on the same record. With `publish`, it is then published as a UNTP link, like `POST /untp/links`; if that fails the response is `502` with the issued `credentialId`, and publishing is retried with `POST /untp/links`.
|
|
2361
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
2362
|
+
* @param {string} walletId
|
|
2363
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
2364
|
+
* @param {CredentialIssueDirectRequest} [credentialIssueDirectRequest]
|
|
2365
|
+
* @param {*} [options] Override http request option.
|
|
2366
|
+
* @throws {RequiredError}
|
|
2367
|
+
*/
|
|
2368
|
+
credentialIssueDirect: (credentialId: string, walletId: string, idempotencyKey?: string, credentialIssueDirectRequest?: CredentialIssueDirectRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1817
2369
|
/**
|
|
1818
2370
|
* Retrieves a list of credentials.
|
|
1819
2371
|
* @param {string} walletId
|
|
@@ -1866,6 +2418,25 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1866
2418
|
* @throws {RequiredError}
|
|
1867
2419
|
*/
|
|
1868
2420
|
credentialRawGet: (credentialId: string, walletId: string, disclosedClaims?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2421
|
+
/**
|
|
2422
|
+
* Renders a W3C VCDM credential of the wallet with one of its `renderMethod` entries, as `POST /verifier/render` does. HTML is served with a `Content-Security-Policy` that sandboxes it.
|
|
2423
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
2424
|
+
* @param {string} walletId
|
|
2425
|
+
* @param {number} [index] The index of the render method to use, in the credential\'s `renderMethod`.
|
|
2426
|
+
* @param {RenderSuite} [suite] Use the first render method of this suite.
|
|
2427
|
+
* @param {string} [mediaQuery] Use the first render method with exactly this `mediaQuery`.
|
|
2428
|
+
* @param {*} [options] Override http request option.
|
|
2429
|
+
* @throws {RequiredError}
|
|
2430
|
+
*/
|
|
2431
|
+
credentialRender: (credentialId: string, walletId: string, index?: number, suite?: RenderSuite, mediaQuery?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2432
|
+
/**
|
|
2433
|
+
* Lists the render methods of a W3C VCDM credential of the wallet, for a client to pick one by its media query: media queries are not evaluated by the wallet.
|
|
2434
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
2435
|
+
* @param {string} walletId
|
|
2436
|
+
* @param {*} [options] Override http request option.
|
|
2437
|
+
* @throws {RequiredError}
|
|
2438
|
+
*/
|
|
2439
|
+
credentialRenderMethods: (credentialId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1869
2440
|
/**
|
|
1870
2441
|
* Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
|
|
1871
2442
|
* @param {string} walletId
|
|
@@ -1875,13 +2446,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1875
2446
|
*/
|
|
1876
2447
|
credentialRequestInit: (walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1877
2448
|
/**
|
|
1878
|
-
* Revoke a specific Verifiable Credential
|
|
2449
|
+
* Revoke a specific Verifiable Credential. A credential published as a UNTP link stays published: a verifier following its link finds it and verifies it as revoked. `DELETE /untp/links/{service_id}` unpublishes it.
|
|
1879
2450
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
1880
2451
|
* @param {string} walletId
|
|
2452
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
1881
2453
|
* @param {*} [options] Override http request option.
|
|
1882
2454
|
* @throws {RequiredError}
|
|
1883
2455
|
*/
|
|
1884
|
-
credentialRevoke: (credentialId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2456
|
+
credentialRevoke: (credentialId: string, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1885
2457
|
/**
|
|
1886
2458
|
* Suspend a Verifiable Credential issued with the `suspension` status purpose (W3C Bitstring Status List v1.0). A suspension can be lifted with `DELETE`.
|
|
1887
2459
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
@@ -1913,6 +2485,21 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1913
2485
|
* @throws {RequiredError}
|
|
1914
2486
|
*/
|
|
1915
2487
|
didDocumentGet: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2488
|
+
/**
|
|
2489
|
+
* Returns the wallet\'s own DID document, as published at `/{wallet_id}/did.json` for a self-hosted did:web.
|
|
2490
|
+
* @param {string} walletId
|
|
2491
|
+
* @param {*} [options] Override http request option.
|
|
2492
|
+
* @throws {RequiredError}
|
|
2493
|
+
*/
|
|
2494
|
+
didDocumentLocalGet: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2495
|
+
/**
|
|
2496
|
+
* Changes the wallet\'s DID document: removes the services in `removeServiceIds`, adds the services in `addServices` (a service with the same id is replaced), and, when `alsoKnownAs` is set, replaces the subject\'s other identifiers (an empty list removes them). UNTP identifies an entity\'s Digital Identity Anchor with a service of type `https://test.uncefact.org/vocabulary/link-type/dia` (`untp:dia` in UNTP 0.7) and registered identifiers with `alsoKnownAs`. Only a self-hosted did:web document can be changed; services of an EBSI DID are written to the EBSI DID registry, which does not take `alsoKnownAs`.
|
|
2497
|
+
* @param {string} walletId
|
|
2498
|
+
* @param {DidDocumentPatch} didDocumentPatch
|
|
2499
|
+
* @param {*} [options] Override http request option.
|
|
2500
|
+
* @throws {RequiredError}
|
|
2501
|
+
*/
|
|
2502
|
+
didDocumentPatch: (walletId: string, didDocumentPatch: DidDocumentPatch, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1916
2503
|
/**
|
|
1917
2504
|
* Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
|
|
1918
2505
|
* @param {*} [options] Override http request option.
|
|
@@ -1944,37 +2531,6 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1944
2531
|
* @throws {RequiredError}
|
|
1945
2532
|
*/
|
|
1946
2533
|
holderIdTokenSend: (walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1947
|
-
/**
|
|
1948
|
-
* Creates a new public Linked VP of specified credentials and adds it to the wallet\'s DID document
|
|
1949
|
-
* @param {string} walletId
|
|
1950
|
-
* @param {LinkedVpCreateRequest} [linkedVpCreateRequest]
|
|
1951
|
-
* @param {*} [options] Override http request option.
|
|
1952
|
-
* @throws {RequiredError}
|
|
1953
|
-
*/
|
|
1954
|
-
holderLinkedVpCreate: (walletId: string, linkedVpCreateRequest?: LinkedVpCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1955
|
-
/**
|
|
1956
|
-
* Deletes a linked VP
|
|
1957
|
-
* @param {string} walletId
|
|
1958
|
-
* @param {string} linkedVpId
|
|
1959
|
-
* @param {*} [options] Override http request option.
|
|
1960
|
-
* @throws {RequiredError}
|
|
1961
|
-
*/
|
|
1962
|
-
holderLinkedVpDelete: (walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1963
|
-
/**
|
|
1964
|
-
* Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
|
|
1965
|
-
* @param {string} walletId
|
|
1966
|
-
* @param {string} linkedVpId
|
|
1967
|
-
* @param {*} [options] Override http request option.
|
|
1968
|
-
* @throws {RequiredError}
|
|
1969
|
-
*/
|
|
1970
|
-
holderLinkedVpGetDetails: (walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1971
|
-
/**
|
|
1972
|
-
* Returns all linked Verifiable Presentations published in the wallet\'s DID document,
|
|
1973
|
-
* @param {string} walletId
|
|
1974
|
-
* @param {*} [options] Override http request option.
|
|
1975
|
-
* @throws {RequiredError}
|
|
1976
|
-
*/
|
|
1977
|
-
holderLinkedVpList: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1978
2534
|
/**
|
|
1979
2535
|
* Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
|
|
1980
2536
|
* @param {string} walletId
|
|
@@ -2014,6 +2570,15 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2014
2570
|
* @throws {RequiredError}
|
|
2015
2571
|
*/
|
|
2016
2572
|
issuerCredentialTypesList: (url: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2573
|
+
/**
|
|
2574
|
+
* Signs an opaque payload, such as an audit log entry, with the wallet\'s DID key, as a compact detached JWS with an unencoded payload (RFC 7515 Appendix F, RFC 7797: `b64: false`, `crit: [\"b64\"]`): `<protected header>..<signature>`. The signature is verified offline against the key in the wallet\'s DID document, with the payload put back. `typ` must be one the deployment allows, which no credential or presentation verifier accepts, so a signature from here never passes as a credential.
|
|
2575
|
+
* @param {string} walletId
|
|
2576
|
+
* @param {IssuerDetachedJwsSignRequest} issuerDetachedJwsSignRequest
|
|
2577
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
2578
|
+
* @param {*} [options] Override http request option.
|
|
2579
|
+
* @throws {RequiredError}
|
|
2580
|
+
*/
|
|
2581
|
+
issuerDetachedJwsSign: (walletId: string, issuerDetachedJwsSignRequest: IssuerDetachedJwsSignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2017
2582
|
/**
|
|
2018
2583
|
* Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
|
|
2019
2584
|
* @param {string} walletId
|
|
@@ -2073,6 +2638,37 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2073
2638
|
* @throws {RequiredError}
|
|
2074
2639
|
*/
|
|
2075
2640
|
pdfCredentialTwinUpload: (credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2641
|
+
/**
|
|
2642
|
+
* Creates a wallet for the caller from a pending enrollment, in the tenant. A state can be used once. A caller whose token names another tenant is refused.
|
|
2643
|
+
* @param {string} tenantId
|
|
2644
|
+
* @param {string} state The enrollment state from TenantEnrollmentInit.
|
|
2645
|
+
* @param {*} [options] Override http request option.
|
|
2646
|
+
* @throws {RequiredError}
|
|
2647
|
+
*/
|
|
2648
|
+
tenantEnrollmentEnroll: (tenantId: string, state: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2649
|
+
/**
|
|
2650
|
+
* Prepares a wallet for the tenant and returns a one-time enrollment state. Whoever presents the state to POST /tenant/{tenant_id}/enrollment/{state} gets a wallet created from the payload, in the tenant. Only a Tenant Owner of the tenant may call it. The payload is validated now; a tenantId it carries is ignored. The state is returned only here: the wallet keeps only its hash, which is the enrollment id.
|
|
2651
|
+
* @param {string} tenantId
|
|
2652
|
+
* @param {EnrollmentInitPayload} enrollmentInitPayload
|
|
2653
|
+
* @param {*} [options] Override http request option.
|
|
2654
|
+
* @throws {RequiredError}
|
|
2655
|
+
*/
|
|
2656
|
+
tenantEnrollmentInit: (tenantId: string, enrollmentInitPayload: EnrollmentInitPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2657
|
+
/**
|
|
2658
|
+
* Lists the tenant\'s pending enrollments, oldest first. Only a Tenant Owner of the tenant may.
|
|
2659
|
+
* @param {string} tenantId
|
|
2660
|
+
* @param {*} [options] Override http request option.
|
|
2661
|
+
* @throws {RequiredError}
|
|
2662
|
+
*/
|
|
2663
|
+
tenantEnrollmentList: (tenantId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2664
|
+
/**
|
|
2665
|
+
* Revokes a pending enrollment, so that its state no longer creates a wallet.
|
|
2666
|
+
* @param {string} tenantId
|
|
2667
|
+
* @param {string} enrollmentId
|
|
2668
|
+
* @param {*} [options] Override http request option.
|
|
2669
|
+
* @throws {RequiredError}
|
|
2670
|
+
*/
|
|
2671
|
+
tenantEnrollmentRevoke: (tenantId: string, enrollmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2076
2672
|
/**
|
|
2077
2673
|
* Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
|
|
2078
2674
|
* @param {string} walletId
|
|
@@ -2173,21 +2769,60 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2173
2769
|
*/
|
|
2174
2770
|
trustListsGet: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2175
2771
|
/**
|
|
2176
|
-
*
|
|
2772
|
+
* Removes a UNTP link from the wallet\'s DID document and stops serving its credential.
|
|
2177
2773
|
* @param {string} walletId
|
|
2178
|
-
* @param {
|
|
2774
|
+
* @param {string} serviceId The service id of the link, in full (`<did>#<fragment>`) or as its fragment.
|
|
2179
2775
|
* @param {*} [options] Override http request option.
|
|
2180
2776
|
* @throws {RequiredError}
|
|
2181
2777
|
*/
|
|
2182
|
-
|
|
2778
|
+
untpLinkDelete: (walletId: string, serviceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2779
|
+
/**
|
|
2780
|
+
* The UNTP links the wallet\'s DID document advertises for its published credentials.
|
|
2781
|
+
* @param {string} walletId
|
|
2782
|
+
* @param {*} [options] Override http request option.
|
|
2783
|
+
* @throws {RequiredError}
|
|
2784
|
+
*/
|
|
2785
|
+
untpLinkList: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2786
|
+
/**
|
|
2787
|
+
* Publishes an issued, valid W3C VCDM credential as a UNTP link: it is served at its public URL (`/api/v1/{wallet_id}/vc/{credential_id}`) and the wallet\'s DID document gets a service of the link type, whose endpoint is a link target to that URL. Publishing a credential again as the same link type returns the existing link. The wallet\'s DID document must be one it hosts (a self-hosted did:web, or an EBSI DID).
|
|
2788
|
+
* @param {string} walletId
|
|
2789
|
+
* @param {UntpLinkPublishRequest} untpLinkPublishRequest
|
|
2790
|
+
* @param {*} [options] Override http request option.
|
|
2791
|
+
* @throws {RequiredError}
|
|
2792
|
+
*/
|
|
2793
|
+
untpLinkPublish: (walletId: string, untpLinkPublishRequest: UntpLinkPublishRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2183
2794
|
/**
|
|
2184
|
-
*
|
|
2795
|
+
* Lists the registrars the wallet trusts to issue Digital Identity Anchors, and whether the wallet\'s own DID is one of them.
|
|
2185
2796
|
* @param {string} walletId
|
|
2186
|
-
* @param {string} did
|
|
2187
2797
|
* @param {*} [options] Override http request option.
|
|
2188
2798
|
* @throws {RequiredError}
|
|
2189
2799
|
*/
|
|
2190
|
-
|
|
2800
|
+
untpRegistryList: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2801
|
+
/**
|
|
2802
|
+
* Verifies a credential, given raw or by URL, with the wallet\'s trust framework, and reports each check: the signature (with the key the issuer\'s identifier resolves to), the validity dates, and, unless turned off, the JSON-LD document (W3C VCDM 2.0), the status, the schema and the issuer\'s trust. A credential that fails is still `200`, with `verified: false`; `code` reuses the error codes of `/verifier/untp/resolve`. A `url` must be https, and is never fetched from a private, loopback or link-local address, so a localhost URL is refused too. It is fetched within 10 s, 5 MiB and 3 redirects on the same host, and only as a credential media type.
|
|
2803
|
+
* @param {string} walletId
|
|
2804
|
+
* @param {VerifierCredentialRequest} verifierCredentialRequest
|
|
2805
|
+
* @param {*} [options] Override http request option.
|
|
2806
|
+
* @throws {RequiredError}
|
|
2807
|
+
*/
|
|
2808
|
+
verifierCredentialVerify: (walletId: string, verifierCredentialRequest: VerifierCredentialRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2809
|
+
/**
|
|
2810
|
+
* Verifies whether the wallet\'s trust framework trusts a DID, beyond resolving its key. A UNTP wallet requires a Digital Identity Anchor (UNTP 0.8.0, a profile of W3C Recognized Entities): the DID\'s DIA, found through its DID document\'s `https://test.uncefact.org/vocabulary/link-type/dia` service (or `untp:dia`), or a W3C `WhoisService`, is verified (signature, validity, status, the UNTP profile) and chained up, DIA by DIA, to a registrar the wallet trusts: its own (`UNTP.trustedRegistrars`), then the deployment\'s (`untp.dia.trustedRegistrars`, `untp.dia.registryUrl`). A registrar is itself trusted without a DIA. The details are in `untp`. A DID that is not trusted is still `200`, with `trusted: false` and the reasons in `failures`. With `credentialType`, the issuer policy for that credential type is evaluated too. A wallet whose trust framework does not verify DIDs is `422`.
|
|
2811
|
+
* @param {string} walletId
|
|
2812
|
+
* @param {string} did The DID to verify.
|
|
2813
|
+
* @param {string} [credentialType] Evaluate the issuer policy of this credential type, e.g. `DigitalProductPassport`.
|
|
2814
|
+
* @param {*} [options] Override http request option.
|
|
2815
|
+
* @throws {RequiredError}
|
|
2816
|
+
*/
|
|
2817
|
+
verifierDidVerify: (walletId: string, did: string, credentialType?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2818
|
+
/**
|
|
2819
|
+
* Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
|
|
2820
|
+
* @param {string} walletId
|
|
2821
|
+
* @param {VerifyInitRequest} [verifyInitRequest]
|
|
2822
|
+
* @param {*} [options] Override http request option.
|
|
2823
|
+
* @throws {RequiredError}
|
|
2824
|
+
*/
|
|
2825
|
+
verifierInitUrlCreate: (walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2191
2826
|
/**
|
|
2192
2827
|
* Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.
|
|
2193
2828
|
* @param {string} walletId
|
|
@@ -2200,6 +2835,26 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2200
2835
|
* @throws {RequiredError}
|
|
2201
2836
|
*/
|
|
2202
2837
|
verifierPdfVerify: (walletId: string, extractVp: boolean, pdf?: File, trustedCertificates?: Array<string>, trustedListsUrl?: Array<string>, trustedListSigningCertificates?: Array<string>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2838
|
+
/**
|
|
2839
|
+
* Renders a credential for a human with one of its `renderMethod` entries: a UNTP `RenderTemplate2024` (Handlebars, the output in its `mediaType`: `text/html`, the default, or `text/plain`) or a W3C `TemplateRenderMethod` of the `html` suite (a wrapper document to show in an `iframe` with `sandbox=\"allow-scripts\"` and `srcdoc`) or the `card` suite (a JSON card). By default the first method that can be rendered is used. A `signedVc` is verified (its signature, validity and status) before it is rendered, and `X-Credential-Verified` is `true`; one that fails is `422`. A `vc` is a credential document rendered as it is, with `X-Credential-Verified: false`. A credential with no render method that matches, or a method that cannot be rendered (`nfc`, a template of another `mediaType`, or an unknown type), is `422` with `no render method` or `render suite unsupported`; an invalid one is `422` with `invalid render method`, a template that cannot be fetched or does not match its digest `render template unavailable`, and one that fails or runs too long `render failed`. A remote template is fetched over https only, within 5 s and 1 MiB, and must match its `digestMultibase`. Rendering stops after 2 s or 1 MiB of output. A template that runs on past that still counts against the renderings the wallet runs at once (`render.maxConcurrent`); when none is free, the response is `503`.
|
|
2840
|
+
* @param {string} walletId
|
|
2841
|
+
* @param {VerifierRenderRequest} verifierRenderRequest
|
|
2842
|
+
* @param {*} [options] Override http request option.
|
|
2843
|
+
* @throws {RequiredError}
|
|
2844
|
+
*/
|
|
2845
|
+
verifierRender: (walletId: string, verifierRenderRequest: VerifierRenderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2846
|
+
/**
|
|
2847
|
+
* Resolves a DID into the RFC 9264 linkset of the UNTP links its DID document advertises and, with `fetch`, fetches the linked credentials and verifies them. A credential that fails is reported in `credentials` and `verification.failed`, with the response still 200: `verification.ok` is the verdict.
|
|
2848
|
+
* @param {string} walletId
|
|
2849
|
+
* @param {string} identifier The DID to resolve.
|
|
2850
|
+
* @param {string} [linkType] The link types to fetch, comma separated (e.g. `dpp,dcc`), or `all` (the default). The linkset uses the UNTP 0.8.0 relations: `dpp`, `linkset` for an identity resolver, and `https://test.uncefact.org/vocabulary/link-type/<type>` for the others. A DID document\'s UNTP 0.7 service types (`untp:dia`, bare `dcc`) are read as the same link types.
|
|
2851
|
+
* @param {boolean} [fetch] Fetch and verify the linked credentials.
|
|
2852
|
+
* @param {boolean} [verify] Verify the fetched credentials\' dates, status and schema, besides their signature.
|
|
2853
|
+
* @param {boolean} [verifyIssuer] Also verify whether the wallet\'s trust framework trusts the DID, as `/verifier/did` does, and report it as `issuer`. A wallet whose trust framework does not verify DIDs reports no `issuer`, and is `422` when `verifyIssuer` is set explicitly. A UNTP wallet enforces the anchor on every signature anyway; this reports it.
|
|
2854
|
+
* @param {*} [options] Override http request option.
|
|
2855
|
+
* @throws {RequiredError}
|
|
2856
|
+
*/
|
|
2857
|
+
verifierUntpResolve: (walletId: string, identifier: string, linkType?: string, fetch?: boolean, verify?: boolean, verifyIssuer?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2203
2858
|
/**
|
|
2204
2859
|
* Creates a new wallet for the authenticated client.
|
|
2205
2860
|
* @param {WalletCreatePayload} [walletCreatePayload]
|
|
@@ -2239,10 +2894,11 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2239
2894
|
* Provides list of wallets owned by the authenticated client, sorted by wallet name in byte order (Unicode code point order of the UTF-8 name, so upper case sorts before lower case). Wallets with the same name are in the order they were created.
|
|
2240
2895
|
* @param {string} [ownerId]
|
|
2241
2896
|
* @param {string} [searchName] Wallet name to search using \"begins-with\" filter
|
|
2897
|
+
* @param {string} [tenantId] Lists the wallets of every owner in this tenant instead, each with its ownerId. Only a Tenant Owner of the tenant may set it, and not together with ownerId.
|
|
2242
2898
|
* @param {*} [options] Override http request option.
|
|
2243
2899
|
* @throws {RequiredError}
|
|
2244
2900
|
*/
|
|
2245
|
-
walletList: (ownerId?: string, searchName?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2901
|
+
walletList: (ownerId?: string, searchName?: string, tenantId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2246
2902
|
/**
|
|
2247
2903
|
* Gets a specific notification by state
|
|
2248
2904
|
* @param {string} walletId Wallet ID
|
|
@@ -2275,7 +2931,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
|
|
|
2275
2931
|
*/
|
|
2276
2932
|
walletNotifications: (walletId: string, eventType?: string, state?: string, lastEventID?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2277
2933
|
/**
|
|
2278
|
-
* Update wallet metadata and configuration.
|
|
2934
|
+
* Update wallet metadata and configuration. The owner of the wallet patches its name, config and metadata; `config.tenant` is ignored for them. A Tenant Owner of the wallet\'s tenant patches `config.tenant.issuerProxyUrl`, also of wallets of other owners, and for those every other field of the body is ignored. `config.tenant.tenantId` never changes.
|
|
2279
2935
|
* @param {string} walletId
|
|
2280
2936
|
* @param {WalletPatchPayload} [walletPatchPayload]
|
|
2281
2937
|
* @param {*} [options] Override http request option.
|
|
@@ -2496,6 +3152,16 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2496
3152
|
* @throws {RequiredError}
|
|
2497
3153
|
*/
|
|
2498
3154
|
credentialIssuanceInit(credentialId: string, walletId: string, credentialIssuanceInit?: CredentialIssuanceInit, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIssuanceInitResult>>;
|
|
3155
|
+
/**
|
|
3156
|
+
* Issues a W3C VCDM draft as a credential of the wallet itself, with no holder and no OID4VCI: for a credential that is published rather than handed to anyone, such as a UNTP Digital Product Passport (EN 18246 Annex B.5). The credential gets the wallet\'s status list entry and envelope, and is stored issued on the same record. With `publish`, it is then published as a UNTP link, like `POST /untp/links`; if that fails the response is `502` with the issued `credentialId`, and publishing is retried with `POST /untp/links`.
|
|
3157
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
3158
|
+
* @param {string} walletId
|
|
3159
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
3160
|
+
* @param {CredentialIssueDirectRequest} [credentialIssueDirectRequest]
|
|
3161
|
+
* @param {*} [options] Override http request option.
|
|
3162
|
+
* @throws {RequiredError}
|
|
3163
|
+
*/
|
|
3164
|
+
credentialIssueDirect(credentialId: string, walletId: string, idempotencyKey?: string, credentialIssueDirectRequest?: CredentialIssueDirectRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CredentialIssueDirectResult>>;
|
|
2499
3165
|
/**
|
|
2500
3166
|
* Retrieves a list of credentials.
|
|
2501
3167
|
* @param {string} walletId
|
|
@@ -2548,6 +3214,25 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2548
3214
|
* @throws {RequiredError}
|
|
2549
3215
|
*/
|
|
2550
3216
|
credentialRawGet(credentialId: string, walletId: string, disclosedClaims?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
3217
|
+
/**
|
|
3218
|
+
* Renders a W3C VCDM credential of the wallet with one of its `renderMethod` entries, as `POST /verifier/render` does. HTML is served with a `Content-Security-Policy` that sandboxes it.
|
|
3219
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
3220
|
+
* @param {string} walletId
|
|
3221
|
+
* @param {number} [index] The index of the render method to use, in the credential\'s `renderMethod`.
|
|
3222
|
+
* @param {RenderSuite} [suite] Use the first render method of this suite.
|
|
3223
|
+
* @param {string} [mediaQuery] Use the first render method with exactly this `mediaQuery`.
|
|
3224
|
+
* @param {*} [options] Override http request option.
|
|
3225
|
+
* @throws {RequiredError}
|
|
3226
|
+
*/
|
|
3227
|
+
credentialRender(credentialId: string, walletId: string, index?: number, suite?: RenderSuite, mediaQuery?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3228
|
+
/**
|
|
3229
|
+
* Lists the render methods of a W3C VCDM credential of the wallet, for a client to pick one by its media query: media queries are not evaluated by the wallet.
|
|
3230
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
3231
|
+
* @param {string} walletId
|
|
3232
|
+
* @param {*} [options] Override http request option.
|
|
3233
|
+
* @throws {RequiredError}
|
|
3234
|
+
*/
|
|
3235
|
+
credentialRenderMethods(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<RenderMethodInfo>>>;
|
|
2551
3236
|
/**
|
|
2552
3237
|
* Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
|
|
2553
3238
|
* @param {string} walletId
|
|
@@ -2557,13 +3242,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2557
3242
|
*/
|
|
2558
3243
|
credentialRequestInit(walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
|
|
2559
3244
|
/**
|
|
2560
|
-
* Revoke a specific Verifiable Credential
|
|
3245
|
+
* Revoke a specific Verifiable Credential. A credential published as a UNTP link stays published: a verifier following its link finds it and verifies it as revoked. `DELETE /untp/links/{service_id}` unpublishes it.
|
|
2561
3246
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
2562
3247
|
* @param {string} walletId
|
|
3248
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
2563
3249
|
* @param {*} [options] Override http request option.
|
|
2564
3250
|
* @throws {RequiredError}
|
|
2565
3251
|
*/
|
|
2566
|
-
credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3252
|
+
credentialRevoke(credentialId: string, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2567
3253
|
/**
|
|
2568
3254
|
* Suspend a Verifiable Credential issued with the `suspension` status purpose (W3C Bitstring Status List v1.0). A suspension can be lifted with `DELETE`.
|
|
2569
3255
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
@@ -2595,6 +3281,25 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2595
3281
|
* @throws {RequiredError}
|
|
2596
3282
|
*/
|
|
2597
3283
|
didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
3284
|
+
/**
|
|
3285
|
+
* Returns the wallet\'s own DID document, as published at `/{wallet_id}/did.json` for a self-hosted did:web.
|
|
3286
|
+
* @param {string} walletId
|
|
3287
|
+
* @param {*} [options] Override http request option.
|
|
3288
|
+
* @throws {RequiredError}
|
|
3289
|
+
*/
|
|
3290
|
+
didDocumentLocalGet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3291
|
+
[key: string]: any;
|
|
3292
|
+
}>>;
|
|
3293
|
+
/**
|
|
3294
|
+
* Changes the wallet\'s DID document: removes the services in `removeServiceIds`, adds the services in `addServices` (a service with the same id is replaced), and, when `alsoKnownAs` is set, replaces the subject\'s other identifiers (an empty list removes them). UNTP identifies an entity\'s Digital Identity Anchor with a service of type `https://test.uncefact.org/vocabulary/link-type/dia` (`untp:dia` in UNTP 0.7) and registered identifiers with `alsoKnownAs`. Only a self-hosted did:web document can be changed; services of an EBSI DID are written to the EBSI DID registry, which does not take `alsoKnownAs`.
|
|
3295
|
+
* @param {string} walletId
|
|
3296
|
+
* @param {DidDocumentPatch} didDocumentPatch
|
|
3297
|
+
* @param {*} [options] Override http request option.
|
|
3298
|
+
* @throws {RequiredError}
|
|
3299
|
+
*/
|
|
3300
|
+
didDocumentPatch(walletId: string, didDocumentPatch: DidDocumentPatch, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
|
|
3301
|
+
[key: string]: any;
|
|
3302
|
+
}>>;
|
|
2598
3303
|
/**
|
|
2599
3304
|
* Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
|
|
2600
3305
|
* @param {*} [options] Override http request option.
|
|
@@ -2626,37 +3331,6 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2626
3331
|
* @throws {RequiredError}
|
|
2627
3332
|
*/
|
|
2628
3333
|
holderIdTokenSend(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PresentationResponse>>;
|
|
2629
|
-
/**
|
|
2630
|
-
* Creates a new public Linked VP of specified credentials and adds it to the wallet\'s DID document
|
|
2631
|
-
* @param {string} walletId
|
|
2632
|
-
* @param {LinkedVpCreateRequest} [linkedVpCreateRequest]
|
|
2633
|
-
* @param {*} [options] Override http request option.
|
|
2634
|
-
* @throws {RequiredError}
|
|
2635
|
-
*/
|
|
2636
|
-
holderLinkedVpCreate(walletId: string, linkedVpCreateRequest?: LinkedVpCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkedVpMetadata>>;
|
|
2637
|
-
/**
|
|
2638
|
-
* Deletes a linked VP
|
|
2639
|
-
* @param {string} walletId
|
|
2640
|
-
* @param {string} linkedVpId
|
|
2641
|
-
* @param {*} [options] Override http request option.
|
|
2642
|
-
* @throws {RequiredError}
|
|
2643
|
-
*/
|
|
2644
|
-
holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2645
|
-
/**
|
|
2646
|
-
* Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
|
|
2647
|
-
* @param {string} walletId
|
|
2648
|
-
* @param {string} linkedVpId
|
|
2649
|
-
* @param {*} [options] Override http request option.
|
|
2650
|
-
* @throws {RequiredError}
|
|
2651
|
-
*/
|
|
2652
|
-
holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkedVpMetadata>>;
|
|
2653
|
-
/**
|
|
2654
|
-
* Returns all linked Verifiable Presentations published in the wallet\'s DID document,
|
|
2655
|
-
* @param {string} walletId
|
|
2656
|
-
* @param {*} [options] Override http request option.
|
|
2657
|
-
* @throws {RequiredError}
|
|
2658
|
-
*/
|
|
2659
|
-
holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LinkedVpMetadata>>>;
|
|
2660
3334
|
/**
|
|
2661
3335
|
* Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
|
|
2662
3336
|
* @param {string} walletId
|
|
@@ -2696,6 +3370,15 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2696
3370
|
* @throws {RequiredError}
|
|
2697
3371
|
*/
|
|
2698
3372
|
issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CredentialType>>>;
|
|
3373
|
+
/**
|
|
3374
|
+
* Signs an opaque payload, such as an audit log entry, with the wallet\'s DID key, as a compact detached JWS with an unencoded payload (RFC 7515 Appendix F, RFC 7797: `b64: false`, `crit: [\"b64\"]`): `<protected header>..<signature>`. The signature is verified offline against the key in the wallet\'s DID document, with the payload put back. `typ` must be one the deployment allows, which no credential or presentation verifier accepts, so a signature from here never passes as a credential.
|
|
3375
|
+
* @param {string} walletId
|
|
3376
|
+
* @param {IssuerDetachedJwsSignRequest} issuerDetachedJwsSignRequest
|
|
3377
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
3378
|
+
* @param {*} [options] Override http request option.
|
|
3379
|
+
* @throws {RequiredError}
|
|
3380
|
+
*/
|
|
3381
|
+
issuerDetachedJwsSign(walletId: string, issuerDetachedJwsSignRequest: IssuerDetachedJwsSignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IssuerDetachedJwsSignResult>>;
|
|
2699
3382
|
/**
|
|
2700
3383
|
* Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
|
|
2701
3384
|
* @param {string} walletId
|
|
@@ -2755,6 +3438,37 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2755
3438
|
* @throws {RequiredError}
|
|
2756
3439
|
*/
|
|
2757
3440
|
pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3441
|
+
/**
|
|
3442
|
+
* Creates a wallet for the caller from a pending enrollment, in the tenant. A state can be used once. A caller whose token names another tenant is refused.
|
|
3443
|
+
* @param {string} tenantId
|
|
3444
|
+
* @param {string} state The enrollment state from TenantEnrollmentInit.
|
|
3445
|
+
* @param {*} [options] Override http request option.
|
|
3446
|
+
* @throws {RequiredError}
|
|
3447
|
+
*/
|
|
3448
|
+
tenantEnrollmentEnroll(tenantId: string, state: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WalletIdObject>>;
|
|
3449
|
+
/**
|
|
3450
|
+
* Prepares a wallet for the tenant and returns a one-time enrollment state. Whoever presents the state to POST /tenant/{tenant_id}/enrollment/{state} gets a wallet created from the payload, in the tenant. Only a Tenant Owner of the tenant may call it. The payload is validated now; a tenantId it carries is ignored. The state is returned only here: the wallet keeps only its hash, which is the enrollment id.
|
|
3451
|
+
* @param {string} tenantId
|
|
3452
|
+
* @param {EnrollmentInitPayload} enrollmentInitPayload
|
|
3453
|
+
* @param {*} [options] Override http request option.
|
|
3454
|
+
* @throws {RequiredError}
|
|
3455
|
+
*/
|
|
3456
|
+
tenantEnrollmentInit(tenantId: string, enrollmentInitPayload: EnrollmentInitPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EnrollmentInitResponse>>;
|
|
3457
|
+
/**
|
|
3458
|
+
* Lists the tenant\'s pending enrollments, oldest first. Only a Tenant Owner of the tenant may.
|
|
3459
|
+
* @param {string} tenantId
|
|
3460
|
+
* @param {*} [options] Override http request option.
|
|
3461
|
+
* @throws {RequiredError}
|
|
3462
|
+
*/
|
|
3463
|
+
tenantEnrollmentList(tenantId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EnrollmentListItem>>>;
|
|
3464
|
+
/**
|
|
3465
|
+
* Revokes a pending enrollment, so that its state no longer creates a wallet.
|
|
3466
|
+
* @param {string} tenantId
|
|
3467
|
+
* @param {string} enrollmentId
|
|
3468
|
+
* @param {*} [options] Override http request option.
|
|
3469
|
+
* @throws {RequiredError}
|
|
3470
|
+
*/
|
|
3471
|
+
tenantEnrollmentRevoke(tenantId: string, enrollmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2758
3472
|
/**
|
|
2759
3473
|
* Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
|
|
2760
3474
|
* @param {string} walletId
|
|
@@ -2833,43 +3547,82 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2833
3547
|
* @param {*} [options] Override http request option.
|
|
2834
3548
|
* @throws {RequiredError}
|
|
2835
3549
|
*/
|
|
2836
|
-
trustListAdd(trustListAddRequest?: TrustListAddRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3550
|
+
trustListAdd(trustListAddRequest?: TrustListAddRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3551
|
+
/**
|
|
3552
|
+
* Stops tracking the trusted list published at the given URL and removes its contents. Removing a List of Trusted Lists removes the lists reached through it as well. Requires the `admin` role and the `trustListProviderPostgres` provider. A wallet whose configuration still names this list will register it again the next time it verifies against it.
|
|
3553
|
+
* @param {string} url The URL the trusted list is published at.
|
|
3554
|
+
* @param {*} [options] Override http request option.
|
|
3555
|
+
* @throws {RequiredError}
|
|
3556
|
+
*/
|
|
3557
|
+
trustListDelete(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3558
|
+
/**
|
|
3559
|
+
* Refetches the tracked trusted list published at the given URL and stores what it fetched, whether or not the publisher has issued a new version of it. This is what separates a forced refresh from the sweep the wallet makes on its own interval, which leaves an unchanged list alone. Requires the `admin` role and the `trustListProviderPostgres` provider. The refetch is pinned to the certificate already recorded for the list, so a list cannot be moved onto a new signer by refreshing it: one signed by a different certificate is rejected with 409 and the stored copy is kept.
|
|
3560
|
+
* @param {string} url The URL the trusted list is published at.
|
|
3561
|
+
* @param {*} [options] Override http request option.
|
|
3562
|
+
* @throws {RequiredError}
|
|
3563
|
+
*/
|
|
3564
|
+
trustListRefresh(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3565
|
+
/**
|
|
3566
|
+
* Lists the trusted lists the wallet tracks. Requires the `admin` role, and a wallet configured with the `trustListProviderPostgres` trust list provider: one that fetches its lists from their publisher as it needs them tracks nothing, and answers 501. A list reached through a List of Trusted Lists is not a source of its own and is not returned here. It is refreshed and removed along with the list that points at it.
|
|
3567
|
+
* @param {*} [options] Override http request option.
|
|
3568
|
+
* @throws {RequiredError}
|
|
3569
|
+
*/
|
|
3570
|
+
trustListsGet(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TrustListsResponse>>;
|
|
3571
|
+
/**
|
|
3572
|
+
* Removes a UNTP link from the wallet\'s DID document and stops serving its credential.
|
|
3573
|
+
* @param {string} walletId
|
|
3574
|
+
* @param {string} serviceId The service id of the link, in full (`<did>#<fragment>`) or as its fragment.
|
|
3575
|
+
* @param {*} [options] Override http request option.
|
|
3576
|
+
* @throws {RequiredError}
|
|
3577
|
+
*/
|
|
3578
|
+
untpLinkDelete(walletId: string, serviceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3579
|
+
/**
|
|
3580
|
+
* The UNTP links the wallet\'s DID document advertises for its published credentials.
|
|
3581
|
+
* @param {string} walletId
|
|
3582
|
+
* @param {*} [options] Override http request option.
|
|
3583
|
+
* @throws {RequiredError}
|
|
3584
|
+
*/
|
|
3585
|
+
untpLinkList(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UntpLink>>>;
|
|
2837
3586
|
/**
|
|
2838
|
-
*
|
|
2839
|
-
* @param {string}
|
|
3587
|
+
* Publishes an issued, valid W3C VCDM credential as a UNTP link: it is served at its public URL (`/api/v1/{wallet_id}/vc/{credential_id}`) and the wallet\'s DID document gets a service of the link type, whose endpoint is a link target to that URL. Publishing a credential again as the same link type returns the existing link. The wallet\'s DID document must be one it hosts (a self-hosted did:web, or an EBSI DID).
|
|
3588
|
+
* @param {string} walletId
|
|
3589
|
+
* @param {UntpLinkPublishRequest} untpLinkPublishRequest
|
|
2840
3590
|
* @param {*} [options] Override http request option.
|
|
2841
3591
|
* @throws {RequiredError}
|
|
2842
3592
|
*/
|
|
2843
|
-
|
|
3593
|
+
untpLinkPublish(walletId: string, untpLinkPublishRequest: UntpLinkPublishRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UntpLink>>;
|
|
2844
3594
|
/**
|
|
2845
|
-
*
|
|
2846
|
-
* @param {string}
|
|
3595
|
+
* Lists the registrars the wallet trusts to issue Digital Identity Anchors, and whether the wallet\'s own DID is one of them.
|
|
3596
|
+
* @param {string} walletId
|
|
2847
3597
|
* @param {*} [options] Override http request option.
|
|
2848
3598
|
* @throws {RequiredError}
|
|
2849
3599
|
*/
|
|
2850
|
-
|
|
3600
|
+
untpRegistryList(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UntpRegistry>>;
|
|
2851
3601
|
/**
|
|
2852
|
-
*
|
|
3602
|
+
* Verifies a credential, given raw or by URL, with the wallet\'s trust framework, and reports each check: the signature (with the key the issuer\'s identifier resolves to), the validity dates, and, unless turned off, the JSON-LD document (W3C VCDM 2.0), the status, the schema and the issuer\'s trust. A credential that fails is still `200`, with `verified: false`; `code` reuses the error codes of `/verifier/untp/resolve`. A `url` must be https, and is never fetched from a private, loopback or link-local address, so a localhost URL is refused too. It is fetched within 10 s, 5 MiB and 3 redirects on the same host, and only as a credential media type.
|
|
3603
|
+
* @param {string} walletId
|
|
3604
|
+
* @param {VerifierCredentialRequest} verifierCredentialRequest
|
|
2853
3605
|
* @param {*} [options] Override http request option.
|
|
2854
3606
|
* @throws {RequiredError}
|
|
2855
3607
|
*/
|
|
2856
|
-
|
|
3608
|
+
verifierCredentialVerify(walletId: string, verifierCredentialRequest: VerifierCredentialRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifierCredentialResult>>;
|
|
2857
3609
|
/**
|
|
2858
|
-
*
|
|
3610
|
+
* Verifies whether the wallet\'s trust framework trusts a DID, beyond resolving its key. A UNTP wallet requires a Digital Identity Anchor (UNTP 0.8.0, a profile of W3C Recognized Entities): the DID\'s DIA, found through its DID document\'s `https://test.uncefact.org/vocabulary/link-type/dia` service (or `untp:dia`), or a W3C `WhoisService`, is verified (signature, validity, status, the UNTP profile) and chained up, DIA by DIA, to a registrar the wallet trusts: its own (`UNTP.trustedRegistrars`), then the deployment\'s (`untp.dia.trustedRegistrars`, `untp.dia.registryUrl`). A registrar is itself trusted without a DIA. The details are in `untp`. A DID that is not trusted is still `200`, with `trusted: false` and the reasons in `failures`. With `credentialType`, the issuer policy for that credential type is evaluated too. A wallet whose trust framework does not verify DIDs is `422`.
|
|
2859
3611
|
* @param {string} walletId
|
|
2860
|
-
* @param {
|
|
3612
|
+
* @param {string} did The DID to verify.
|
|
3613
|
+
* @param {string} [credentialType] Evaluate the issuer policy of this credential type, e.g. `DigitalProductPassport`.
|
|
2861
3614
|
* @param {*} [options] Override http request option.
|
|
2862
3615
|
* @throws {RequiredError}
|
|
2863
3616
|
*/
|
|
2864
|
-
|
|
3617
|
+
verifierDidVerify(walletId: string, did: string, credentialType?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DidVerification>>;
|
|
2865
3618
|
/**
|
|
2866
|
-
*
|
|
3619
|
+
* Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
|
|
2867
3620
|
* @param {string} walletId
|
|
2868
|
-
* @param {
|
|
3621
|
+
* @param {VerifyInitRequest} [verifyInitRequest]
|
|
2869
3622
|
* @param {*} [options] Override http request option.
|
|
2870
3623
|
* @throws {RequiredError}
|
|
2871
3624
|
*/
|
|
2872
|
-
|
|
3625
|
+
verifierInitUrlCreate(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VerifyInitResponse>>;
|
|
2873
3626
|
/**
|
|
2874
3627
|
* Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.
|
|
2875
3628
|
* @param {string} walletId
|
|
@@ -2882,6 +3635,26 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2882
3635
|
* @throws {RequiredError}
|
|
2883
3636
|
*/
|
|
2884
3637
|
verifierPdfVerify(walletId: string, extractVp: boolean, pdf?: File, trustedCertificates?: Array<string>, trustedListsUrl?: Array<string>, trustedListSigningCertificates?: Array<string>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PdfVerificationResponse>>;
|
|
3638
|
+
/**
|
|
3639
|
+
* Renders a credential for a human with one of its `renderMethod` entries: a UNTP `RenderTemplate2024` (Handlebars, the output in its `mediaType`: `text/html`, the default, or `text/plain`) or a W3C `TemplateRenderMethod` of the `html` suite (a wrapper document to show in an `iframe` with `sandbox=\"allow-scripts\"` and `srcdoc`) or the `card` suite (a JSON card). By default the first method that can be rendered is used. A `signedVc` is verified (its signature, validity and status) before it is rendered, and `X-Credential-Verified` is `true`; one that fails is `422`. A `vc` is a credential document rendered as it is, with `X-Credential-Verified: false`. A credential with no render method that matches, or a method that cannot be rendered (`nfc`, a template of another `mediaType`, or an unknown type), is `422` with `no render method` or `render suite unsupported`; an invalid one is `422` with `invalid render method`, a template that cannot be fetched or does not match its digest `render template unavailable`, and one that fails or runs too long `render failed`. A remote template is fetched over https only, within 5 s and 1 MiB, and must match its `digestMultibase`. Rendering stops after 2 s or 1 MiB of output. A template that runs on past that still counts against the renderings the wallet runs at once (`render.maxConcurrent`); when none is free, the response is `503`.
|
|
3640
|
+
* @param {string} walletId
|
|
3641
|
+
* @param {VerifierRenderRequest} verifierRenderRequest
|
|
3642
|
+
* @param {*} [options] Override http request option.
|
|
3643
|
+
* @throws {RequiredError}
|
|
3644
|
+
*/
|
|
3645
|
+
verifierRender(walletId: string, verifierRenderRequest: VerifierRenderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
3646
|
+
/**
|
|
3647
|
+
* Resolves a DID into the RFC 9264 linkset of the UNTP links its DID document advertises and, with `fetch`, fetches the linked credentials and verifies them. A credential that fails is reported in `credentials` and `verification.failed`, with the response still 200: `verification.ok` is the verdict.
|
|
3648
|
+
* @param {string} walletId
|
|
3649
|
+
* @param {string} identifier The DID to resolve.
|
|
3650
|
+
* @param {string} [linkType] The link types to fetch, comma separated (e.g. `dpp,dcc`), or `all` (the default). The linkset uses the UNTP 0.8.0 relations: `dpp`, `linkset` for an identity resolver, and `https://test.uncefact.org/vocabulary/link-type/<type>` for the others. A DID document\'s UNTP 0.7 service types (`untp:dia`, bare `dcc`) are read as the same link types.
|
|
3651
|
+
* @param {boolean} [fetch] Fetch and verify the linked credentials.
|
|
3652
|
+
* @param {boolean} [verify] Verify the fetched credentials\' dates, status and schema, besides their signature.
|
|
3653
|
+
* @param {boolean} [verifyIssuer] Also verify whether the wallet\'s trust framework trusts the DID, as `/verifier/did` does, and report it as `issuer`. A wallet whose trust framework does not verify DIDs reports no `issuer`, and is `422` when `verifyIssuer` is set explicitly. A UNTP wallet enforces the anchor on every signature anyway; this reports it.
|
|
3654
|
+
* @param {*} [options] Override http request option.
|
|
3655
|
+
* @throws {RequiredError}
|
|
3656
|
+
*/
|
|
3657
|
+
verifierUntpResolve(walletId: string, identifier: string, linkType?: string, fetch?: boolean, verify?: boolean, verifyIssuer?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UntpResolveResult>>;
|
|
2885
3658
|
/**
|
|
2886
3659
|
* Creates a new wallet for the authenticated client.
|
|
2887
3660
|
* @param {WalletCreatePayload} [walletCreatePayload]
|
|
@@ -2923,10 +3696,11 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2923
3696
|
* Provides list of wallets owned by the authenticated client, sorted by wallet name in byte order (Unicode code point order of the UTF-8 name, so upper case sorts before lower case). Wallets with the same name are in the order they were created.
|
|
2924
3697
|
* @param {string} [ownerId]
|
|
2925
3698
|
* @param {string} [searchName] Wallet name to search using \"begins-with\" filter
|
|
3699
|
+
* @param {string} [tenantId] Lists the wallets of every owner in this tenant instead, each with its ownerId. Only a Tenant Owner of the tenant may set it, and not together with ownerId.
|
|
2926
3700
|
* @param {*} [options] Override http request option.
|
|
2927
3701
|
* @throws {RequiredError}
|
|
2928
3702
|
*/
|
|
2929
|
-
walletList(ownerId?: string, searchName?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WalletListItem>>>;
|
|
3703
|
+
walletList(ownerId?: string, searchName?: string, tenantId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WalletListItem>>>;
|
|
2930
3704
|
/**
|
|
2931
3705
|
* Gets a specific notification by state
|
|
2932
3706
|
* @param {string} walletId Wallet ID
|
|
@@ -2959,7 +3733,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
|
|
|
2959
3733
|
*/
|
|
2960
3734
|
walletNotifications(walletId: string, eventType?: string, state?: string, lastEventID?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2961
3735
|
/**
|
|
2962
|
-
* Update wallet metadata and configuration.
|
|
3736
|
+
* Update wallet metadata and configuration. The owner of the wallet patches its name, config and metadata; `config.tenant` is ignored for them. A Tenant Owner of the wallet\'s tenant patches `config.tenant.issuerProxyUrl`, also of wallets of other owners, and for those every other field of the body is ignored. `config.tenant.tenantId` never changes.
|
|
2963
3737
|
* @param {string} walletId
|
|
2964
3738
|
* @param {WalletPatchPayload} [walletPatchPayload]
|
|
2965
3739
|
* @param {*} [options] Override http request option.
|
|
@@ -3180,6 +3954,16 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3180
3954
|
* @throws {RequiredError}
|
|
3181
3955
|
*/
|
|
3182
3956
|
credentialIssuanceInit(credentialId: string, walletId: string, credentialIssuanceInit?: CredentialIssuanceInit, options?: RawAxiosRequestConfig): AxiosPromise<CredentialIssuanceInitResult>;
|
|
3957
|
+
/**
|
|
3958
|
+
* Issues a W3C VCDM draft as a credential of the wallet itself, with no holder and no OID4VCI: for a credential that is published rather than handed to anyone, such as a UNTP Digital Product Passport (EN 18246 Annex B.5). The credential gets the wallet\'s status list entry and envelope, and is stored issued on the same record. With `publish`, it is then published as a UNTP link, like `POST /untp/links`; if that fails the response is `502` with the issued `credentialId`, and publishing is retried with `POST /untp/links`.
|
|
3959
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
3960
|
+
* @param {string} walletId
|
|
3961
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
3962
|
+
* @param {CredentialIssueDirectRequest} [credentialIssueDirectRequest]
|
|
3963
|
+
* @param {*} [options] Override http request option.
|
|
3964
|
+
* @throws {RequiredError}
|
|
3965
|
+
*/
|
|
3966
|
+
credentialIssueDirect(credentialId: string, walletId: string, idempotencyKey?: string, credentialIssueDirectRequest?: CredentialIssueDirectRequest, options?: RawAxiosRequestConfig): AxiosPromise<CredentialIssueDirectResult>;
|
|
3183
3967
|
/**
|
|
3184
3968
|
* Retrieves a list of credentials.
|
|
3185
3969
|
* @param {string} walletId
|
|
@@ -3232,6 +4016,25 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3232
4016
|
* @throws {RequiredError}
|
|
3233
4017
|
*/
|
|
3234
4018
|
credentialRawGet(credentialId: string, walletId: string, disclosedClaims?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
4019
|
+
/**
|
|
4020
|
+
* Renders a W3C VCDM credential of the wallet with one of its `renderMethod` entries, as `POST /verifier/render` does. HTML is served with a `Content-Security-Policy` that sandboxes it.
|
|
4021
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
4022
|
+
* @param {string} walletId
|
|
4023
|
+
* @param {number} [index] The index of the render method to use, in the credential\'s `renderMethod`.
|
|
4024
|
+
* @param {RenderSuite} [suite] Use the first render method of this suite.
|
|
4025
|
+
* @param {string} [mediaQuery] Use the first render method with exactly this `mediaQuery`.
|
|
4026
|
+
* @param {*} [options] Override http request option.
|
|
4027
|
+
* @throws {RequiredError}
|
|
4028
|
+
*/
|
|
4029
|
+
credentialRender(credentialId: string, walletId: string, index?: number, suite?: RenderSuite, mediaQuery?: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
4030
|
+
/**
|
|
4031
|
+
* Lists the render methods of a W3C VCDM credential of the wallet, for a client to pick one by its media query: media queries are not evaluated by the wallet.
|
|
4032
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
4033
|
+
* @param {string} walletId
|
|
4034
|
+
* @param {*} [options] Override http request option.
|
|
4035
|
+
* @throws {RequiredError}
|
|
4036
|
+
*/
|
|
4037
|
+
credentialRenderMethods(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<RenderMethodInfo>>;
|
|
3235
4038
|
/**
|
|
3236
4039
|
* Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
|
|
3237
4040
|
* @param {string} walletId
|
|
@@ -3241,13 +4044,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3241
4044
|
*/
|
|
3242
4045
|
credentialRequestInit(walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
|
|
3243
4046
|
/**
|
|
3244
|
-
* Revoke a specific Verifiable Credential
|
|
4047
|
+
* Revoke a specific Verifiable Credential. A credential published as a UNTP link stays published: a verifier following its link finds it and verifies it as revoked. `DELETE /untp/links/{service_id}` unpublishes it.
|
|
3245
4048
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
3246
4049
|
* @param {string} walletId
|
|
4050
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
3247
4051
|
* @param {*} [options] Override http request option.
|
|
3248
4052
|
* @throws {RequiredError}
|
|
3249
4053
|
*/
|
|
3250
|
-
credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4054
|
+
credentialRevoke(credentialId: string, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3251
4055
|
/**
|
|
3252
4056
|
* Suspend a Verifiable Credential issued with the `suspension` status purpose (W3C Bitstring Status List v1.0). A suspension can be lifted with `DELETE`.
|
|
3253
4057
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
@@ -3279,6 +4083,25 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3279
4083
|
* @throws {RequiredError}
|
|
3280
4084
|
*/
|
|
3281
4085
|
didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
|
|
4086
|
+
/**
|
|
4087
|
+
* Returns the wallet\'s own DID document, as published at `/{wallet_id}/did.json` for a self-hosted did:web.
|
|
4088
|
+
* @param {string} walletId
|
|
4089
|
+
* @param {*} [options] Override http request option.
|
|
4090
|
+
* @throws {RequiredError}
|
|
4091
|
+
*/
|
|
4092
|
+
didDocumentLocalGet(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
4093
|
+
[key: string]: any;
|
|
4094
|
+
}>;
|
|
4095
|
+
/**
|
|
4096
|
+
* Changes the wallet\'s DID document: removes the services in `removeServiceIds`, adds the services in `addServices` (a service with the same id is replaced), and, when `alsoKnownAs` is set, replaces the subject\'s other identifiers (an empty list removes them). UNTP identifies an entity\'s Digital Identity Anchor with a service of type `https://test.uncefact.org/vocabulary/link-type/dia` (`untp:dia` in UNTP 0.7) and registered identifiers with `alsoKnownAs`. Only a self-hosted did:web document can be changed; services of an EBSI DID are written to the EBSI DID registry, which does not take `alsoKnownAs`.
|
|
4097
|
+
* @param {string} walletId
|
|
4098
|
+
* @param {DidDocumentPatch} didDocumentPatch
|
|
4099
|
+
* @param {*} [options] Override http request option.
|
|
4100
|
+
* @throws {RequiredError}
|
|
4101
|
+
*/
|
|
4102
|
+
didDocumentPatch(walletId: string, didDocumentPatch: DidDocumentPatch, options?: RawAxiosRequestConfig): AxiosPromise<{
|
|
4103
|
+
[key: string]: any;
|
|
4104
|
+
}>;
|
|
3282
4105
|
/**
|
|
3283
4106
|
* Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
|
|
3284
4107
|
* @param {*} [options] Override http request option.
|
|
@@ -3310,37 +4133,6 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3310
4133
|
* @throws {RequiredError}
|
|
3311
4134
|
*/
|
|
3312
4135
|
holderIdTokenSend(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig): AxiosPromise<PresentationResponse>;
|
|
3313
|
-
/**
|
|
3314
|
-
* Creates a new public Linked VP of specified credentials and adds it to the wallet\'s DID document
|
|
3315
|
-
* @param {string} walletId
|
|
3316
|
-
* @param {LinkedVpCreateRequest} [linkedVpCreateRequest]
|
|
3317
|
-
* @param {*} [options] Override http request option.
|
|
3318
|
-
* @throws {RequiredError}
|
|
3319
|
-
*/
|
|
3320
|
-
holderLinkedVpCreate(walletId: string, linkedVpCreateRequest?: LinkedVpCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<LinkedVpMetadata>;
|
|
3321
|
-
/**
|
|
3322
|
-
* Deletes a linked VP
|
|
3323
|
-
* @param {string} walletId
|
|
3324
|
-
* @param {string} linkedVpId
|
|
3325
|
-
* @param {*} [options] Override http request option.
|
|
3326
|
-
* @throws {RequiredError}
|
|
3327
|
-
*/
|
|
3328
|
-
holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3329
|
-
/**
|
|
3330
|
-
* Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
|
|
3331
|
-
* @param {string} walletId
|
|
3332
|
-
* @param {string} linkedVpId
|
|
3333
|
-
* @param {*} [options] Override http request option.
|
|
3334
|
-
* @throws {RequiredError}
|
|
3335
|
-
*/
|
|
3336
|
-
holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): AxiosPromise<LinkedVpMetadata>;
|
|
3337
|
-
/**
|
|
3338
|
-
* Returns all linked Verifiable Presentations published in the wallet\'s DID document,
|
|
3339
|
-
* @param {string} walletId
|
|
3340
|
-
* @param {*} [options] Override http request option.
|
|
3341
|
-
* @throws {RequiredError}
|
|
3342
|
-
*/
|
|
3343
|
-
holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<LinkedVpMetadata>>;
|
|
3344
4136
|
/**
|
|
3345
4137
|
* Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
|
|
3346
4138
|
* @param {string} walletId
|
|
@@ -3380,6 +4172,15 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3380
4172
|
* @throws {RequiredError}
|
|
3381
4173
|
*/
|
|
3382
4174
|
issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CredentialType>>;
|
|
4175
|
+
/**
|
|
4176
|
+
* Signs an opaque payload, such as an audit log entry, with the wallet\'s DID key, as a compact detached JWS with an unencoded payload (RFC 7515 Appendix F, RFC 7797: `b64: false`, `crit: [\"b64\"]`): `<protected header>..<signature>`. The signature is verified offline against the key in the wallet\'s DID document, with the payload put back. `typ` must be one the deployment allows, which no credential or presentation verifier accepts, so a signature from here never passes as a credential.
|
|
4177
|
+
* @param {string} walletId
|
|
4178
|
+
* @param {IssuerDetachedJwsSignRequest} issuerDetachedJwsSignRequest
|
|
4179
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
4180
|
+
* @param {*} [options] Override http request option.
|
|
4181
|
+
* @throws {RequiredError}
|
|
4182
|
+
*/
|
|
4183
|
+
issuerDetachedJwsSign(walletId: string, issuerDetachedJwsSignRequest: IssuerDetachedJwsSignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): AxiosPromise<IssuerDetachedJwsSignResult>;
|
|
3383
4184
|
/**
|
|
3384
4185
|
* Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
|
|
3385
4186
|
* @param {string} walletId
|
|
@@ -3439,6 +4240,37 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3439
4240
|
* @throws {RequiredError}
|
|
3440
4241
|
*/
|
|
3441
4242
|
pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4243
|
+
/**
|
|
4244
|
+
* Creates a wallet for the caller from a pending enrollment, in the tenant. A state can be used once. A caller whose token names another tenant is refused.
|
|
4245
|
+
* @param {string} tenantId
|
|
4246
|
+
* @param {string} state The enrollment state from TenantEnrollmentInit.
|
|
4247
|
+
* @param {*} [options] Override http request option.
|
|
4248
|
+
* @throws {RequiredError}
|
|
4249
|
+
*/
|
|
4250
|
+
tenantEnrollmentEnroll(tenantId: string, state: string, options?: RawAxiosRequestConfig): AxiosPromise<WalletIdObject>;
|
|
4251
|
+
/**
|
|
4252
|
+
* Prepares a wallet for the tenant and returns a one-time enrollment state. Whoever presents the state to POST /tenant/{tenant_id}/enrollment/{state} gets a wallet created from the payload, in the tenant. Only a Tenant Owner of the tenant may call it. The payload is validated now; a tenantId it carries is ignored. The state is returned only here: the wallet keeps only its hash, which is the enrollment id.
|
|
4253
|
+
* @param {string} tenantId
|
|
4254
|
+
* @param {EnrollmentInitPayload} enrollmentInitPayload
|
|
4255
|
+
* @param {*} [options] Override http request option.
|
|
4256
|
+
* @throws {RequiredError}
|
|
4257
|
+
*/
|
|
4258
|
+
tenantEnrollmentInit(tenantId: string, enrollmentInitPayload: EnrollmentInitPayload, options?: RawAxiosRequestConfig): AxiosPromise<EnrollmentInitResponse>;
|
|
4259
|
+
/**
|
|
4260
|
+
* Lists the tenant\'s pending enrollments, oldest first. Only a Tenant Owner of the tenant may.
|
|
4261
|
+
* @param {string} tenantId
|
|
4262
|
+
* @param {*} [options] Override http request option.
|
|
4263
|
+
* @throws {RequiredError}
|
|
4264
|
+
*/
|
|
4265
|
+
tenantEnrollmentList(tenantId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EnrollmentListItem>>;
|
|
4266
|
+
/**
|
|
4267
|
+
* Revokes a pending enrollment, so that its state no longer creates a wallet.
|
|
4268
|
+
* @param {string} tenantId
|
|
4269
|
+
* @param {string} enrollmentId
|
|
4270
|
+
* @param {*} [options] Override http request option.
|
|
4271
|
+
* @throws {RequiredError}
|
|
4272
|
+
*/
|
|
4273
|
+
tenantEnrollmentRevoke(tenantId: string, enrollmentId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
3442
4274
|
/**
|
|
3443
4275
|
* Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
|
|
3444
4276
|
* @param {string} walletId
|
|
@@ -3539,21 +4371,60 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3539
4371
|
*/
|
|
3540
4372
|
trustListsGet(options?: RawAxiosRequestConfig): AxiosPromise<TrustListsResponse>;
|
|
3541
4373
|
/**
|
|
3542
|
-
*
|
|
4374
|
+
* Removes a UNTP link from the wallet\'s DID document and stops serving its credential.
|
|
3543
4375
|
* @param {string} walletId
|
|
3544
|
-
* @param {
|
|
4376
|
+
* @param {string} serviceId The service id of the link, in full (`<did>#<fragment>`) or as its fragment.
|
|
3545
4377
|
* @param {*} [options] Override http request option.
|
|
3546
4378
|
* @throws {RequiredError}
|
|
3547
4379
|
*/
|
|
3548
|
-
|
|
4380
|
+
untpLinkDelete(walletId: string, serviceId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4381
|
+
/**
|
|
4382
|
+
* The UNTP links the wallet\'s DID document advertises for its published credentials.
|
|
4383
|
+
* @param {string} walletId
|
|
4384
|
+
* @param {*} [options] Override http request option.
|
|
4385
|
+
* @throws {RequiredError}
|
|
4386
|
+
*/
|
|
4387
|
+
untpLinkList(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UntpLink>>;
|
|
4388
|
+
/**
|
|
4389
|
+
* Publishes an issued, valid W3C VCDM credential as a UNTP link: it is served at its public URL (`/api/v1/{wallet_id}/vc/{credential_id}`) and the wallet\'s DID document gets a service of the link type, whose endpoint is a link target to that URL. Publishing a credential again as the same link type returns the existing link. The wallet\'s DID document must be one it hosts (a self-hosted did:web, or an EBSI DID).
|
|
4390
|
+
* @param {string} walletId
|
|
4391
|
+
* @param {UntpLinkPublishRequest} untpLinkPublishRequest
|
|
4392
|
+
* @param {*} [options] Override http request option.
|
|
4393
|
+
* @throws {RequiredError}
|
|
4394
|
+
*/
|
|
4395
|
+
untpLinkPublish(walletId: string, untpLinkPublishRequest: UntpLinkPublishRequest, options?: RawAxiosRequestConfig): AxiosPromise<UntpLink>;
|
|
4396
|
+
/**
|
|
4397
|
+
* Lists the registrars the wallet trusts to issue Digital Identity Anchors, and whether the wallet\'s own DID is one of them.
|
|
4398
|
+
* @param {string} walletId
|
|
4399
|
+
* @param {*} [options] Override http request option.
|
|
4400
|
+
* @throws {RequiredError}
|
|
4401
|
+
*/
|
|
4402
|
+
untpRegistryList(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<UntpRegistry>;
|
|
4403
|
+
/**
|
|
4404
|
+
* Verifies a credential, given raw or by URL, with the wallet\'s trust framework, and reports each check: the signature (with the key the issuer\'s identifier resolves to), the validity dates, and, unless turned off, the JSON-LD document (W3C VCDM 2.0), the status, the schema and the issuer\'s trust. A credential that fails is still `200`, with `verified: false`; `code` reuses the error codes of `/verifier/untp/resolve`. A `url` must be https, and is never fetched from a private, loopback or link-local address, so a localhost URL is refused too. It is fetched within 10 s, 5 MiB and 3 redirects on the same host, and only as a credential media type.
|
|
4405
|
+
* @param {string} walletId
|
|
4406
|
+
* @param {VerifierCredentialRequest} verifierCredentialRequest
|
|
4407
|
+
* @param {*} [options] Override http request option.
|
|
4408
|
+
* @throws {RequiredError}
|
|
4409
|
+
*/
|
|
4410
|
+
verifierCredentialVerify(walletId: string, verifierCredentialRequest: VerifierCredentialRequest, options?: RawAxiosRequestConfig): AxiosPromise<VerifierCredentialResult>;
|
|
4411
|
+
/**
|
|
4412
|
+
* Verifies whether the wallet\'s trust framework trusts a DID, beyond resolving its key. A UNTP wallet requires a Digital Identity Anchor (UNTP 0.8.0, a profile of W3C Recognized Entities): the DID\'s DIA, found through its DID document\'s `https://test.uncefact.org/vocabulary/link-type/dia` service (or `untp:dia`), or a W3C `WhoisService`, is verified (signature, validity, status, the UNTP profile) and chained up, DIA by DIA, to a registrar the wallet trusts: its own (`UNTP.trustedRegistrars`), then the deployment\'s (`untp.dia.trustedRegistrars`, `untp.dia.registryUrl`). A registrar is itself trusted without a DIA. The details are in `untp`. A DID that is not trusted is still `200`, with `trusted: false` and the reasons in `failures`. With `credentialType`, the issuer policy for that credential type is evaluated too. A wallet whose trust framework does not verify DIDs is `422`.
|
|
4413
|
+
* @param {string} walletId
|
|
4414
|
+
* @param {string} did The DID to verify.
|
|
4415
|
+
* @param {string} [credentialType] Evaluate the issuer policy of this credential type, e.g. `DigitalProductPassport`.
|
|
4416
|
+
* @param {*} [options] Override http request option.
|
|
4417
|
+
* @throws {RequiredError}
|
|
4418
|
+
*/
|
|
4419
|
+
verifierDidVerify(walletId: string, did: string, credentialType?: string, options?: RawAxiosRequestConfig): AxiosPromise<DidVerification>;
|
|
3549
4420
|
/**
|
|
3550
|
-
*
|
|
4421
|
+
* Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
|
|
3551
4422
|
* @param {string} walletId
|
|
3552
|
-
* @param {
|
|
4423
|
+
* @param {VerifyInitRequest} [verifyInitRequest]
|
|
3553
4424
|
* @param {*} [options] Override http request option.
|
|
3554
4425
|
* @throws {RequiredError}
|
|
3555
4426
|
*/
|
|
3556
|
-
|
|
4427
|
+
verifierInitUrlCreate(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig): AxiosPromise<VerifyInitResponse>;
|
|
3557
4428
|
/**
|
|
3558
4429
|
* Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.
|
|
3559
4430
|
* @param {string} walletId
|
|
@@ -3566,6 +4437,26 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3566
4437
|
* @throws {RequiredError}
|
|
3567
4438
|
*/
|
|
3568
4439
|
verifierPdfVerify(walletId: string, extractVp: boolean, pdf?: File, trustedCertificates?: Array<string>, trustedListsUrl?: Array<string>, trustedListSigningCertificates?: Array<string>, options?: RawAxiosRequestConfig): AxiosPromise<PdfVerificationResponse>;
|
|
4440
|
+
/**
|
|
4441
|
+
* Renders a credential for a human with one of its `renderMethod` entries: a UNTP `RenderTemplate2024` (Handlebars, the output in its `mediaType`: `text/html`, the default, or `text/plain`) or a W3C `TemplateRenderMethod` of the `html` suite (a wrapper document to show in an `iframe` with `sandbox=\"allow-scripts\"` and `srcdoc`) or the `card` suite (a JSON card). By default the first method that can be rendered is used. A `signedVc` is verified (its signature, validity and status) before it is rendered, and `X-Credential-Verified` is `true`; one that fails is `422`. A `vc` is a credential document rendered as it is, with `X-Credential-Verified: false`. A credential with no render method that matches, or a method that cannot be rendered (`nfc`, a template of another `mediaType`, or an unknown type), is `422` with `no render method` or `render suite unsupported`; an invalid one is `422` with `invalid render method`, a template that cannot be fetched or does not match its digest `render template unavailable`, and one that fails or runs too long `render failed`. A remote template is fetched over https only, within 5 s and 1 MiB, and must match its `digestMultibase`. Rendering stops after 2 s or 1 MiB of output. A template that runs on past that still counts against the renderings the wallet runs at once (`render.maxConcurrent`); when none is free, the response is `503`.
|
|
4442
|
+
* @param {string} walletId
|
|
4443
|
+
* @param {VerifierRenderRequest} verifierRenderRequest
|
|
4444
|
+
* @param {*} [options] Override http request option.
|
|
4445
|
+
* @throws {RequiredError}
|
|
4446
|
+
*/
|
|
4447
|
+
verifierRender(walletId: string, verifierRenderRequest: VerifierRenderRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
4448
|
+
/**
|
|
4449
|
+
* Resolves a DID into the RFC 9264 linkset of the UNTP links its DID document advertises and, with `fetch`, fetches the linked credentials and verifies them. A credential that fails is reported in `credentials` and `verification.failed`, with the response still 200: `verification.ok` is the verdict.
|
|
4450
|
+
* @param {string} walletId
|
|
4451
|
+
* @param {string} identifier The DID to resolve.
|
|
4452
|
+
* @param {string} [linkType] The link types to fetch, comma separated (e.g. `dpp,dcc`), or `all` (the default). The linkset uses the UNTP 0.8.0 relations: `dpp`, `linkset` for an identity resolver, and `https://test.uncefact.org/vocabulary/link-type/<type>` for the others. A DID document\'s UNTP 0.7 service types (`untp:dia`, bare `dcc`) are read as the same link types.
|
|
4453
|
+
* @param {boolean} [fetch] Fetch and verify the linked credentials.
|
|
4454
|
+
* @param {boolean} [verify] Verify the fetched credentials\' dates, status and schema, besides their signature.
|
|
4455
|
+
* @param {boolean} [verifyIssuer] Also verify whether the wallet\'s trust framework trusts the DID, as `/verifier/did` does, and report it as `issuer`. A wallet whose trust framework does not verify DIDs reports no `issuer`, and is `422` when `verifyIssuer` is set explicitly. A UNTP wallet enforces the anchor on every signature anyway; this reports it.
|
|
4456
|
+
* @param {*} [options] Override http request option.
|
|
4457
|
+
* @throws {RequiredError}
|
|
4458
|
+
*/
|
|
4459
|
+
verifierUntpResolve(walletId: string, identifier: string, linkType?: string, fetch?: boolean, verify?: boolean, verifyIssuer?: boolean, options?: RawAxiosRequestConfig): AxiosPromise<UntpResolveResult>;
|
|
3569
4460
|
/**
|
|
3570
4461
|
* Creates a new wallet for the authenticated client.
|
|
3571
4462
|
* @param {WalletCreatePayload} [walletCreatePayload]
|
|
@@ -3607,10 +4498,11 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3607
4498
|
* Provides list of wallets owned by the authenticated client, sorted by wallet name in byte order (Unicode code point order of the UTF-8 name, so upper case sorts before lower case). Wallets with the same name are in the order they were created.
|
|
3608
4499
|
* @param {string} [ownerId]
|
|
3609
4500
|
* @param {string} [searchName] Wallet name to search using \"begins-with\" filter
|
|
4501
|
+
* @param {string} [tenantId] Lists the wallets of every owner in this tenant instead, each with its ownerId. Only a Tenant Owner of the tenant may set it, and not together with ownerId.
|
|
3610
4502
|
* @param {*} [options] Override http request option.
|
|
3611
4503
|
* @throws {RequiredError}
|
|
3612
4504
|
*/
|
|
3613
|
-
walletList(ownerId?: string, searchName?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WalletListItem>>;
|
|
4505
|
+
walletList(ownerId?: string, searchName?: string, tenantId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WalletListItem>>;
|
|
3614
4506
|
/**
|
|
3615
4507
|
* Gets a specific notification by state
|
|
3616
4508
|
* @param {string} walletId Wallet ID
|
|
@@ -3643,7 +4535,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
|
|
|
3643
4535
|
*/
|
|
3644
4536
|
walletNotifications(walletId: string, eventType?: string, state?: string, lastEventID?: string, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
3645
4537
|
/**
|
|
3646
|
-
* Update wallet metadata and configuration.
|
|
4538
|
+
* Update wallet metadata and configuration. The owner of the wallet patches its name, config and metadata; `config.tenant` is ignored for them. A Tenant Owner of the wallet\'s tenant patches `config.tenant.issuerProxyUrl`, also of wallets of other owners, and for those every other field of the body is ignored. `config.tenant.tenantId` never changes.
|
|
3647
4539
|
* @param {string} walletId
|
|
3648
4540
|
* @param {WalletPatchPayload} [walletPatchPayload]
|
|
3649
4541
|
* @param {*} [options] Override http request option.
|
|
@@ -3864,6 +4756,16 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3864
4756
|
* @throws {RequiredError}
|
|
3865
4757
|
*/
|
|
3866
4758
|
credentialIssuanceInit(credentialId: string, walletId: string, credentialIssuanceInit?: CredentialIssuanceInit, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialIssuanceInitResult, any, {}>>;
|
|
4759
|
+
/**
|
|
4760
|
+
* Issues a W3C VCDM draft as a credential of the wallet itself, with no holder and no OID4VCI: for a credential that is published rather than handed to anyone, such as a UNTP Digital Product Passport (EN 18246 Annex B.5). The credential gets the wallet\'s status list entry and envelope, and is stored issued on the same record. With `publish`, it is then published as a UNTP link, like `POST /untp/links`; if that fails the response is `502` with the issued `credentialId`, and publishing is retried with `POST /untp/links`.
|
|
4761
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
4762
|
+
* @param {string} walletId
|
|
4763
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
4764
|
+
* @param {CredentialIssueDirectRequest} [credentialIssueDirectRequest]
|
|
4765
|
+
* @param {*} [options] Override http request option.
|
|
4766
|
+
* @throws {RequiredError}
|
|
4767
|
+
*/
|
|
4768
|
+
credentialIssueDirect(credentialId: string, walletId: string, idempotencyKey?: string, credentialIssueDirectRequest?: CredentialIssueDirectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialIssueDirectResult, any, {}>>;
|
|
3867
4769
|
/**
|
|
3868
4770
|
* Retrieves a list of credentials.
|
|
3869
4771
|
* @param {string} walletId
|
|
@@ -3916,6 +4818,25 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3916
4818
|
* @throws {RequiredError}
|
|
3917
4819
|
*/
|
|
3918
4820
|
credentialRawGet(credentialId: string, walletId: string, disclosedClaims?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
4821
|
+
/**
|
|
4822
|
+
* Renders a W3C VCDM credential of the wallet with one of its `renderMethod` entries, as `POST /verifier/render` does. HTML is served with a `Content-Security-Policy` that sandboxes it.
|
|
4823
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
4824
|
+
* @param {string} walletId
|
|
4825
|
+
* @param {number} [index] The index of the render method to use, in the credential\'s `renderMethod`.
|
|
4826
|
+
* @param {RenderSuite} [suite] Use the first render method of this suite.
|
|
4827
|
+
* @param {string} [mediaQuery] Use the first render method with exactly this `mediaQuery`.
|
|
4828
|
+
* @param {*} [options] Override http request option.
|
|
4829
|
+
* @throws {RequiredError}
|
|
4830
|
+
*/
|
|
4831
|
+
credentialRender(credentialId: string, walletId: string, index?: number, suite?: RenderSuite, mediaQuery?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
4832
|
+
/**
|
|
4833
|
+
* Lists the render methods of a W3C VCDM credential of the wallet, for a client to pick one by its media query: media queries are not evaluated by the wallet.
|
|
4834
|
+
* @param {string} credentialId Verifiable Credential Identifier
|
|
4835
|
+
* @param {string} walletId
|
|
4836
|
+
* @param {*} [options] Override http request option.
|
|
4837
|
+
* @throws {RequiredError}
|
|
4838
|
+
*/
|
|
4839
|
+
credentialRenderMethods(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<RenderMethodInfo[], any, {}>>;
|
|
3919
4840
|
/**
|
|
3920
4841
|
* Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
|
|
3921
4842
|
* @param {string} walletId
|
|
@@ -3925,13 +4846,14 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3925
4846
|
*/
|
|
3926
4847
|
credentialRequestInit(walletId: string, credentialRequest?: CredentialRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
|
|
3927
4848
|
/**
|
|
3928
|
-
* Revoke a specific Verifiable Credential
|
|
4849
|
+
* Revoke a specific Verifiable Credential. A credential published as a UNTP link stays published: a verifier following its link finds it and verifies it as revoked. `DELETE /untp/links/{service_id}` unpublishes it.
|
|
3929
4850
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
3930
4851
|
* @param {string} walletId
|
|
4852
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
3931
4853
|
* @param {*} [options] Override http request option.
|
|
3932
4854
|
* @throws {RequiredError}
|
|
3933
4855
|
*/
|
|
3934
|
-
credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
4856
|
+
credentialRevoke(credentialId: string, walletId: string, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
3935
4857
|
/**
|
|
3936
4858
|
* Suspend a Verifiable Credential issued with the `suspension` status purpose (W3C Bitstring Status List v1.0). A suspension can be lifted with `DELETE`.
|
|
3937
4859
|
* @param {string} credentialId Verifiable Credential Identifier
|
|
@@ -3963,6 +4885,25 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3963
4885
|
* @throws {RequiredError}
|
|
3964
4886
|
*/
|
|
3965
4887
|
didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
|
|
4888
|
+
/**
|
|
4889
|
+
* Returns the wallet\'s own DID document, as published at `/{wallet_id}/did.json` for a self-hosted did:web.
|
|
4890
|
+
* @param {string} walletId
|
|
4891
|
+
* @param {*} [options] Override http request option.
|
|
4892
|
+
* @throws {RequiredError}
|
|
4893
|
+
*/
|
|
4894
|
+
didDocumentLocalGet(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
4895
|
+
[key: string]: any;
|
|
4896
|
+
}, any, {}>>;
|
|
4897
|
+
/**
|
|
4898
|
+
* Changes the wallet\'s DID document: removes the services in `removeServiceIds`, adds the services in `addServices` (a service with the same id is replaced), and, when `alsoKnownAs` is set, replaces the subject\'s other identifiers (an empty list removes them). UNTP identifies an entity\'s Digital Identity Anchor with a service of type `https://test.uncefact.org/vocabulary/link-type/dia` (`untp:dia` in UNTP 0.7) and registered identifiers with `alsoKnownAs`. Only a self-hosted did:web document can be changed; services of an EBSI DID are written to the EBSI DID registry, which does not take `alsoKnownAs`.
|
|
4899
|
+
* @param {string} walletId
|
|
4900
|
+
* @param {DidDocumentPatch} didDocumentPatch
|
|
4901
|
+
* @param {*} [options] Override http request option.
|
|
4902
|
+
* @throws {RequiredError}
|
|
4903
|
+
*/
|
|
4904
|
+
didDocumentPatch(walletId: string, didDocumentPatch: DidDocumentPatch, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<{
|
|
4905
|
+
[key: string]: any;
|
|
4906
|
+
}, any, {}>>;
|
|
3966
4907
|
/**
|
|
3967
4908
|
* Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
|
|
3968
4909
|
* @param {*} [options] Override http request option.
|
|
@@ -3994,37 +4935,6 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
3994
4935
|
* @throws {RequiredError}
|
|
3995
4936
|
*/
|
|
3996
4937
|
holderIdTokenSend(walletId: string, idTokenSendRequest?: IdTokenSendRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PresentationResponse, any, {}>>;
|
|
3997
|
-
/**
|
|
3998
|
-
* Creates a new public Linked VP of specified credentials and adds it to the wallet\'s DID document
|
|
3999
|
-
* @param {string} walletId
|
|
4000
|
-
* @param {LinkedVpCreateRequest} [linkedVpCreateRequest]
|
|
4001
|
-
* @param {*} [options] Override http request option.
|
|
4002
|
-
* @throws {RequiredError}
|
|
4003
|
-
*/
|
|
4004
|
-
holderLinkedVpCreate(walletId: string, linkedVpCreateRequest?: LinkedVpCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedVpMetadata, any, {}>>;
|
|
4005
|
-
/**
|
|
4006
|
-
* Deletes a linked VP
|
|
4007
|
-
* @param {string} walletId
|
|
4008
|
-
* @param {string} linkedVpId
|
|
4009
|
-
* @param {*} [options] Override http request option.
|
|
4010
|
-
* @throws {RequiredError}
|
|
4011
|
-
*/
|
|
4012
|
-
holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
4013
|
-
/**
|
|
4014
|
-
* Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
|
|
4015
|
-
* @param {string} walletId
|
|
4016
|
-
* @param {string} linkedVpId
|
|
4017
|
-
* @param {*} [options] Override http request option.
|
|
4018
|
-
* @throws {RequiredError}
|
|
4019
|
-
*/
|
|
4020
|
-
holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedVpMetadata, any, {}>>;
|
|
4021
|
-
/**
|
|
4022
|
-
* Returns all linked Verifiable Presentations published in the wallet\'s DID document,
|
|
4023
|
-
* @param {string} walletId
|
|
4024
|
-
* @param {*} [options] Override http request option.
|
|
4025
|
-
* @throws {RequiredError}
|
|
4026
|
-
*/
|
|
4027
|
-
holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedVpMetadata[], any, {}>>;
|
|
4028
4938
|
/**
|
|
4029
4939
|
* Processes a credential offer URL (received from an issuer via QR code, deep link, or WMP) and returns what authorization is required to accept it - pin, credential presentation or a redirect to custom authorization flow. holder needs to present to the issuer, along with matching candidates from the wallet. The returned `interactionId` is used in the subsequent `HolderOfferProcessAfterConsent` call.
|
|
4030
4940
|
* @param {string} walletId
|
|
@@ -4064,6 +4974,15 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4064
4974
|
* @throws {RequiredError}
|
|
4065
4975
|
*/
|
|
4066
4976
|
issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialType[], any, {}>>;
|
|
4977
|
+
/**
|
|
4978
|
+
* Signs an opaque payload, such as an audit log entry, with the wallet\'s DID key, as a compact detached JWS with an unencoded payload (RFC 7515 Appendix F, RFC 7797: `b64: false`, `crit: [\"b64\"]`): `<protected header>..<signature>`. The signature is verified offline against the key in the wallet\'s DID document, with the payload put back. `typ` must be one the deployment allows, which no credential or presentation verifier accepts, so a signature from here never passes as a credential.
|
|
4979
|
+
* @param {string} walletId
|
|
4980
|
+
* @param {IssuerDetachedJwsSignRequest} issuerDetachedJwsSignRequest
|
|
4981
|
+
* @param {string} [idempotencyKey] Makes a retry safe: a repeat with the same key, for the same wallet, gets the first response (with `Idempotent-Replayed: true`) for 24 hours. The same key with a different request is `422`. A `5xx` response is not kept: a retry runs the request again. A repeat while the first request runs, or after it completed without its response being kept, is `409`.
|
|
4982
|
+
* @param {*} [options] Override http request option.
|
|
4983
|
+
* @throws {RequiredError}
|
|
4984
|
+
*/
|
|
4985
|
+
issuerDetachedJwsSign(walletId: string, issuerDetachedJwsSignRequest: IssuerDetachedJwsSignRequest, idempotencyKey?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IssuerDetachedJwsSignResult, any, {}>>;
|
|
4067
4986
|
/**
|
|
4068
4987
|
* Generates an authorized credential offer URL for the holder to initiate the credential issuance flow. The resulting offer URL is typically presented as a QR code or deep link. If `wmpEntityId` is provided, the offer is delivered directly via WMP and 204 is returned.
|
|
4069
4988
|
* @param {string} walletId
|
|
@@ -4123,6 +5042,37 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4123
5042
|
* @throws {RequiredError}
|
|
4124
5043
|
*/
|
|
4125
5044
|
pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
5045
|
+
/**
|
|
5046
|
+
* Creates a wallet for the caller from a pending enrollment, in the tenant. A state can be used once. A caller whose token names another tenant is refused.
|
|
5047
|
+
* @param {string} tenantId
|
|
5048
|
+
* @param {string} state The enrollment state from TenantEnrollmentInit.
|
|
5049
|
+
* @param {*} [options] Override http request option.
|
|
5050
|
+
* @throws {RequiredError}
|
|
5051
|
+
*/
|
|
5052
|
+
tenantEnrollmentEnroll(tenantId: string, state: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WalletIdObject, any, {}>>;
|
|
5053
|
+
/**
|
|
5054
|
+
* Prepares a wallet for the tenant and returns a one-time enrollment state. Whoever presents the state to POST /tenant/{tenant_id}/enrollment/{state} gets a wallet created from the payload, in the tenant. Only a Tenant Owner of the tenant may call it. The payload is validated now; a tenantId it carries is ignored. The state is returned only here: the wallet keeps only its hash, which is the enrollment id.
|
|
5055
|
+
* @param {string} tenantId
|
|
5056
|
+
* @param {EnrollmentInitPayload} enrollmentInitPayload
|
|
5057
|
+
* @param {*} [options] Override http request option.
|
|
5058
|
+
* @throws {RequiredError}
|
|
5059
|
+
*/
|
|
5060
|
+
tenantEnrollmentInit(tenantId: string, enrollmentInitPayload: EnrollmentInitPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EnrollmentInitResponse, any, {}>>;
|
|
5061
|
+
/**
|
|
5062
|
+
* Lists the tenant\'s pending enrollments, oldest first. Only a Tenant Owner of the tenant may.
|
|
5063
|
+
* @param {string} tenantId
|
|
5064
|
+
* @param {*} [options] Override http request option.
|
|
5065
|
+
* @throws {RequiredError}
|
|
5066
|
+
*/
|
|
5067
|
+
tenantEnrollmentList(tenantId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EnrollmentListItem[], any, {}>>;
|
|
5068
|
+
/**
|
|
5069
|
+
* Revokes a pending enrollment, so that its state no longer creates a wallet.
|
|
5070
|
+
* @param {string} tenantId
|
|
5071
|
+
* @param {string} enrollmentId
|
|
5072
|
+
* @param {*} [options] Override http request option.
|
|
5073
|
+
* @throws {RequiredError}
|
|
5074
|
+
*/
|
|
5075
|
+
tenantEnrollmentRevoke(tenantId: string, enrollmentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
4126
5076
|
/**
|
|
4127
5077
|
* Accredits a legal entity as RTAO (Root Trust Anchor Organisation), TAO (Trust Anchor Organisation), or TI (Trusted Issuer) within the trust framework hierarchy by issuing the appropriate accreditation credential to their DID.
|
|
4128
5078
|
* @param {string} walletId
|
|
@@ -4223,21 +5173,60 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4223
5173
|
*/
|
|
4224
5174
|
trustListsGet(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TrustListsResponse, any, {}>>;
|
|
4225
5175
|
/**
|
|
4226
|
-
*
|
|
5176
|
+
* Removes a UNTP link from the wallet\'s DID document and stops serving its credential.
|
|
4227
5177
|
* @param {string} walletId
|
|
4228
|
-
* @param {
|
|
5178
|
+
* @param {string} serviceId The service id of the link, in full (`<did>#<fragment>`) or as its fragment.
|
|
4229
5179
|
* @param {*} [options] Override http request option.
|
|
4230
5180
|
* @throws {RequiredError}
|
|
4231
5181
|
*/
|
|
4232
|
-
|
|
5182
|
+
untpLinkDelete(walletId: string, serviceId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
5183
|
+
/**
|
|
5184
|
+
* The UNTP links the wallet\'s DID document advertises for its published credentials.
|
|
5185
|
+
* @param {string} walletId
|
|
5186
|
+
* @param {*} [options] Override http request option.
|
|
5187
|
+
* @throws {RequiredError}
|
|
5188
|
+
*/
|
|
5189
|
+
untpLinkList(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UntpLink[], any, {}>>;
|
|
5190
|
+
/**
|
|
5191
|
+
* Publishes an issued, valid W3C VCDM credential as a UNTP link: it is served at its public URL (`/api/v1/{wallet_id}/vc/{credential_id}`) and the wallet\'s DID document gets a service of the link type, whose endpoint is a link target to that URL. Publishing a credential again as the same link type returns the existing link. The wallet\'s DID document must be one it hosts (a self-hosted did:web, or an EBSI DID).
|
|
5192
|
+
* @param {string} walletId
|
|
5193
|
+
* @param {UntpLinkPublishRequest} untpLinkPublishRequest
|
|
5194
|
+
* @param {*} [options] Override http request option.
|
|
5195
|
+
* @throws {RequiredError}
|
|
5196
|
+
*/
|
|
5197
|
+
untpLinkPublish(walletId: string, untpLinkPublishRequest: UntpLinkPublishRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UntpLink, any, {}>>;
|
|
5198
|
+
/**
|
|
5199
|
+
* Lists the registrars the wallet trusts to issue Digital Identity Anchors, and whether the wallet\'s own DID is one of them.
|
|
5200
|
+
* @param {string} walletId
|
|
5201
|
+
* @param {*} [options] Override http request option.
|
|
5202
|
+
* @throws {RequiredError}
|
|
5203
|
+
*/
|
|
5204
|
+
untpRegistryList(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UntpRegistry, any, {}>>;
|
|
5205
|
+
/**
|
|
5206
|
+
* Verifies a credential, given raw or by URL, with the wallet\'s trust framework, and reports each check: the signature (with the key the issuer\'s identifier resolves to), the validity dates, and, unless turned off, the JSON-LD document (W3C VCDM 2.0), the status, the schema and the issuer\'s trust. A credential that fails is still `200`, with `verified: false`; `code` reuses the error codes of `/verifier/untp/resolve`. A `url` must be https, and is never fetched from a private, loopback or link-local address, so a localhost URL is refused too. It is fetched within 10 s, 5 MiB and 3 redirects on the same host, and only as a credential media type.
|
|
5207
|
+
* @param {string} walletId
|
|
5208
|
+
* @param {VerifierCredentialRequest} verifierCredentialRequest
|
|
5209
|
+
* @param {*} [options] Override http request option.
|
|
5210
|
+
* @throws {RequiredError}
|
|
5211
|
+
*/
|
|
5212
|
+
verifierCredentialVerify(walletId: string, verifierCredentialRequest: VerifierCredentialRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifierCredentialResult, any, {}>>;
|
|
5213
|
+
/**
|
|
5214
|
+
* Verifies whether the wallet\'s trust framework trusts a DID, beyond resolving its key. A UNTP wallet requires a Digital Identity Anchor (UNTP 0.8.0, a profile of W3C Recognized Entities): the DID\'s DIA, found through its DID document\'s `https://test.uncefact.org/vocabulary/link-type/dia` service (or `untp:dia`), or a W3C `WhoisService`, is verified (signature, validity, status, the UNTP profile) and chained up, DIA by DIA, to a registrar the wallet trusts: its own (`UNTP.trustedRegistrars`), then the deployment\'s (`untp.dia.trustedRegistrars`, `untp.dia.registryUrl`). A registrar is itself trusted without a DIA. The details are in `untp`. A DID that is not trusted is still `200`, with `trusted: false` and the reasons in `failures`. With `credentialType`, the issuer policy for that credential type is evaluated too. A wallet whose trust framework does not verify DIDs is `422`.
|
|
5215
|
+
* @param {string} walletId
|
|
5216
|
+
* @param {string} did The DID to verify.
|
|
5217
|
+
* @param {string} [credentialType] Evaluate the issuer policy of this credential type, e.g. `DigitalProductPassport`.
|
|
5218
|
+
* @param {*} [options] Override http request option.
|
|
5219
|
+
* @throws {RequiredError}
|
|
5220
|
+
*/
|
|
5221
|
+
verifierDidVerify(walletId: string, did: string, credentialType?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DidVerification, any, {}>>;
|
|
4233
5222
|
/**
|
|
4234
|
-
*
|
|
5223
|
+
* Creates a verification session and returns a URL where the verifier accepts credential presentations from a holder. The URL is typically shared as a QR code or deep link. After the holder presents credentials, use `WalletVerifiedCredentialsByState` with the returned `state` to retrieve the verification result.
|
|
4235
5224
|
* @param {string} walletId
|
|
4236
|
-
* @param {
|
|
5225
|
+
* @param {VerifyInitRequest} [verifyInitRequest]
|
|
4237
5226
|
* @param {*} [options] Override http request option.
|
|
4238
5227
|
* @throws {RequiredError}
|
|
4239
5228
|
*/
|
|
4240
|
-
|
|
5229
|
+
verifierInitUrlCreate(walletId: string, verifyInitRequest?: VerifyInitRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VerifyInitResponse, any, {}>>;
|
|
4241
5230
|
/**
|
|
4242
5231
|
* Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.
|
|
4243
5232
|
* @param {string} walletId
|
|
@@ -4250,6 +5239,26 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4250
5239
|
* @throws {RequiredError}
|
|
4251
5240
|
*/
|
|
4252
5241
|
verifierPdfVerify(walletId: string, extractVp: boolean, pdf?: File, trustedCertificates?: Array<string>, trustedListsUrl?: Array<string>, trustedListSigningCertificates?: Array<string>, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PdfVerificationResponse, any, {}>>;
|
|
5242
|
+
/**
|
|
5243
|
+
* Renders a credential for a human with one of its `renderMethod` entries: a UNTP `RenderTemplate2024` (Handlebars, the output in its `mediaType`: `text/html`, the default, or `text/plain`) or a W3C `TemplateRenderMethod` of the `html` suite (a wrapper document to show in an `iframe` with `sandbox=\"allow-scripts\"` and `srcdoc`) or the `card` suite (a JSON card). By default the first method that can be rendered is used. A `signedVc` is verified (its signature, validity and status) before it is rendered, and `X-Credential-Verified` is `true`; one that fails is `422`. A `vc` is a credential document rendered as it is, with `X-Credential-Verified: false`. A credential with no render method that matches, or a method that cannot be rendered (`nfc`, a template of another `mediaType`, or an unknown type), is `422` with `no render method` or `render suite unsupported`; an invalid one is `422` with `invalid render method`, a template that cannot be fetched or does not match its digest `render template unavailable`, and one that fails or runs too long `render failed`. A remote template is fetched over https only, within 5 s and 1 MiB, and must match its `digestMultibase`. Rendering stops after 2 s or 1 MiB of output. A template that runs on past that still counts against the renderings the wallet runs at once (`render.maxConcurrent`); when none is free, the response is `503`.
|
|
5244
|
+
* @param {string} walletId
|
|
5245
|
+
* @param {VerifierRenderRequest} verifierRenderRequest
|
|
5246
|
+
* @param {*} [options] Override http request option.
|
|
5247
|
+
* @throws {RequiredError}
|
|
5248
|
+
*/
|
|
5249
|
+
verifierRender(walletId: string, verifierRenderRequest: VerifierRenderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
5250
|
+
/**
|
|
5251
|
+
* Resolves a DID into the RFC 9264 linkset of the UNTP links its DID document advertises and, with `fetch`, fetches the linked credentials and verifies them. A credential that fails is reported in `credentials` and `verification.failed`, with the response still 200: `verification.ok` is the verdict.
|
|
5252
|
+
* @param {string} walletId
|
|
5253
|
+
* @param {string} identifier The DID to resolve.
|
|
5254
|
+
* @param {string} [linkType] The link types to fetch, comma separated (e.g. `dpp,dcc`), or `all` (the default). The linkset uses the UNTP 0.8.0 relations: `dpp`, `linkset` for an identity resolver, and `https://test.uncefact.org/vocabulary/link-type/<type>` for the others. A DID document\'s UNTP 0.7 service types (`untp:dia`, bare `dcc`) are read as the same link types.
|
|
5255
|
+
* @param {boolean} [fetch] Fetch and verify the linked credentials.
|
|
5256
|
+
* @param {boolean} [verify] Verify the fetched credentials\' dates, status and schema, besides their signature.
|
|
5257
|
+
* @param {boolean} [verifyIssuer] Also verify whether the wallet\'s trust framework trusts the DID, as `/verifier/did` does, and report it as `issuer`. A wallet whose trust framework does not verify DIDs reports no `issuer`, and is `422` when `verifyIssuer` is set explicitly. A UNTP wallet enforces the anchor on every signature anyway; this reports it.
|
|
5258
|
+
* @param {*} [options] Override http request option.
|
|
5259
|
+
* @throws {RequiredError}
|
|
5260
|
+
*/
|
|
5261
|
+
verifierUntpResolve(walletId: string, identifier: string, linkType?: string, fetch?: boolean, verify?: boolean, verifyIssuer?: boolean, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UntpResolveResult, any, {}>>;
|
|
4253
5262
|
/**
|
|
4254
5263
|
* Creates a new wallet for the authenticated client.
|
|
4255
5264
|
* @param {WalletCreatePayload} [walletCreatePayload]
|
|
@@ -4291,10 +5300,11 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4291
5300
|
* Provides list of wallets owned by the authenticated client, sorted by wallet name in byte order (Unicode code point order of the UTF-8 name, so upper case sorts before lower case). Wallets with the same name are in the order they were created.
|
|
4292
5301
|
* @param {string} [ownerId]
|
|
4293
5302
|
* @param {string} [searchName] Wallet name to search using \"begins-with\" filter
|
|
5303
|
+
* @param {string} [tenantId] Lists the wallets of every owner in this tenant instead, each with its ownerId. Only a Tenant Owner of the tenant may set it, and not together with ownerId.
|
|
4294
5304
|
* @param {*} [options] Override http request option.
|
|
4295
5305
|
* @throws {RequiredError}
|
|
4296
5306
|
*/
|
|
4297
|
-
walletList(ownerId?: string, searchName?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WalletListItem[], any, {}>>;
|
|
5307
|
+
walletList(ownerId?: string, searchName?: string, tenantId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WalletListItem[], any, {}>>;
|
|
4298
5308
|
/**
|
|
4299
5309
|
* Gets a specific notification by state
|
|
4300
5310
|
* @param {string} walletId Wallet ID
|
|
@@ -4327,7 +5337,7 @@ export declare class DefaultApi extends BaseAPI {
|
|
|
4327
5337
|
*/
|
|
4328
5338
|
walletNotifications(walletId: string, eventType?: string, state?: string, lastEventID?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
4329
5339
|
/**
|
|
4330
|
-
* Update wallet metadata and configuration.
|
|
5340
|
+
* Update wallet metadata and configuration. The owner of the wallet patches its name, config and metadata; `config.tenant` is ignored for them. A Tenant Owner of the wallet\'s tenant patches `config.tenant.issuerProxyUrl`, also of wallets of other owners, and for those every other field of the body is ignored. `config.tenant.tenantId` never changes.
|
|
4331
5341
|
* @param {string} walletId
|
|
4332
5342
|
* @param {WalletPatchPayload} [walletPatchPayload]
|
|
4333
5343
|
* @param {*} [options] Override http request option.
|