@triveria/wallet 0.0.284 → 0.0.289

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 CHANGED
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Triveria Wallet API
3
- * Triveria Wallet API
3
+ * Triveria Wallet is a cloud-based platform for managing digital credentials. The platform complies with open standards including the W3C Verifiable Credentials Data Model, IETF SD-JWT-VC, OpenID Connect (OIDC), and EBSI DID, providing a unified interface across both eIDAS/EUDI and DID/W3C ecosystems. **Key capabilities:** - Issue and manage Verifiable Credentials (W3C VC and SD-JWT-VC formats) - Credential signing using DIDs, X.509 certificates, and standard JWK keys - Trust framework integration: EBSI Trust Framework, EUDI Large Scale Pilot trust lists, and IDUnion - REST API and SDK access for seamless integration For access and support, contact info@triveria.com.
4
4
  *
5
5
  * The version of the OpenAPI document: 1.0.0
6
6
  *
@@ -1271,7 +1271,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1271
1271
  */
1272
1272
  credentialRevoke: (credentialId: string, walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1273
1273
  /**
1274
- *
1274
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
1275
1275
  * @param {string} deferredId Deferred token
1276
1276
  * @param {string} walletId
1277
1277
  * @param {*} [options] Override http request option.
@@ -1286,7 +1286,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1286
1286
  */
1287
1287
  didDocumentGet: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1288
1288
  /**
1289
- *
1289
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
1290
1290
  * @param {*} [options] Override http request option.
1291
1291
  * @throws {RequiredError}
1292
1292
  */
@@ -1300,7 +1300,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1300
1300
  */
1301
1301
  holderCreateAuthOffer: (walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1302
1302
  /**
1303
- * Presenting Verifiable Credentials after holder\'s consent.
1303
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
1304
1304
  * @param {string} walletId
1305
1305
  * @param {string} interactionId
1306
1306
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -1333,7 +1333,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1333
1333
  */
1334
1334
  holderLinkedVpDelete: (walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1335
1335
  /**
1336
- *
1336
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
1337
1337
  * @param {string} walletId
1338
1338
  * @param {string} linkedVpId
1339
1339
  * @param {*} [options] Override http request option.
@@ -1341,14 +1341,14 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1341
1341
  */
1342
1342
  holderLinkedVpGetDetails: (walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1343
1343
  /**
1344
- *
1344
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
1345
1345
  * @param {string} walletId
1346
1346
  * @param {*} [options] Override http request option.
1347
1347
  * @throws {RequiredError}
1348
1348
  */
1349
1349
  holderLinkedVpList: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1350
1350
  /**
1351
- * Retrieve authorization requirements for the credential offer.
1351
+ * 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.
1352
1352
  * @param {string} walletId
1353
1353
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
1354
1354
  * @param {*} [options] Override http request option.
@@ -1356,7 +1356,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1356
1356
  */
1357
1357
  holderOfferPassAuthInfo: (walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1358
1358
  /**
1359
- * Gives consent to process credential offer specified by `interaction_id`
1359
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
1360
1360
  * @param {string} walletId
1361
1361
  * @param {string} interactionId
1362
1362
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -1365,7 +1365,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1365
1365
  */
1366
1366
  holderOfferProcessAfterConsent: (walletId: string, interactionId: string, interactionAuthorizationConsent?: InteractionAuthorizationConsent, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1367
1367
  /**
1368
- * Initiates a presentation of credentials to a verifier.
1368
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
1369
1369
  * @param {string} walletId
1370
1370
  * @param {PresentationRequest} [presentationRequest]
1371
1371
  * @param {*} [options] Override http request option.
@@ -1373,7 +1373,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1373
1373
  */
1374
1374
  holderPresentPassAuthInfo: (walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1375
1375
  /**
1376
- * Creates an ID token request.
1376
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
1377
1377
  * @param {string} walletId
1378
1378
  * @param {*} [options] Override http request option.
1379
1379
  * @throws {RequiredError}
@@ -1387,7 +1387,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1387
1387
  */
1388
1388
  issuerCredentialTypesList: (url: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1389
1389
  /**
1390
- * Initiates issuing of Verifiable Credentials using authorized flow.
1390
+ * 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.
1391
1391
  * @param {string} walletId
1392
1392
  * @param {InitAuthOffer} [initAuthOffer]
1393
1393
  * @param {*} [options] Override http request option.
@@ -1395,7 +1395,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1395
1395
  */
1396
1396
  issuerInitiateAuthOffer: (walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1397
1397
  /**
1398
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
1398
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
1399
1399
  * @param {string} walletId
1400
1400
  * @param {InitPreAuthOffer} [initPreAuthOffer]
1401
1401
  * @param {*} [options] Override http request option.
@@ -1446,7 +1446,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1446
1446
  */
1447
1447
  pdfCredentialTwinUpload: (credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1448
1448
  /**
1449
- * Accredits a legal entity as RTAO, TAO or TI.
1449
+ * 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.
1450
1450
  * @param {string} walletId
1451
1451
  * @param {AccreditationRequest} [accreditationRequest]
1452
1452
  * @param {*} [options] Override http request option.
@@ -1454,7 +1454,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1454
1454
  */
1455
1455
  tfAccreditAs: (walletId: string, accreditationRequest?: AccreditationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1456
1456
  /**
1457
- * Processes a request to accredit another legal entity.
1457
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
1458
1458
  * @param {string} walletId
1459
1459
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
1460
1460
  * @param {*} [options] Override http request option.
@@ -1462,7 +1462,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1462
1462
  */
1463
1463
  tfAccreditRequest: (walletId: string, entityAccreditationRequest?: EntityAccreditationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1464
1464
  /**
1465
- * Onboards legal entity to the trust framework based on the wallet configuration.
1465
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
1466
1466
  * @param {string} walletId
1467
1467
  * @param {OnboardingRequest} [onboardingRequest]
1468
1468
  * @param {*} [options] Override http request option.
@@ -1470,7 +1470,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1470
1470
  */
1471
1471
  tfOnboard: (walletId: string, onboardingRequest?: OnboardingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1472
1472
  /**
1473
- * Processes a request to onboard another legal entity.
1473
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
1474
1474
  * @param {string} walletId
1475
1475
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
1476
1476
  * @param {*} [options] Override http request option.
@@ -1478,7 +1478,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1478
1478
  */
1479
1479
  tfOnboardRequest: (walletId: string, entityOnboardingRequest?: EntityOnboardingRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1480
1480
  /**
1481
- * Revokes another legal entity\'s wallet DID accreditation.
1481
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
1482
1482
  * @param {string} walletId
1483
1483
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
1484
1484
  * @param {*} [options] Override http request option.
@@ -1486,7 +1486,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1486
1486
  */
1487
1487
  tfRevokeAccreditation: (walletId: string, revokeAccreditationRequest?: RevokeAccreditationRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1488
1488
  /**
1489
- * Issues a certificate based on the provided certificate request
1489
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
1490
1490
  * @param {string} walletId
1491
1491
  * @param {CertificateIssueRequest} [certificateIssueRequest]
1492
1492
  * @param {*} [options] Override http request option.
@@ -1494,7 +1494,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1494
1494
  */
1495
1495
  tfX509CertificateIssue: (walletId: string, certificateIssueRequest?: CertificateIssueRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1496
1496
  /**
1497
- * Returns an url where verifier accepts presentations from a holder.
1497
+ * 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.
1498
1498
  * @param {string} walletId
1499
1499
  * @param {VerifyInitRequest} [verifyInitRequest]
1500
1500
  * @param {*} [options] Override http request option.
@@ -1543,7 +1543,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1543
1543
  */
1544
1544
  walletGet: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1545
1545
  /**
1546
- *
1546
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
1547
1547
  * @param {string} walletId
1548
1548
  * @param {*} [options] Override http request option.
1549
1549
  * @throws {RequiredError}
@@ -1601,7 +1601,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1601
1601
  */
1602
1602
  walletPatch: (walletId: string, walletPatchPayload?: WalletPatchPayload, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1603
1603
  /**
1604
- * Gets a specific verified credentials by state
1604
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
1605
1605
  * @param {string} walletId Wallet ID
1606
1606
  * @param {string} state Verifier state
1607
1607
  * @param {*} [options] Override http request option.
@@ -1617,7 +1617,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1617
1617
  */
1618
1618
  walletVerifiedCredentialsDeleteByState: (walletId: string, state: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1619
1619
  /**
1620
- * Creates a X509 certificate signing request for signing key.
1620
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
1621
1621
  * @param {string} walletId Wallet ID
1622
1622
  * @param {CSRCreateRequest} [cSRCreateRequest]
1623
1623
  * @param {*} [options] Override http request option.
@@ -1625,7 +1625,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1625
1625
  */
1626
1626
  walletX509CSRCreate: (walletId: string, cSRCreateRequest?: CSRCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1627
1627
  /**
1628
- * Returns an X509 certificate in PEM format
1628
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
1629
1629
  * @param {string} walletId Wallet ID
1630
1630
  * @param {*} [options] Override http request option.
1631
1631
  * @throws {RequiredError}
@@ -1640,7 +1640,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1640
1640
  */
1641
1641
  walletX509CertificateImport: (walletId: string, certificateImportRequest?: CertificateImportRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1642
1642
  /**
1643
- * Accepts a WMP invitation
1643
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
1644
1644
  * @param {string} walletId
1645
1645
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
1646
1646
  * @param {*} [options] Override http request option.
@@ -1655,7 +1655,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1655
1655
  */
1656
1656
  wmpClientGetPendingRequests: (walletId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1657
1657
  /**
1658
- * Process WMP request
1658
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
1659
1659
  * @param {string} walletId
1660
1660
  * @param {string} requestId
1661
1661
  * @param {*} [options] Override http request option.
@@ -1663,7 +1663,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1663
1663
  */
1664
1664
  wmpClientProcessRequest: (walletId: string, requestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1665
1665
  /**
1666
- * Creates a new WMP invitation
1666
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
1667
1667
  * @param {string} walletId
1668
1668
  * @param {*} [options] Override http request option.
1669
1669
  * @throws {RequiredError}
@@ -1694,7 +1694,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1694
1694
  */
1695
1695
  wmpEntityGet: (walletId: string, entityId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1696
1696
  /**
1697
- * Get all clients that have established WMP connection.
1697
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
1698
1698
  * @param {string} walletId
1699
1699
  * @param {WmpEntityListEntityTypeEnum} entityType
1700
1700
  * @param {*} [options] Override http request option.
@@ -1702,7 +1702,7 @@ export declare const DefaultApiAxiosParamCreator: (configuration?: Configuration
1702
1702
  */
1703
1703
  wmpEntityList: (walletId: string, entityType: WmpEntityListEntityTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1704
1704
  /**
1705
- * Connect to a WMP server entity
1705
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
1706
1706
  * @param {string} walletId
1707
1707
  * @param {string} entityId
1708
1708
  * @param {*} [options] Override http request option.
@@ -1797,7 +1797,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1797
1797
  */
1798
1798
  credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1799
1799
  /**
1800
- *
1800
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
1801
1801
  * @param {string} deferredId Deferred token
1802
1802
  * @param {string} walletId
1803
1803
  * @param {*} [options] Override http request option.
@@ -1812,7 +1812,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1812
1812
  */
1813
1813
  didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
1814
1814
  /**
1815
- *
1815
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
1816
1816
  * @param {*} [options] Override http request option.
1817
1817
  * @throws {RequiredError}
1818
1818
  */
@@ -1826,7 +1826,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1826
1826
  */
1827
1827
  holderCreateAuthOffer(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1828
1828
  /**
1829
- * Presenting Verifiable Credentials after holder\'s consent.
1829
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
1830
1830
  * @param {string} walletId
1831
1831
  * @param {string} interactionId
1832
1832
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -1859,7 +1859,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1859
1859
  */
1860
1860
  holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1861
1861
  /**
1862
- *
1862
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
1863
1863
  * @param {string} walletId
1864
1864
  * @param {string} linkedVpId
1865
1865
  * @param {*} [options] Override http request option.
@@ -1867,14 +1867,14 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1867
1867
  */
1868
1868
  holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkedVpMetadata>>;
1869
1869
  /**
1870
- *
1870
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
1871
1871
  * @param {string} walletId
1872
1872
  * @param {*} [options] Override http request option.
1873
1873
  * @throws {RequiredError}
1874
1874
  */
1875
1875
  holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LinkedVpMetadata>>>;
1876
1876
  /**
1877
- * Retrieve authorization requirements for the credential offer.
1877
+ * 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.
1878
1878
  * @param {string} walletId
1879
1879
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
1880
1880
  * @param {*} [options] Override http request option.
@@ -1882,7 +1882,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1882
1882
  */
1883
1883
  holderOfferPassAuthInfo(walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InteractionAuthorizationRequirements>>;
1884
1884
  /**
1885
- * Gives consent to process credential offer specified by `interaction_id`
1885
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
1886
1886
  * @param {string} walletId
1887
1887
  * @param {string} interactionId
1888
1888
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -1891,7 +1891,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1891
1891
  */
1892
1892
  holderOfferProcessAfterConsent(walletId: string, interactionId: string, interactionAuthorizationConsent?: InteractionAuthorizationConsent, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
1893
1893
  /**
1894
- * Initiates a presentation of credentials to a verifier.
1894
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
1895
1895
  * @param {string} walletId
1896
1896
  * @param {PresentationRequest} [presentationRequest]
1897
1897
  * @param {*} [options] Override http request option.
@@ -1899,7 +1899,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1899
1899
  */
1900
1900
  holderPresentPassAuthInfo(walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InteractionAuthorizationRequirements>>;
1901
1901
  /**
1902
- * Creates an ID token request.
1902
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
1903
1903
  * @param {string} walletId
1904
1904
  * @param {*} [options] Override http request option.
1905
1905
  * @throws {RequiredError}
@@ -1913,7 +1913,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1913
1913
  */
1914
1914
  issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CredentialType>>>;
1915
1915
  /**
1916
- * Initiates issuing of Verifiable Credentials using authorized flow.
1916
+ * 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.
1917
1917
  * @param {string} walletId
1918
1918
  * @param {InitAuthOffer} [initAuthOffer]
1919
1919
  * @param {*} [options] Override http request option.
@@ -1921,7 +1921,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1921
1921
  */
1922
1922
  issuerInitiateAuthOffer(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AuthOffer>>;
1923
1923
  /**
1924
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
1924
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
1925
1925
  * @param {string} walletId
1926
1926
  * @param {InitPreAuthOffer} [initPreAuthOffer]
1927
1927
  * @param {*} [options] Override http request option.
@@ -1972,7 +1972,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1972
1972
  */
1973
1973
  pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1974
1974
  /**
1975
- * Accredits a legal entity as RTAO, TAO or TI.
1975
+ * 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.
1976
1976
  * @param {string} walletId
1977
1977
  * @param {AccreditationRequest} [accreditationRequest]
1978
1978
  * @param {*} [options] Override http request option.
@@ -1980,7 +1980,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1980
1980
  */
1981
1981
  tfAccreditAs(walletId: string, accreditationRequest?: AccreditationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1982
1982
  /**
1983
- * Processes a request to accredit another legal entity.
1983
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
1984
1984
  * @param {string} walletId
1985
1985
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
1986
1986
  * @param {*} [options] Override http request option.
@@ -1988,7 +1988,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1988
1988
  */
1989
1989
  tfAccreditRequest(walletId: string, entityAccreditationRequest?: EntityAccreditationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
1990
1990
  /**
1991
- * Onboards legal entity to the trust framework based on the wallet configuration.
1991
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
1992
1992
  * @param {string} walletId
1993
1993
  * @param {OnboardingRequest} [onboardingRequest]
1994
1994
  * @param {*} [options] Override http request option.
@@ -1996,7 +1996,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
1996
1996
  */
1997
1997
  tfOnboard(walletId: string, onboardingRequest?: OnboardingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnboardResult>>;
1998
1998
  /**
1999
- * Processes a request to onboard another legal entity.
1999
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
2000
2000
  * @param {string} walletId
2001
2001
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
2002
2002
  * @param {*} [options] Override http request option.
@@ -2004,7 +2004,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2004
2004
  */
2005
2005
  tfOnboardRequest(walletId: string, entityOnboardingRequest?: EntityOnboardingRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2006
2006
  /**
2007
- * Revokes another legal entity\'s wallet DID accreditation.
2007
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
2008
2008
  * @param {string} walletId
2009
2009
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
2010
2010
  * @param {*} [options] Override http request option.
@@ -2012,7 +2012,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2012
2012
  */
2013
2013
  tfRevokeAccreditation(walletId: string, revokeAccreditationRequest?: RevokeAccreditationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2014
2014
  /**
2015
- * Issues a certificate based on the provided certificate request
2015
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
2016
2016
  * @param {string} walletId
2017
2017
  * @param {CertificateIssueRequest} [certificateIssueRequest]
2018
2018
  * @param {*} [options] Override http request option.
@@ -2020,7 +2020,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2020
2020
  */
2021
2021
  tfX509CertificateIssue(walletId: string, certificateIssueRequest?: CertificateIssueRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificateIssueResponse>>;
2022
2022
  /**
2023
- * Returns an url where verifier accepts presentations from a holder.
2023
+ * 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.
2024
2024
  * @param {string} walletId
2025
2025
  * @param {VerifyInitRequest} [verifyInitRequest]
2026
2026
  * @param {*} [options] Override http request option.
@@ -2069,7 +2069,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2069
2069
  */
2070
2070
  walletGet(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Wallet>>;
2071
2071
  /**
2072
- *
2072
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
2073
2073
  * @param {string} walletId
2074
2074
  * @param {*} [options] Override http request option.
2075
2075
  * @throws {RequiredError}
@@ -2129,7 +2129,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2129
2129
  */
2130
2130
  walletPatch(walletId: string, walletPatchPayload?: WalletPatchPayload, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WalletIdObject>>;
2131
2131
  /**
2132
- * Gets a specific verified credentials by state
2132
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
2133
2133
  * @param {string} walletId Wallet ID
2134
2134
  * @param {string} state Verifier state
2135
2135
  * @param {*} [options] Override http request option.
@@ -2145,7 +2145,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2145
2145
  */
2146
2146
  walletVerifiedCredentialsDeleteByState(walletId: string, state: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2147
2147
  /**
2148
- * Creates a X509 certificate signing request for signing key.
2148
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
2149
2149
  * @param {string} walletId Wallet ID
2150
2150
  * @param {CSRCreateRequest} [cSRCreateRequest]
2151
2151
  * @param {*} [options] Override http request option.
@@ -2153,7 +2153,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2153
2153
  */
2154
2154
  walletX509CSRCreate(walletId: string, cSRCreateRequest?: CSRCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CSRCreateResponse>>;
2155
2155
  /**
2156
- * Returns an X509 certificate in PEM format
2156
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
2157
2157
  * @param {string} walletId Wallet ID
2158
2158
  * @param {*} [options] Override http request option.
2159
2159
  * @throws {RequiredError}
@@ -2168,7 +2168,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2168
2168
  */
2169
2169
  walletX509CertificateImport(walletId: string, certificateImportRequest?: CertificateImportRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
2170
2170
  /**
2171
- * Accepts a WMP invitation
2171
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
2172
2172
  * @param {string} walletId
2173
2173
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
2174
2174
  * @param {*} [options] Override http request option.
@@ -2183,7 +2183,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2183
2183
  */
2184
2184
  wmpClientGetPendingRequests(walletId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WmpRequest>>>;
2185
2185
  /**
2186
- * Process WMP request
2186
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
2187
2187
  * @param {string} walletId
2188
2188
  * @param {string} requestId
2189
2189
  * @param {*} [options] Override http request option.
@@ -2191,7 +2191,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2191
2191
  */
2192
2192
  wmpClientProcessRequest(walletId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InteractionAuthorizationRequirements>>;
2193
2193
  /**
2194
- * Creates a new WMP invitation
2194
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
2195
2195
  * @param {string} walletId
2196
2196
  * @param {*} [options] Override http request option.
2197
2197
  * @throws {RequiredError}
@@ -2222,7 +2222,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2222
2222
  */
2223
2223
  wmpEntityGet(walletId: string, entityId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WmpEntityRecord>>;
2224
2224
  /**
2225
- * Get all clients that have established WMP connection.
2225
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
2226
2226
  * @param {string} walletId
2227
2227
  * @param {WmpEntityListEntityTypeEnum} entityType
2228
2228
  * @param {*} [options] Override http request option.
@@ -2230,7 +2230,7 @@ export declare const DefaultApiFp: (configuration?: Configuration) => {
2230
2230
  */
2231
2231
  wmpEntityList(walletId: string, entityType: WmpEntityListEntityTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<WmpEntityRecord>>>;
2232
2232
  /**
2233
- * Connect to a WMP server entity
2233
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
2234
2234
  * @param {string} walletId
2235
2235
  * @param {string} entityId
2236
2236
  * @param {*} [options] Override http request option.
@@ -2325,7 +2325,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2325
2325
  */
2326
2326
  credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2327
2327
  /**
2328
- *
2328
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
2329
2329
  * @param {string} deferredId Deferred token
2330
2330
  * @param {string} walletId
2331
2331
  * @param {*} [options] Override http request option.
@@ -2340,7 +2340,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2340
2340
  */
2341
2341
  didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<object>;
2342
2342
  /**
2343
- *
2343
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
2344
2344
  * @param {*} [options] Override http request option.
2345
2345
  * @throws {RequiredError}
2346
2346
  */
@@ -2354,7 +2354,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2354
2354
  */
2355
2355
  holderCreateAuthOffer(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2356
2356
  /**
2357
- * Presenting Verifiable Credentials after holder\'s consent.
2357
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
2358
2358
  * @param {string} walletId
2359
2359
  * @param {string} interactionId
2360
2360
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2387,7 +2387,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2387
2387
  */
2388
2388
  holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2389
2389
  /**
2390
- *
2390
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
2391
2391
  * @param {string} walletId
2392
2392
  * @param {string} linkedVpId
2393
2393
  * @param {*} [options] Override http request option.
@@ -2395,14 +2395,14 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2395
2395
  */
2396
2396
  holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): AxiosPromise<LinkedVpMetadata>;
2397
2397
  /**
2398
- *
2398
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
2399
2399
  * @param {string} walletId
2400
2400
  * @param {*} [options] Override http request option.
2401
2401
  * @throws {RequiredError}
2402
2402
  */
2403
2403
  holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<LinkedVpMetadata>>;
2404
2404
  /**
2405
- * Retrieve authorization requirements for the credential offer.
2405
+ * 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.
2406
2406
  * @param {string} walletId
2407
2407
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
2408
2408
  * @param {*} [options] Override http request option.
@@ -2410,7 +2410,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2410
2410
  */
2411
2411
  holderOfferPassAuthInfo(walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig): AxiosPromise<InteractionAuthorizationRequirements>;
2412
2412
  /**
2413
- * Gives consent to process credential offer specified by `interaction_id`
2413
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
2414
2414
  * @param {string} walletId
2415
2415
  * @param {string} interactionId
2416
2416
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2419,7 +2419,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2419
2419
  */
2420
2420
  holderOfferProcessAfterConsent(walletId: string, interactionId: string, interactionAuthorizationConsent?: InteractionAuthorizationConsent, options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
2421
2421
  /**
2422
- * Initiates a presentation of credentials to a verifier.
2422
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
2423
2423
  * @param {string} walletId
2424
2424
  * @param {PresentationRequest} [presentationRequest]
2425
2425
  * @param {*} [options] Override http request option.
@@ -2427,7 +2427,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2427
2427
  */
2428
2428
  holderPresentPassAuthInfo(walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig): AxiosPromise<InteractionAuthorizationRequirements>;
2429
2429
  /**
2430
- * Creates an ID token request.
2430
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
2431
2431
  * @param {string} walletId
2432
2432
  * @param {*} [options] Override http request option.
2433
2433
  * @throws {RequiredError}
@@ -2441,7 +2441,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2441
2441
  */
2442
2442
  issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<CredentialType>>;
2443
2443
  /**
2444
- * Initiates issuing of Verifiable Credentials using authorized flow.
2444
+ * 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.
2445
2445
  * @param {string} walletId
2446
2446
  * @param {InitAuthOffer} [initAuthOffer]
2447
2447
  * @param {*} [options] Override http request option.
@@ -2449,7 +2449,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2449
2449
  */
2450
2450
  issuerInitiateAuthOffer(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): AxiosPromise<AuthOffer>;
2451
2451
  /**
2452
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
2452
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
2453
2453
  * @param {string} walletId
2454
2454
  * @param {InitPreAuthOffer} [initPreAuthOffer]
2455
2455
  * @param {*} [options] Override http request option.
@@ -2500,7 +2500,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2500
2500
  */
2501
2501
  pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2502
2502
  /**
2503
- * Accredits a legal entity as RTAO, TAO or TI.
2503
+ * 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.
2504
2504
  * @param {string} walletId
2505
2505
  * @param {AccreditationRequest} [accreditationRequest]
2506
2506
  * @param {*} [options] Override http request option.
@@ -2508,7 +2508,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2508
2508
  */
2509
2509
  tfAccreditAs(walletId: string, accreditationRequest?: AccreditationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2510
2510
  /**
2511
- * Processes a request to accredit another legal entity.
2511
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
2512
2512
  * @param {string} walletId
2513
2513
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
2514
2514
  * @param {*} [options] Override http request option.
@@ -2516,7 +2516,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2516
2516
  */
2517
2517
  tfAccreditRequest(walletId: string, entityAccreditationRequest?: EntityAccreditationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2518
2518
  /**
2519
- * Onboards legal entity to the trust framework based on the wallet configuration.
2519
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
2520
2520
  * @param {string} walletId
2521
2521
  * @param {OnboardingRequest} [onboardingRequest]
2522
2522
  * @param {*} [options] Override http request option.
@@ -2524,7 +2524,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2524
2524
  */
2525
2525
  tfOnboard(walletId: string, onboardingRequest?: OnboardingRequest, options?: RawAxiosRequestConfig): AxiosPromise<OnboardResult>;
2526
2526
  /**
2527
- * Processes a request to onboard another legal entity.
2527
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
2528
2528
  * @param {string} walletId
2529
2529
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
2530
2530
  * @param {*} [options] Override http request option.
@@ -2532,7 +2532,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2532
2532
  */
2533
2533
  tfOnboardRequest(walletId: string, entityOnboardingRequest?: EntityOnboardingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2534
2534
  /**
2535
- * Revokes another legal entity\'s wallet DID accreditation.
2535
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
2536
2536
  * @param {string} walletId
2537
2537
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
2538
2538
  * @param {*} [options] Override http request option.
@@ -2540,7 +2540,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2540
2540
  */
2541
2541
  tfRevokeAccreditation(walletId: string, revokeAccreditationRequest?: RevokeAccreditationRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2542
2542
  /**
2543
- * Issues a certificate based on the provided certificate request
2543
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
2544
2544
  * @param {string} walletId
2545
2545
  * @param {CertificateIssueRequest} [certificateIssueRequest]
2546
2546
  * @param {*} [options] Override http request option.
@@ -2548,7 +2548,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2548
2548
  */
2549
2549
  tfX509CertificateIssue(walletId: string, certificateIssueRequest?: CertificateIssueRequest, options?: RawAxiosRequestConfig): AxiosPromise<CertificateIssueResponse>;
2550
2550
  /**
2551
- * Returns an url where verifier accepts presentations from a holder.
2551
+ * 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.
2552
2552
  * @param {string} walletId
2553
2553
  * @param {VerifyInitRequest} [verifyInitRequest]
2554
2554
  * @param {*} [options] Override http request option.
@@ -2597,7 +2597,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2597
2597
  */
2598
2598
  walletGet(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Wallet>;
2599
2599
  /**
2600
- *
2600
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
2601
2601
  * @param {string} walletId
2602
2602
  * @param {*} [options] Override http request option.
2603
2603
  * @throws {RequiredError}
@@ -2657,7 +2657,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2657
2657
  */
2658
2658
  walletPatch(walletId: string, walletPatchPayload?: WalletPatchPayload, options?: RawAxiosRequestConfig): AxiosPromise<WalletIdObject>;
2659
2659
  /**
2660
- * Gets a specific verified credentials by state
2660
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
2661
2661
  * @param {string} walletId Wallet ID
2662
2662
  * @param {string} state Verifier state
2663
2663
  * @param {*} [options] Override http request option.
@@ -2673,7 +2673,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2673
2673
  */
2674
2674
  walletVerifiedCredentialsDeleteByState(walletId: string, state: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2675
2675
  /**
2676
- * Creates a X509 certificate signing request for signing key.
2676
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
2677
2677
  * @param {string} walletId Wallet ID
2678
2678
  * @param {CSRCreateRequest} [cSRCreateRequest]
2679
2679
  * @param {*} [options] Override http request option.
@@ -2681,7 +2681,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2681
2681
  */
2682
2682
  walletX509CSRCreate(walletId: string, cSRCreateRequest?: CSRCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<CSRCreateResponse>;
2683
2683
  /**
2684
- * Returns an X509 certificate in PEM format
2684
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
2685
2685
  * @param {string} walletId Wallet ID
2686
2686
  * @param {*} [options] Override http request option.
2687
2687
  * @throws {RequiredError}
@@ -2696,7 +2696,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2696
2696
  */
2697
2697
  walletX509CertificateImport(walletId: string, certificateImportRequest?: CertificateImportRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
2698
2698
  /**
2699
- * Accepts a WMP invitation
2699
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
2700
2700
  * @param {string} walletId
2701
2701
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
2702
2702
  * @param {*} [options] Override http request option.
@@ -2711,7 +2711,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2711
2711
  */
2712
2712
  wmpClientGetPendingRequests(walletId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<WmpRequest>>;
2713
2713
  /**
2714
- * Process WMP request
2714
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
2715
2715
  * @param {string} walletId
2716
2716
  * @param {string} requestId
2717
2717
  * @param {*} [options] Override http request option.
@@ -2719,7 +2719,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2719
2719
  */
2720
2720
  wmpClientProcessRequest(walletId: string, requestId: string, options?: RawAxiosRequestConfig): AxiosPromise<InteractionAuthorizationRequirements>;
2721
2721
  /**
2722
- * Creates a new WMP invitation
2722
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
2723
2723
  * @param {string} walletId
2724
2724
  * @param {*} [options] Override http request option.
2725
2725
  * @throws {RequiredError}
@@ -2750,7 +2750,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2750
2750
  */
2751
2751
  wmpEntityGet(walletId: string, entityId: string, options?: RawAxiosRequestConfig): AxiosPromise<WmpEntityRecord>;
2752
2752
  /**
2753
- * Get all clients that have established WMP connection.
2753
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
2754
2754
  * @param {string} walletId
2755
2755
  * @param {WmpEntityListEntityTypeEnum} entityType
2756
2756
  * @param {*} [options] Override http request option.
@@ -2758,7 +2758,7 @@ export declare const DefaultApiFactory: (configuration?: Configuration, basePath
2758
2758
  */
2759
2759
  wmpEntityList(walletId: string, entityType: WmpEntityListEntityTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<Array<WmpEntityRecord>>;
2760
2760
  /**
2761
- * Connect to a WMP server entity
2761
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
2762
2762
  * @param {string} walletId
2763
2763
  * @param {string} entityId
2764
2764
  * @param {*} [options] Override http request option.
@@ -2853,7 +2853,7 @@ export declare class DefaultApi extends BaseAPI {
2853
2853
  */
2854
2854
  credentialRevoke(credentialId: string, walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2855
2855
  /**
2856
- *
2856
+ * Polls the status of a deferred credential issuance. Returns `in_progress` while the operation is still pending, or `completed` with the resulting credential ID when done. Clients should poll this endpoint until a terminal status is reached.
2857
2857
  * @param {string} deferredId Deferred token
2858
2858
  * @param {string} walletId
2859
2859
  * @param {*} [options] Override http request option.
@@ -2868,7 +2868,7 @@ export declare class DefaultApi extends BaseAPI {
2868
2868
  */
2869
2869
  didDocumentGet(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
2870
2870
  /**
2871
- *
2871
+ * Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
2872
2872
  * @param {*} [options] Override http request option.
2873
2873
  * @throws {RequiredError}
2874
2874
  */
@@ -2882,7 +2882,7 @@ export declare class DefaultApi extends BaseAPI {
2882
2882
  */
2883
2883
  holderCreateAuthOffer(walletId: string, holderAuthOfferCreationRequest?: HolderAuthOfferCreationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2884
2884
  /**
2885
- * Presenting Verifiable Credentials after holder\'s consent.
2885
+ * Completes a credential presentation flow: submits the selected credentials to the verifier after the holder\'s explicit consent. The `interaction_id` is obtained from `HolderPresentPassAuthInfo`.
2886
2886
  * @param {string} walletId
2887
2887
  * @param {string} interactionId
2888
2888
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2915,7 +2915,7 @@ export declare class DefaultApi extends BaseAPI {
2915
2915
  */
2916
2916
  holderLinkedVpDelete(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
2917
2917
  /**
2918
- *
2918
+ * Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
2919
2919
  * @param {string} walletId
2920
2920
  * @param {string} linkedVpId
2921
2921
  * @param {*} [options] Override http request option.
@@ -2923,14 +2923,14 @@ export declare class DefaultApi extends BaseAPI {
2923
2923
  */
2924
2924
  holderLinkedVpGetDetails(walletId: string, linkedVpId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedVpMetadata, any, {}>>;
2925
2925
  /**
2926
- *
2926
+ * Returns all linked Verifiable Presentations published in the wallet\'s DID document,
2927
2927
  * @param {string} walletId
2928
2928
  * @param {*} [options] Override http request option.
2929
2929
  * @throws {RequiredError}
2930
2930
  */
2931
2931
  holderLinkedVpList(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkedVpMetadata[], any, {}>>;
2932
2932
  /**
2933
- * Retrieve authorization requirements for the credential offer.
2933
+ * 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.
2934
2934
  * @param {string} walletId
2935
2935
  * @param {VcOffer} [vcOffer] Verifiable Credential offer
2936
2936
  * @param {*} [options] Override http request option.
@@ -2938,7 +2938,7 @@ export declare class DefaultApi extends BaseAPI {
2938
2938
  */
2939
2939
  holderOfferPassAuthInfo(walletId: string, vcOffer?: VcOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InteractionAuthorizationRequirements, any, {}>>;
2940
2940
  /**
2941
- * Gives consent to process credential offer specified by `interaction_id`
2941
+ * Completes a credential offer flow after holder consent: submits data needed for the holder to authorize candidates to the issuer for holder authorization and retrieves the issued credential(s) into the wallet. The `interaction_id` is obtained from `HolderOfferPassAuthInfo`.
2942
2942
  * @param {string} walletId
2943
2943
  * @param {string} interactionId
2944
2944
  * @param {InteractionAuthorizationConsent} [interactionAuthorizationConsent]
@@ -2947,7 +2947,7 @@ export declare class DefaultApi extends BaseAPI {
2947
2947
  */
2948
2948
  holderOfferProcessAfterConsent(walletId: string, interactionId: string, interactionAuthorizationConsent?: InteractionAuthorizationConsent, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
2949
2949
  /**
2950
- * Initiates a presentation of credentials to a verifier.
2950
+ * Processes a verifier\'s presentation request URL and returns the presentation definition along with matching credential candidates from the wallet. The holder reviews which credentials will be disclosed before giving consent. The returned `interactionId` is used in the subsequent `HolderCredentialsPresentAfterConsent` call.
2951
2951
  * @param {string} walletId
2952
2952
  * @param {PresentationRequest} [presentationRequest]
2953
2953
  * @param {*} [options] Override http request option.
@@ -2955,7 +2955,7 @@ export declare class DefaultApi extends BaseAPI {
2955
2955
  */
2956
2956
  holderPresentPassAuthInfo(walletId: string, presentationRequest?: PresentationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InteractionAuthorizationRequirements, any, {}>>;
2957
2957
  /**
2958
- * Creates an ID token request.
2958
+ * Creates an ID token request that will be sent to the holder for DID-based authentication. Used during the authorized credential issuance flow when the issuer requires the holder to prove control of their DID before the credential is issued. The returned request ID is passed to `CredentialIssuanceInit` as `idTokenRequestId`.
2959
2959
  * @param {string} walletId
2960
2960
  * @param {*} [options] Override http request option.
2961
2961
  * @throws {RequiredError}
@@ -2969,7 +2969,7 @@ export declare class DefaultApi extends BaseAPI {
2969
2969
  */
2970
2970
  issuerCredentialTypesList(url: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CredentialType[], any, {}>>;
2971
2971
  /**
2972
- * Initiates issuing of Verifiable Credentials using authorized flow.
2972
+ * 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.
2973
2973
  * @param {string} walletId
2974
2974
  * @param {InitAuthOffer} [initAuthOffer]
2975
2975
  * @param {*} [options] Override http request option.
@@ -2977,7 +2977,7 @@ export declare class DefaultApi extends BaseAPI {
2977
2977
  */
2978
2978
  issuerInitiateAuthOffer(walletId: string, initAuthOffer?: InitAuthOffer, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AuthOffer, any, {}>>;
2979
2979
  /**
2980
- * Initiates issuing of Verifiable Credentials using pre-authorized flow.
2980
+ * Generates a pre-authorized credential offer for the holder. Unlike the authorized flow, the holder does not need to authenticate with the issuer — instead a pre-authorized code (and optional PIN) is embedded in the offer URL. The resulting offer URL is returned and Generates a pre-authorized credential offer for the holder. The resulting offer URL is returned and can be shared as a QR code or deep link.
2981
2981
  * @param {string} walletId
2982
2982
  * @param {InitPreAuthOffer} [initPreAuthOffer]
2983
2983
  * @param {*} [options] Override http request option.
@@ -3028,7 +3028,7 @@ export declare class DefaultApi extends BaseAPI {
3028
3028
  */
3029
3029
  pdfCredentialTwinUpload(credentialId: string, walletId: string, pdf?: File, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3030
3030
  /**
3031
- * Accredits a legal entity as RTAO, TAO or TI.
3031
+ * 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.
3032
3032
  * @param {string} walletId
3033
3033
  * @param {AccreditationRequest} [accreditationRequest]
3034
3034
  * @param {*} [options] Override http request option.
@@ -3036,7 +3036,7 @@ export declare class DefaultApi extends BaseAPI {
3036
3036
  */
3037
3037
  tfAccreditAs(walletId: string, accreditationRequest?: AccreditationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3038
3038
  /**
3039
- * Processes a request to accredit another legal entity.
3039
+ * Used by a TAO/RTAO wallet to process and approve an incoming accreditation request from another legal entity. Issues an accreditation credential authorizing the entity to issue credentials of the specified type within the trust framework.
3040
3040
  * @param {string} walletId
3041
3041
  * @param {EntityAccreditationRequest} [entityAccreditationRequest]
3042
3042
  * @param {*} [options] Override http request option.
@@ -3044,7 +3044,7 @@ export declare class DefaultApi extends BaseAPI {
3044
3044
  */
3045
3045
  tfAccreditRequest(walletId: string, entityAccreditationRequest?: EntityAccreditationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3046
3046
  /**
3047
- * Onboards legal entity to the trust framework based on the wallet configuration.
3047
+ * Completes the trust framework onboarding of this wallet using the specified onboarding credential. After successful onboarding, the wallet\'s DID is registered in the trust framework\'s TAO/TI hierarchy, enabling it to issue or verify trust-framework credentials.
3048
3048
  * @param {string} walletId
3049
3049
  * @param {OnboardingRequest} [onboardingRequest]
3050
3050
  * @param {*} [options] Override http request option.
@@ -3052,7 +3052,7 @@ export declare class DefaultApi extends BaseAPI {
3052
3052
  */
3053
3053
  tfOnboard(walletId: string, onboardingRequest?: OnboardingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OnboardResult, any, {}>>;
3054
3054
  /**
3055
- * Processes a request to onboard another legal entity.
3055
+ * Used by a TAO/RTAO wallet to process and approve an incoming onboarding request from another legal entity. Issues an onboarding credential (TIA) to the requesting entity, registering them in the trust framework.
3056
3056
  * @param {string} walletId
3057
3057
  * @param {EntityOnboardingRequest} [entityOnboardingRequest]
3058
3058
  * @param {*} [options] Override http request option.
@@ -3060,7 +3060,7 @@ export declare class DefaultApi extends BaseAPI {
3060
3060
  */
3061
3061
  tfOnboardRequest(walletId: string, entityOnboardingRequest?: EntityOnboardingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3062
3062
  /**
3063
- * Revokes another legal entity\'s wallet DID accreditation.
3063
+ * Revokes another legal entity\'s accreditation or trust framework registration by invalidating their credential in the trust status list.
3064
3064
  * @param {string} walletId
3065
3065
  * @param {RevokeAccreditationRequest} [revokeAccreditationRequest]
3066
3066
  * @param {*} [options] Override http request option.
@@ -3068,7 +3068,7 @@ export declare class DefaultApi extends BaseAPI {
3068
3068
  */
3069
3069
  tfRevokeAccreditation(walletId: string, revokeAccreditationRequest?: RevokeAccreditationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3070
3070
  /**
3071
- * Issues a certificate based on the provided certificate request
3071
+ * Issues a signed X509 certificate based on the provided CSR. Used by a CA-capable wallet to sign certificate requests from other wallets, enabling them to sign credentials with X509 certificate echains and/or perform XAdES/PDF signing.
3072
3072
  * @param {string} walletId
3073
3073
  * @param {CertificateIssueRequest} [certificateIssueRequest]
3074
3074
  * @param {*} [options] Override http request option.
@@ -3076,7 +3076,7 @@ export declare class DefaultApi extends BaseAPI {
3076
3076
  */
3077
3077
  tfX509CertificateIssue(walletId: string, certificateIssueRequest?: CertificateIssueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificateIssueResponse, any, {}>>;
3078
3078
  /**
3079
- * Returns an url where verifier accepts presentations from a holder.
3079
+ * 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.
3080
3080
  * @param {string} walletId
3081
3081
  * @param {VerifyInitRequest} [verifyInitRequest]
3082
3082
  * @param {*} [options] Override http request option.
@@ -3125,7 +3125,7 @@ export declare class DefaultApi extends BaseAPI {
3125
3125
  */
3126
3126
  walletGet(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Wallet, any, {}>>;
3127
3127
  /**
3128
- *
3128
+ * Returns the wallet\'s public identifier — e.g. a DID (Decentralized Identifier) or a wallet URL. Used by other parties to reference this wallet in trust framework interactions and credential exchanges.
3129
3129
  * @param {string} walletId
3130
3130
  * @param {*} [options] Override http request option.
3131
3131
  * @throws {RequiredError}
@@ -3185,7 +3185,7 @@ export declare class DefaultApi extends BaseAPI {
3185
3185
  */
3186
3186
  walletPatch(walletId: string, walletPatchPayload?: WalletPatchPayload, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WalletIdObject, any, {}>>;
3187
3187
  /**
3188
- * Gets a specific verified credentials by state
3188
+ * Retrieves the result of a credential verification session identified by the verifier state. Called by the verifier after a holder has presented credentials in response to a `VerifierInitUrlCreate` request. Returns 204 if the holder has not yet presented.
3189
3189
  * @param {string} walletId Wallet ID
3190
3190
  * @param {string} state Verifier state
3191
3191
  * @param {*} [options] Override http request option.
@@ -3201,7 +3201,7 @@ export declare class DefaultApi extends BaseAPI {
3201
3201
  */
3202
3202
  walletVerifiedCredentialsDeleteByState(walletId: string, state: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3203
3203
  /**
3204
- * Creates a X509 certificate signing request for signing key.
3204
+ * Creates an X509 Certificate Signing Request (CSR) for the wallet\'s signing key. The resulting certificate is imported back via `WalletX509CertificateImport` to enable issuing credentials signed by X509 certificate chain it or XAdES/PDF signing.
3205
3205
  * @param {string} walletId Wallet ID
3206
3206
  * @param {CSRCreateRequest} [cSRCreateRequest]
3207
3207
  * @param {*} [options] Override http request option.
@@ -3209,7 +3209,7 @@ export declare class DefaultApi extends BaseAPI {
3209
3209
  */
3210
3210
  walletX509CSRCreate(walletId: string, cSRCreateRequest?: CSRCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CSRCreateResponse, any, {}>>;
3211
3211
  /**
3212
- * Returns an X509 certificate in PEM format
3212
+ * Returns the wallet\'s currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
3213
3213
  * @param {string} walletId Wallet ID
3214
3214
  * @param {*} [options] Override http request option.
3215
3215
  * @throws {RequiredError}
@@ -3224,7 +3224,7 @@ export declare class DefaultApi extends BaseAPI {
3224
3224
  */
3225
3225
  walletX509CertificateImport(walletId: string, certificateImportRequest?: CertificateImportRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
3226
3226
  /**
3227
- * Accepts a WMP invitation
3227
+ * Accepts a WMP invitation URL from another wallet (issuer or verifier) to establish a peer-to-peer WMP connection. After acceptance, the connected entity appears in the WMP entity list and can send credential offers or verification requests directly to this wallet.
3228
3228
  * @param {string} walletId
3229
3229
  * @param {WmpAcceptInvitationPayload} [wmpAcceptInvitationPayload]
3230
3230
  * @param {*} [options] Override http request option.
@@ -3239,7 +3239,7 @@ export declare class DefaultApi extends BaseAPI {
3239
3239
  */
3240
3240
  wmpClientGetPendingRequests(walletId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WmpRequest[], any, {}>>;
3241
3241
  /**
3242
- * Process WMP request
3242
+ * Processes a pending WMP request (credential offer or credential verification request) received from a connected WMP server entity. Returns the authorization requirements that must be satisfied — used as the entry point into the offer or presentation flow instead of passing a URL to `HolderOfferPassAuthInfo` or `HolderPresentPassAuthInfo`.
3243
3243
  * @param {string} walletId
3244
3244
  * @param {string} requestId
3245
3245
  * @param {*} [options] Override http request option.
@@ -3247,7 +3247,7 @@ export declare class DefaultApi extends BaseAPI {
3247
3247
  */
3248
3248
  wmpClientProcessRequest(walletId: string, requestId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InteractionAuthorizationRequirements, any, {}>>;
3249
3249
  /**
3250
- * Creates a new WMP invitation
3250
+ * Creates a WMP (Wallet Messaging Protocol) invitation URL that can be shared with another wallet to establish a secure peer-to-peer communication channel. Issuers and verifiers use this to connect with holder wallets for direct credential delivery and verification without requiring QR codes or redirects on each interaction.
3251
3251
  * @param {string} walletId
3252
3252
  * @param {*} [options] Override http request option.
3253
3253
  * @throws {RequiredError}
@@ -3278,7 +3278,7 @@ export declare class DefaultApi extends BaseAPI {
3278
3278
  */
3279
3279
  wmpEntityGet(walletId: string, entityId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WmpEntityRecord, any, {}>>;
3280
3280
  /**
3281
- * Get all clients that have established WMP connection.
3281
+ * Lists all wallets that have established a WMP connection with this wallet. Filter by `entityType=server` for entities that created the invitation (issuers/verifiers), or `entityType=client` for entities that accepted it (holders).
3282
3282
  * @param {string} walletId
3283
3283
  * @param {WmpEntityListEntityTypeEnum} entityType
3284
3284
  * @param {*} [options] Override http request option.
@@ -3286,7 +3286,7 @@ export declare class DefaultApi extends BaseAPI {
3286
3286
  */
3287
3287
  wmpEntityList(walletId: string, entityType: WmpEntityListEntityTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<WmpEntityRecord[], any, {}>>;
3288
3288
  /**
3289
- * Connect to a WMP server entity
3289
+ * Re-establishes or confirms the WebSocket connection to a WMP server entity. Used to reconnect after a dropped connection so the wallet can resume receiving pending requests.
3290
3290
  * @param {string} walletId
3291
3291
  * @param {string} entityId
3292
3292
  * @param {*} [options] Override http request option.