@triveria/wallet / Exports / Client
Class: Client
DefaultApi - object-oriented interface
Export
DefaultApi
Hierarchy
-
↳
Client
Table of contents
Constructors
Properties
Methods
- credentialCreate
- credentialGet
- credentialImport
- credentialIssuanceInit
- credentialList
- credentialMetadataPatch
- credentialPatch
- credentialRequestInit
- credentialRevoke
- deferredStatus
- didDocumentGet
- healthCheck
- holderCreateAuthOffer
- holderCredentialsPresentAfterConsent
- holderIdTokenSend
- holderLinkedVpCreate
- holderLinkedVpDelete
- holderLinkedVpGetDetails
- holderLinkedVpList
- holderOfferPassAuthInfo
- holderOfferProcessAfterConsent
- holderPresentPassAuthInfo
- idTokenRequestCreate
- issuerCredentialTypesList
- issuerInitiateAuthOffer
- issuerInitiatePreauthOffer
- issuerXadesSign
- pdfCredentialMakeVp
- pdfCredentialTwinDelete
- pdfCredentialTwinGet
- pdfCredentialTwinUpload
- tfAccreditAs
- tfAccreditRequest
- tfOnboard
- tfOnboardRequest
- tfRevokeAccreditation
- tfX509CertificateGetRecord
- tfX509CertificateIssue
- tfX509CertificateListRecords
- tfX509CertificateUpdateStatus
- trustListAdd
- trustListDelete
- trustListRefresh
- trustListsGet
- verifierInitUrlCreate
- verifierLinkedVpVerify
- verifierPdfVerify
- walletCreate
- walletDelete
- walletGet
- walletIdentifierGet
- walletKeys
- walletList
- walletNotificationGetByState
- walletNotificationHistory
- walletNotifications
- walletPatch
- walletProviderCertificateImport
- walletProviderCsrGenerate
- walletVerifiedCredentialsByState
- walletVerifiedCredentialsDeleteByState
- walletX509CSRCreate
- walletX509CertificateGet
- walletX509CertificateImport
- wmpAcceptInvitation
- wmpClientGetPendingRequests
- wmpClientProcessRequest
- wmpCreateNewInvitation
- wmpEntityConnectionGet
- wmpEntityDelete
- wmpEntityGet
- wmpEntityList
- wmpEntityServerConnect
Constructors
constructor
• new Client(tokenUrl, audience, clientId, clientSecret, baseURL, axios?): Client
Parameters
| Name | Type | Default value |
|---|---|---|
tokenUrl | string | undefined |
audience | string | undefined |
clientId | string | undefined |
clientSecret | string | undefined |
baseURL | string | undefined |
axios | AxiosInstance | globalAxios |
Returns
Overrides
Defined in
Properties
axios
• Protected axios: AxiosInstance = globalAxios
Inherited from
Defined in
basePath
• Protected basePath: string = BASE_PATH
Inherited from
Defined in
baseURL
• Protected baseURL: string
Defined in
configuration
• Protected configuration: undefined | Configuration
Inherited from
Defined in
Methods
credentialCreate
▸ credentialCreate(walletId, credentialPayload?, options?): Promise<AxiosResponse<CredentialIdObject, any, >>
Creates a new draft credential.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
credentialPayload? | CredentialPayload | A Verifiable Credential payload in JSON format. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialIdObject, any, >>
Throws
Inherited from
Defined in
credentialGet
▸ credentialGet(credentialId, walletId, options?): Promise<AxiosResponse<CredentialWrapper, any, >>
Retrieves a specific verifiable credential based on the provided identifier. Upon retrieval the status of the credential is checked on the fly and therefore guaranteed.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialWrapper, any, >>
Throws
Inherited from
Defined in
credentialImport
▸ credentialImport(walletId, credentialImport?, options?): Promise<AxiosResponse<CredentialWrapper, any, >>
Import pre-signed credential into wallet
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
credentialImport? | CredentialImport | A Verifiable Credential payload in JSON format. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialWrapper, any, >>
Throws
Inherited from
Defined in
credentialIssuanceInit
▸ credentialIssuanceInit(credentialId, walletId, credentialIssuanceInit?, options?): Promise<AxiosResponse<CredentialIssuanceInitResult, any, >>
Prepares created Verifiable Credential draft for its issuance for a specific client.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | |
walletId | string | |
credentialIssuanceInit? | CredentialIssuanceInit | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialIssuanceInitResult, any, >>
Throws
Inherited from
DefaultApi.credentialIssuanceInit
Defined in
credentialList
▸ credentialList(walletId, interaction?, type?, valid?, limit?, nextMarker?, sort?, searchPath?, filter?, options?): Promise<AxiosResponse<CredentialList, any, >>
Retrieves a list of credentials.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
interaction? | CredentialListInteractionEnum | The interaction that is the origin of the credential. This parameter is mutually exclusive with the "type" parameter. |
type? | string | The credential type as comma delimited list representing a single type. This parameter is mutually exclusive with the "interaction" parameter. I.e. VerifiableCredential,VerifiableAttestation,Europass. |
valid? | boolean | The credential validity flag. If not provided credentials with any validity will be returned. |
limit? | number | The number of items |
nextMarker? | string | Marking the next set of items |
sort? | ListSort | Sort flag controls the sort direction by the time updated or issued |
searchPath? | string | JSON path specification for the filter to apply |
filter? | string | JSON schema filter used to select the credentials (base64 encoded) |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialList, any, >>
Throws
Inherited from
Defined in
credentialMetadataPatch
▸ credentialMetadataPatch(credentialId, walletId, credentialMetadataPatchPayload?, options?): Promise<AxiosResponse<CredentialIdObject, any, >>
Verifiable Credential metadata may be updated even after the credential was issued. It is available as a key value storage for a client to store any additional data for the credential.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
credentialMetadataPatchPayload? | CredentialMetadataPatchPayload | Verifiable Credential metadata in JSON |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialIdObject, any, >>
Throws
Inherited from
DefaultApi.credentialMetadataPatch
Defined in
credentialPatch
▸ credentialPatch(credentialId, walletId, credentialPatchPayload?, options?): Promise<AxiosResponse<CredentialIdObject, any, >>
Endpoint used to update an existing Credential in draft state. Can be used for additional updates before the Credential is issued. After credential is issued it may not be changed in any way.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
credentialPatchPayload? | CredentialPatchPayload | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialIdObject, any, >>
Throws
Inherited from
Defined in
credentialRequestInit
▸ credentialRequestInit(walletId, credentialRequest?, options?): Promise<AxiosResponse<string[], any, >>
Requests a credential issuance from the issuer and retrieves requirements for holder authorization.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
credentialRequest? | CredentialRequest | A Verifiable Credential request: types and URL of the issuer |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<string[], any, >>
Throws
Inherited from
DefaultApi.credentialRequestInit
Defined in
credentialRevoke
▸ credentialRevoke(credentialId, walletId, options?): Promise<AxiosResponse<void, any, >>
Revoke a specific Verifiable Credential
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
deferredStatus
▸ deferredStatus(deferredId, walletId, options?): Promise<AxiosResponse<Deferred, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
deferredId | string | Deferred token |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<Deferred, any, >>
Throws
Inherited from
Defined in
didDocumentGet
▸ didDocumentGet(walletId, options?): Promise<AxiosResponse<object, any, >>
Gets the DID Document of the wallet.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<object, any, >>
Throws
Inherited from
Defined in
healthCheck
▸ healthCheck(options?): Promise<AxiosResponse<HealthStatus, any, >>
Checks the health status of the service and its subsystems (database, storage, etc.). Used by load balancers and monitoring systems.
Parameters
| Name | Type | Description |
|---|---|---|
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<HealthStatus, any, >>
Throws
Inherited from
Defined in
holderCreateAuthOffer
▸ holderCreateAuthOffer(walletId, holderAuthOfferCreationRequest?, options?): Promise<AxiosResponse<void, any, >>
Creates an authorized credential offer (deferred or instant) for holder-initiated credential request using provided parameters. The offer is an URL that the creator should provide to the client via a redirect, link, or QR code.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
holderAuthOfferCreationRequest? | HolderAuthOfferCreationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.holderCreateAuthOffer
Defined in
holderCredentialsPresentAfterConsent
▸ holderCredentialsPresentAfterConsent(walletId, interactionId, interactionAuthorizationConsent?, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
interactionId | string | |
interactionAuthorizationConsent? | InteractionAuthorizationConsent | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.holderCredentialsPresentAfterConsent
Defined in
holderIdTokenSend
▸ holderIdTokenSend(walletId, idTokenSendRequest?, options?): Promise<AxiosResponse<void, any, >>
Responds to an ID token request
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
idTokenSendRequest? | IdTokenSendRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
holderLinkedVpCreate
▸ holderLinkedVpCreate(walletId, linkedVpCreateRequest?, options?): Promise<AxiosResponse<LinkedVpMetadata, any, >>
Creates a new public Linked VP of specified credentials and adds it to the wallet's DID document
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
linkedVpCreateRequest? | LinkedVpCreateRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<LinkedVpMetadata, any, >>
Throws
Inherited from
DefaultApi.holderLinkedVpCreate
Defined in
holderLinkedVpDelete
▸ holderLinkedVpDelete(walletId, linkedVpId, options?): Promise<AxiosResponse<void, any, >>
Deletes a linked VP
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
linkedVpId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.holderLinkedVpDelete
Defined in
holderLinkedVpGetDetails
▸ holderLinkedVpGetDetails(walletId, linkedVpId, options?): Promise<AxiosResponse<LinkedVpMetadata, any, >>
Returns metadata and content of a specific linked Verifiable Presentation, including the credentials it contains and its DID document service entry URL.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
linkedVpId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<LinkedVpMetadata, any, >>
Throws
Inherited from
DefaultApi.holderLinkedVpGetDetails
Defined in
holderLinkedVpList
▸ holderLinkedVpList(walletId, options?): Promise<AxiosResponse<LinkedVpMetadata[], any, >>
Returns all linked Verifiable Presentations published in the wallet's DID document,
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<LinkedVpMetadata[], any, >>
Throws
Inherited from
Defined in
holderOfferPassAuthInfo
▸ holderOfferPassAuthInfo(walletId, vcOffer?, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
vcOffer? | VcOffer | Verifiable Credential offer |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
Throws
Inherited from
DefaultApi.holderOfferPassAuthInfo
Defined in
holderOfferProcessAfterConsent
▸ holderOfferProcessAfterConsent(walletId, interactionId, interactionAuthorizationConsent?, options?): Promise<AxiosResponse<string[], any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
interactionId | string | |
interactionAuthorizationConsent? | InteractionAuthorizationConsent | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<string[], any, >>
Throws
Inherited from
DefaultApi.holderOfferProcessAfterConsent
Defined in
holderPresentPassAuthInfo
▸ holderPresentPassAuthInfo(walletId, presentationRequest?, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
presentationRequest? | PresentationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
Throws
Inherited from
DefaultApi.holderPresentPassAuthInfo
Defined in
idTokenRequestCreate
▸ idTokenRequestCreate(walletId, options?): Promise<AxiosResponse<IdTokenRequest, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<IdTokenRequest, any, >>
Throws
Inherited from
DefaultApi.idTokenRequestCreate
Defined in
issuerCredentialTypesList
▸ issuerCredentialTypesList(url, options?): Promise<AxiosResponse<CredentialType[], any, >>
Returns verifiable credential format and types that are supported by the issuer. - format: the verifiable credential format (for example "jwt_vc") - type: a list of strings that define supported verifiable credential type(s)
Parameters
| Name | Type | Description |
|---|---|---|
url | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CredentialType[], any, >>
Throws
Inherited from
DefaultApi.issuerCredentialTypesList
Defined in
issuerInitiateAuthOffer
▸ issuerInitiateAuthOffer(walletId, initAuthOffer?, options?): Promise<AxiosResponse<AuthOffer, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
initAuthOffer? | InitAuthOffer | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<AuthOffer, any, >>
Throws
Inherited from
DefaultApi.issuerInitiateAuthOffer
Defined in
issuerInitiatePreauthOffer
▸ issuerInitiatePreauthOffer(walletId, initPreAuthOffer?, options?): Promise<AxiosResponse<PreAuthOffer, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
initPreAuthOffer? | InitPreAuthOffer | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<PreAuthOffer, any, >>
Throws
Inherited from
DefaultApi.issuerInitiatePreauthOffer
Defined in
issuerXadesSign
▸ issuerXadesSign(walletId, xadesSignatureType, xml?, options?): Promise<AxiosResponse<object, any, >>
Signs an XML document with XAdES signature
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
xadesSignatureType | XadesSignatureType | |
xml? | File | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<object, any, >>
Throws
Inherited from
Defined in
pdfCredentialMakeVp
▸ pdfCredentialMakeVp(credentialId, signPdf, walletId, options?): Promise<AxiosResponse<File, any, >>
Returns a signed PDF contained in the verifiable credential containing the credential VP added as an attachment in incremental update.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
signPdf | boolean | Whether to sign the PDF with holder's X509 certificate or not |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<File, any, >>
Throws
Inherited from
DefaultApi.pdfCredentialMakeVp
Defined in
pdfCredentialTwinDelete
▸ pdfCredentialTwinDelete(credentialId, walletId, options?): Promise<AxiosResponse<void, any, >>
Deletes the PDF associated with the verifiable credential. Can be used only for credentials in Draft state.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.pdfCredentialTwinDelete
Defined in
pdfCredentialTwinGet
▸ pdfCredentialTwinGet(credentialId, walletId, options?): Promise<AxiosResponse<File, any, >>
Returns either an unsigned PDF that was uploaded to be signed and embedded into a verifiable credential in case of credential in Draft state, or a signed PDF embedded in an issued VC.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<File, any, >>
Throws
Inherited from
DefaultApi.pdfCredentialTwinGet
Defined in
pdfCredentialTwinUpload
▸ pdfCredentialTwinUpload(credentialId, walletId, pdf?, options?): Promise<AxiosResponse<void, any, >>
Uploads a PDF that will be signed and embedded with the verifiable credential when it will be issued. Can be used only for credentials in Draft state. Maximum size of the PDF document is 50 MB.
Parameters
| Name | Type | Description |
|---|---|---|
credentialId | string | Verifiable Credential Identifier |
walletId | string | |
pdf? | File | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.pdfCredentialTwinUpload
Defined in
tfAccreditAs
▸ tfAccreditAs(walletId, accreditationRequest?, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
accreditationRequest? | AccreditationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
tfAccreditRequest
▸ tfAccreditRequest(walletId, entityAccreditationRequest?, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityAccreditationRequest? | EntityAccreditationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
tfOnboard
▸ tfOnboard(walletId, onboardingRequest?, options?): Promise<AxiosResponse<OnboardResult, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
onboardingRequest? | OnboardingRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<OnboardResult, any, >>
Throws
Inherited from
Defined in
tfOnboardRequest
▸ tfOnboardRequest(walletId, entityOnboardingRequest?, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityOnboardingRequest? | EntityOnboardingRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
tfRevokeAccreditation
▸ tfRevokeAccreditation(walletId, revokeAccreditationRequest?, options?): Promise<AxiosResponse<void, any, >>
Revokes another legal entity's accreditation or trust framework registration by invalidating their credential in the trust status list.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
revokeAccreditationRequest? | RevokeAccreditationRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.tfRevokeAccreditation
Defined in
tfX509CertificateGetRecord
▸ tfX509CertificateGetRecord(walletId, serialNumber, options?): Promise<AxiosResponse<CertificateRecordGetResponse, any, >>
Returns a record of an issued X509 certificate
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
serialNumber | string | Certificate serial number |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CertificateRecordGetResponse, any, >>
Throws
Inherited from
DefaultApi.tfX509CertificateGetRecord
Defined in
tfX509CertificateIssue
▸ tfX509CertificateIssue(walletId, certificateIssueRequest?, options?): Promise<AxiosResponse<CertificateIssueResponse, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
certificateIssueRequest? | CertificateIssueRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CertificateIssueResponse, any, >>
Throws
Inherited from
DefaultApi.tfX509CertificateIssue
Defined in
tfX509CertificateListRecords
▸ tfX509CertificateListRecords(walletId, options?): Promise<AxiosResponse<CertificateRecordGetResponse[], any, >>
Returns the records of all X509 certificates the wallet has issued, including their current status. The list is empty when the wallet has not issued any certificate.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CertificateRecordGetResponse[], any, >>
Throws
Inherited from
DefaultApi.tfX509CertificateListRecords
Defined in
tfX509CertificateUpdateStatus
▸ tfX509CertificateUpdateStatus(walletId, serialNumber, certificateStatusUpdateRequest?, options?): Promise<AxiosResponse<void, any, >>
Updates a status of an already issued X509 certificate
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
serialNumber | string | Certificate serial number |
certificateStatusUpdateRequest? | CertificateStatusUpdateRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.tfX509CertificateUpdateStatus
Defined in
trustListAdd
▸ trustListAdd(trustListAddRequest?, options?): Promise<AxiosResponse<void, any, >>
Starts tracking the trusted list published at the given URL, storing its contents and pinning it to the certificate that signed it. Adding a list that is already tracked refreshes it. Requires the admin role and the trustListProviderPostgres provider. This fetches the list before it answers, and adding a List of Trusted Lists also walks every list it points at, so the call takes as long as those fetches do. A list that could not be reached through the walk is left out rather than failing the registration.
Parameters
| Name | Type | Description |
|---|---|---|
trustListAddRequest? | TrustListAddRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
trustListDelete
▸ trustListDelete(url, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL the trusted list is published at. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
trustListRefresh
▸ trustListRefresh(url, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
url | string | The URL the trusted list is published at. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
trustListsGet
▸ trustListsGet(options?): Promise<AxiosResponse<TrustListsResponse, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<TrustListsResponse, any, >>
Throws
Inherited from
Defined in
verifierInitUrlCreate
▸ verifierInitUrlCreate(walletId, verifyInitRequest?, options?): Promise<AxiosResponse<VerifyInitResponse, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
verifyInitRequest? | VerifyInitRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<VerifyInitResponse, any, >>
Throws
Inherited from
DefaultApi.verifierInitUrlCreate
Defined in
verifierLinkedVpVerify
▸ verifierLinkedVpVerify(walletId, did, options?): Promise<AxiosResponse<VerifiedLinkedVp[], any, >>
Fetches linked presentations from DID document and verifies them.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
did | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<VerifiedLinkedVp[], any, >>
Throws
Inherited from
DefaultApi.verifierLinkedVpVerify
Defined in
verifierPdfVerify
▸ verifierPdfVerify(walletId, extractVp, pdf?, trustedCertificates?, trustedListsUrl?, trustedListSigningCertificates?, options?): Promise<AxiosResponse<PdfVerificationResponse, any, >>
Verifies the signatures of uploaded PDF and extracts and verifies VP in the PDF document Maximum size of the PDF document is 50 MB.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
extractVp | boolean | Whether to extract VP attachment from the PDF |
pdf? | File | |
trustedCertificates? | string[] | Base64 encoded x509 certificates with which the PDF may be signed. |
trustedListsUrl? | string[] | URLs of ETSI trusted lists that will be used for verification purposes. If not provided, ETSI trust list configured for the wallet will be used. |
trustedListSigningCertificates? | string[] | Base64 encoded x509 certificates with which the ETSI trusted lists may be signed. If not provided, values from wallet config will be used. |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<PdfVerificationResponse, any, >>
Throws
Inherited from
Defined in
walletCreate
▸ walletCreate(walletCreatePayload?, options?): Promise<AxiosResponse<WalletIdObject, any, >>
Creates a new wallet for the authenticated client.
Parameters
| Name | Type | Description |
|---|---|---|
walletCreatePayload? | WalletCreatePayload | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletIdObject, any, >>
Throws
Inherited from
Defined in
walletDelete
▸ walletDelete(walletId, options?): Promise<AxiosResponse<void, any, >>
Permanently deletes the wallet with all credentials and keys. Make sure you know what you are doing before hitting this endpoint.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
walletGet
▸ walletGet(walletId, options?): Promise<AxiosResponse<Wallet, any, >>
Provides wallet details
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<Wallet, any, >>
Throws
Inherited from
Defined in
walletIdentifierGet
▸ walletIdentifierGet(walletId, options?): Promise<AxiosResponse<WalletIdentifier, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletIdentifier, any, >>
Throws
Inherited from
DefaultApi.walletIdentifierGet
Defined in
walletKeys
▸ walletKeys(walletId, options?): Promise<AxiosResponse<{ [key: string]: any; }, any, >>
Provides wallet keys used for signing.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<{ [key: string]: any; }, any, >>
Throws
Inherited from
Defined in
walletList
▸ walletList(ownerId?, searchName?, options?): Promise<AxiosResponse<WalletListItem[], any, >>
Provides list of wallets owned by the authenticated client.
Parameters
| Name | Type | Description |
|---|---|---|
ownerId? | string | |
searchName? | string | Wallet name to search using "begins-with" filter |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletListItem[], any, >>
Throws
Inherited from
Defined in
walletNotificationGetByState
▸ walletNotificationGetByState(walletId, eventType, state, options?): Promise<AxiosResponse<WalletNotification, any, >>
Gets a specific notification by state
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
eventType | string | Event type |
state | string | Event identifier |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletNotification, any, >>
Throws
Inherited from
DefaultApi.walletNotificationGetByState
Defined in
walletNotificationHistory
▸ walletNotificationHistory(walletId, limit?, nextMarker?, type?, sort?, newerThan?, options?): Promise<AxiosResponse<WalletNotificationHistory, any, >>
Provides wallet notifications that can be used to audit the wallet activity.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
limit? | number | The number of items |
nextMarker? | string | Marking the next set of items |
type? | WalletNotificationEventType[] | Notification types |
sort? | ListSort | Sort flag controls the sort direction by the time created |
newerThan? | number | List notifications that are newer than the provided timestamp |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletNotificationHistory, any, >>
Throws
Inherited from
DefaultApi.walletNotificationHistory
Defined in
walletNotifications
▸ walletNotifications(walletId, options?): Promise<AxiosResponse<WalletNotification[], any, >>
Provides first-in-first-out queue of notifications for a specific wallet.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletNotification[], any, >>
Throws
Inherited from
DefaultApi.walletNotifications
Defined in
walletPatch
▸ walletPatch(walletId, walletPatchPayload?, options?): Promise<AxiosResponse<WalletIdObject, any, >>
Update wallet metadata and configuration.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
walletPatchPayload? | WalletPatchPayload | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletIdObject, any, >>
Throws
Inherited from
Defined in
walletProviderCertificateImport
▸ walletProviderCertificateImport(walletProviderCertificateRequest?, options?): Promise<AxiosResponse<void, any, >>
Installs the externally-issued certificate chain for the Wallet Provider key. Requires the admin role. After this succeeds the Wallet Provider can sign WIAs with an x5c header.
Parameters
| Name | Type | Description |
|---|---|---|
walletProviderCertificateRequest? | WalletProviderCertificateRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.walletProviderCertificateImport
Defined in
walletProviderCsrGenerate
▸ walletProviderCsrGenerate(options?): Promise<AxiosResponse<WalletProviderCsrResponse, any, >>
Generates a PKCS#10 certificate signing request (CSR) for the Wallet Provider key used to sign Wallet Instance Attestations. Requires the admin role. The provider key is generated on first call if it does not exist yet.
Parameters
| Name | Type | Description |
|---|---|---|
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WalletProviderCsrResponse, any, >>
Throws
Inherited from
DefaultApi.walletProviderCsrGenerate
Defined in
walletVerifiedCredentialsByState
▸ walletVerifiedCredentialsByState(walletId, state, options?): Promise<AxiosResponse<VerifiedWrapper, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
state | string | Verifier state |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<VerifiedWrapper, any, >>
Throws
Inherited from
DefaultApi.walletVerifiedCredentialsByState
Defined in
walletVerifiedCredentialsDeleteByState
▸ walletVerifiedCredentialsDeleteByState(walletId, state, options?): Promise<AxiosResponse<void, any, >>
Deletes a specific verified credentials by state
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
state | string | Verifier state |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.walletVerifiedCredentialsDeleteByState
Defined in
walletX509CSRCreate
▸ walletX509CSRCreate(walletId, cSRCreateRequest?, options?): Promise<AxiosResponse<CSRCreateResponse, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
cSRCreateRequest? | CSRCreateRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<CSRCreateResponse, any, >>
Throws
Inherited from
DefaultApi.walletX509CSRCreate
Defined in
walletX509CertificateGet
▸ walletX509CertificateGet(walletId, options?): Promise<AxiosResponse<File, any, >>
Returns the wallet's currently active X509 certificate in PEM format, used for XAdES/PDF signing. certificate for signature verification.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<File, any, >>
Throws
Inherited from
DefaultApi.walletX509CertificateGet
Defined in
walletX509CertificateImport
▸ walletX509CertificateImport(walletId, certificateImportRequest?, options?): Promise<AxiosResponse<void, any, >>
Imports an X509 certificate to be used when signing credentials
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | Wallet ID |
certificateImportRequest? | CertificateImportRequest | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.walletX509CertificateImport
Defined in
wmpAcceptInvitation
▸ wmpAcceptInvitation(walletId, wmpAcceptInvitationPayload?, options?): Promise<AxiosResponse<WmpEntityIdObject, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
wmpAcceptInvitationPayload? | WmpAcceptInvitationPayload | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpEntityIdObject, any, >>
Throws
Inherited from
DefaultApi.wmpAcceptInvitation
Defined in
wmpClientGetPendingRequests
▸ wmpClientGetPendingRequests(walletId, options?): Promise<AxiosResponse<WmpRequest[], any, >>
Get pending WMP requests (credential offers or credential verification requests)
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpRequest[], any, >>
Throws
Inherited from
DefaultApi.wmpClientGetPendingRequests
Defined in
wmpClientProcessRequest
▸ wmpClientProcessRequest(walletId, requestId, wmpClientRequestBody, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
Acts on a pending WMP client request identified by request_id. The body's type selects the action: process a credential offer / verification request (returns its authorization requirements), identity_assertion to present a credential as the session identity assertion, or authenticate to open the session after the assertion exchange.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
requestId | string | |
wmpClientRequestBody | WmpClientRequestBody | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>
Throws
Inherited from
DefaultApi.wmpClientProcessRequest
Defined in
wmpCreateNewInvitation
▸ wmpCreateNewInvitation(walletId, options?): Promise<AxiosResponse<WmpCreateInvitationResponse, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpCreateInvitationResponse, any, >>
Throws
Inherited from
DefaultApi.wmpCreateNewInvitation
Defined in
wmpEntityConnectionGet
▸ wmpEntityConnectionGet(walletId, entityId, options?): Promise<AxiosResponse<WmpEntityConnectionStatus, any, >>
Get entity connection status
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpEntityConnectionStatus, any, >>
Throws
Inherited from
DefaultApi.wmpEntityConnectionGet
Defined in
wmpEntityDelete
▸ wmpEntityDelete(walletId, entityId, options?): Promise<AxiosResponse<void, any, >>
Delete entity based on the entity ID
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
Defined in
wmpEntityGet
▸ wmpEntityGet(walletId, entityId, options?): Promise<AxiosResponse<WmpEntityRecord, any, >>
Get entity based on the entity ID
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpEntityRecord, any, >>
Throws
Inherited from
Defined in
wmpEntityList
▸ wmpEntityList(walletId, entityType, options?): Promise<AxiosResponse<WmpEntityRecord[], any, >>
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).
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityType | WmpEntityListEntityTypeEnum | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<WmpEntityRecord[], any, >>
Throws
Inherited from
Defined in
wmpEntityServerConnect
▸ wmpEntityServerConnect(walletId, entityId, options?): Promise<AxiosResponse<void, any, >>
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.
Parameters
| Name | Type | Description |
|---|---|---|
walletId | string | |
entityId | string | |
options? | RawAxiosRequestConfig | Override http request option. |
Returns
Promise<AxiosResponse<void, any, >>
Throws
Inherited from
DefaultApi.wmpEntityServerConnect