@triveria/wallet / Exports / Client

Class: Client

DefaultApi - object-oriented interface

Export

DefaultApi

Hierarchy

• DefaultApi

  ↳ Client

Table of contents

Constructors

• constructor

Properties

• axios
• basePath
• baseURL
• configuration

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
• tfX509CertificateIssue
• verifierInitUrlCreate
• verifierLinkedVpVerify
• verifierPdfVerify
• walletCreate
• walletDelete
• walletGet
• walletIdentifierGet
• walletKeys
• walletList
• walletNotificationGetByState
• walletNotificationHistory
• walletNotifications
• walletPatch
• 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

Client

Overrides

DefaultApi.constructor

Defined in

client.ts:21

Properties

axios

• Protected axios: AxiosInstance = globalAxios

Inherited from

DefaultApi.axios

Defined in

client.ts:21

---

basePath

• Protected basePath: string = BASE_PATH

Inherited from

DefaultApi.basePath

Defined in

base.ts:39

---

baseURL

• Protected baseURL: string

Defined in

client.ts:21

---

configuration

• Protected configuration: undefined | Configuration

Inherited from

DefaultApi.configuration

Defined in

base.ts:37

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

DefaultApi.credentialCreate

Defined in

api.ts:5600

---

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

DefaultApi.credentialGet

Defined in

api.ts:5611

---

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

DefaultApi.credentialImport

Defined in

api.ts:5622

---

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

api.ts:5634

---

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

DefaultApi.credentialList

Defined in

api.ts:5652

---

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

api.ts:5664

---

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

DefaultApi.credentialPatch

Defined in

api.ts:5676

---

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

api.ts:5687

---

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

DefaultApi.credentialRevoke

Defined in

api.ts:5698

---

deferredStatus

▸ deferredStatus(deferredId, walletId, options?): Promise<AxiosResponse<Deferred, any, >>

Parameters

Name	Type	Description
deferredId	string	Deferred token
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<Deferred, any, >>

Throws

Inherited from

DefaultApi.deferredStatus

Defined in

api.ts:5709

---

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

DefaultApi.didDocumentGet

Defined in

api.ts:5719

---

healthCheck

▸ healthCheck(options?): Promise<AxiosResponse<HealthStatus, any, >>

Parameters

Name	Type	Description
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<HealthStatus, any, >>

Throws

Inherited from

DefaultApi.healthCheck

Defined in

api.ts:5728

---

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

api.ts:5739

---

holderCredentialsPresentAfterConsent

▸ holderCredentialsPresentAfterConsent(walletId, interactionId, interactionAuthorizationConsent?, options?): Promise<AxiosResponse<void, any, >>

Presenting Verifiable Credentials after holder's consent.

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

api.ts:5751

---

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

DefaultApi.holderIdTokenSend

Defined in

api.ts:5762

---

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

api.ts:5773

---

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

api.ts:5784

---

holderLinkedVpGetDetails

▸ holderLinkedVpGetDetails(walletId, linkedVpId, options?): Promise<AxiosResponse<LinkedVpMetadata, any, >>

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

api.ts:5795

---

holderLinkedVpList

▸ holderLinkedVpList(walletId, options?): Promise<AxiosResponse<LinkedVpMetadata[], any, >>

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<LinkedVpMetadata[], any, >>

Throws

Inherited from

DefaultApi.holderLinkedVpList

Defined in

api.ts:5805

---

holderOfferPassAuthInfo

▸ holderOfferPassAuthInfo(walletId, vcOffer?, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>

Retrieve authorization requirements for the credential offer.

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

api.ts:5816

---

holderOfferProcessAfterConsent

▸ holderOfferProcessAfterConsent(walletId, interactionId, interactionAuthorizationConsent?, options?): Promise<AxiosResponse<string[], any, >>

Gives consent to process credential offer specified by interaction_id

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

api.ts:5828

---

holderPresentPassAuthInfo

▸ holderPresentPassAuthInfo(walletId, presentationRequest?, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>

Initiates a presentation of credentials to a verifier.

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

api.ts:5839

---

idTokenRequestCreate

▸ idTokenRequestCreate(walletId, options?): Promise<AxiosResponse<IdTokenRequest, any, >>

Creates an ID token request.

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<IdTokenRequest, any, >>

Throws

Inherited from

DefaultApi.idTokenRequestCreate

Defined in

api.ts:5849

---

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

api.ts:5859

---

issuerInitiateAuthOffer

▸ issuerInitiateAuthOffer(walletId, initAuthOffer?, options?): Promise<AxiosResponse<AuthOffer, any, >>

Initiates issuing of Verifiable Credentials using authorized flow.

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

api.ts:5870

---

issuerInitiatePreauthOffer

▸ issuerInitiatePreauthOffer(walletId, initPreAuthOffer?, options?): Promise<AxiosResponse<PreAuthOffer, any, >>

Initiates issuing of Verifiable Credentials using pre-authorized flow.

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

api.ts:5881

---

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

DefaultApi.issuerXadesSign

Defined in

api.ts:5893

---

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

api.ts:5905

---

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

api.ts:5916

---

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

api.ts:5927

---

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

api.ts:5939

---

tfAccreditAs

▸ tfAccreditAs(walletId, accreditationRequest?, options?): Promise<AxiosResponse<void, any, >>

Accredits a legal entity as RTAO, TAO or TI.

Parameters

Name	Type	Description
walletId	string
accreditationRequest?	AccreditationRequest
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any, >>

Throws

Inherited from

DefaultApi.tfAccreditAs

Defined in

api.ts:5950

---

tfAccreditRequest

▸ tfAccreditRequest(walletId, entityAccreditationRequest?, options?): Promise<AxiosResponse<void, any, >>

Processes a request to accredit another legal entity.

Parameters

Name	Type	Description
walletId	string
entityAccreditationRequest?	EntityAccreditationRequest
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any, >>

Throws

Inherited from

DefaultApi.tfAccreditRequest

Defined in

api.ts:5961

---

tfOnboard

▸ tfOnboard(walletId, onboardingRequest?, options?): Promise<AxiosResponse<OnboardResult, any, >>

Onboards legal entity to the trust framework based on the wallet configuration.

Parameters

Name	Type	Description
walletId	string
onboardingRequest?	OnboardingRequest
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<OnboardResult, any, >>

Throws

Inherited from

DefaultApi.tfOnboard

Defined in

api.ts:5972

---

tfOnboardRequest

▸ tfOnboardRequest(walletId, entityOnboardingRequest?, options?): Promise<AxiosResponse<void, any, >>

Processes a request to onboard another legal entity.

Parameters

Name	Type	Description
walletId	string
entityOnboardingRequest?	EntityOnboardingRequest
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any, >>

Throws

Inherited from

DefaultApi.tfOnboardRequest

Defined in

api.ts:5983

---

tfRevokeAccreditation

▸ tfRevokeAccreditation(walletId, revokeAccreditationRequest?, options?): Promise<AxiosResponse<void, any, >>

Revokes another legal entity's wallet DID accreditation.

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

api.ts:5994

---

tfX509CertificateIssue

▸ tfX509CertificateIssue(walletId, certificateIssueRequest?, options?): Promise<AxiosResponse<CertificateIssueResponse, any, >>

Issues a certificate based on the provided certificate request

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

api.ts:6005

---

verifierInitUrlCreate

▸ verifierInitUrlCreate(walletId, verifyInitRequest?, options?): Promise<AxiosResponse<VerifyInitResponse, any, >>

Returns an url where verifier accepts presentations from a holder.

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

api.ts:6016

---

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

api.ts:6027

---

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

DefaultApi.verifierPdfVerify

Defined in

api.ts:6042

---

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

DefaultApi.walletCreate

Defined in

api.ts:6052

---

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

DefaultApi.walletDelete

Defined in

api.ts:6062

---

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

DefaultApi.walletGet

Defined in

api.ts:6072

---

walletIdentifierGet

▸ walletIdentifierGet(walletId, options?): Promise<AxiosResponse<WalletIdentifier, any, >>

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<WalletIdentifier, any, >>

Throws

Inherited from

DefaultApi.walletIdentifierGet

Defined in

api.ts:6082

---

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

DefaultApi.walletKeys

Defined in

api.ts:6092

---

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

DefaultApi.walletList

Defined in

api.ts:6103

---

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

api.ts:6115

---

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

api.ts:6130

---

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

api.ts:6140

---

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

DefaultApi.walletPatch

Defined in

api.ts:6151

---

walletVerifiedCredentialsByState

▸ walletVerifiedCredentialsByState(walletId, state, options?): Promise<AxiosResponse<VerifiedWrapper, any, >>

Gets 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<VerifiedWrapper, any, >>

Throws

Inherited from

DefaultApi.walletVerifiedCredentialsByState

Defined in

api.ts:6162

---

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

api.ts:6173

---

walletX509CSRCreate

▸ walletX509CSRCreate(walletId, cSRCreateRequest?, options?): Promise<AxiosResponse<CSRCreateResponse, any, >>

Creates a X509 certificate signing request for signing key.

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

api.ts:6184

---

walletX509CertificateGet

▸ walletX509CertificateGet(walletId, options?): Promise<AxiosResponse<File, any, >>

Returns an X509 certificate in PEM format

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

api.ts:6194

---

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

api.ts:6205

---

wmpAcceptInvitation

▸ wmpAcceptInvitation(walletId, wmpAcceptInvitationPayload?, options?): Promise<AxiosResponse<WmpEntityIdObject, any, >>

Accepts a WMP invitation

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

api.ts:6216

---

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

api.ts:6226

---

wmpClientProcessRequest

▸ wmpClientProcessRequest(walletId, requestId, options?): Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>

Process WMP request

Parameters

Name	Type	Description
walletId	string
requestId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<InteractionAuthorizationRequirements, any, >>

Throws

Inherited from

DefaultApi.wmpClientProcessRequest

Defined in

api.ts:6237

---

wmpCreateNewInvitation

▸ wmpCreateNewInvitation(walletId, options?): Promise<AxiosResponse<WmpCreateInvitationResponse, any, >>

Creates a new WMP invitation

Parameters

Name	Type	Description
walletId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<WmpCreateInvitationResponse, any, >>

Throws

Inherited from

DefaultApi.wmpCreateNewInvitation

Defined in

api.ts:6247

---

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

api.ts:6258

---

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

DefaultApi.wmpEntityDelete

Defined in

api.ts:6269

---

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

DefaultApi.wmpEntityGet

Defined in

api.ts:6280

---

wmpEntityList

▸ wmpEntityList(walletId, entityType, options?): Promise<AxiosResponse<WmpEntityRecord[], any, >>

Get all clients that have established WMP connection.

Parameters

Name	Type	Description
walletId	string
entityType	WmpEntityListEntityTypeEnum
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<WmpEntityRecord[], any, >>

Throws

Inherited from

DefaultApi.wmpEntityList

Defined in

api.ts:6291

---

wmpEntityServerConnect

▸ wmpEntityServerConnect(walletId, entityId, options?): Promise<AxiosResponse<void, any, >>

Connect to a WMP server entity

Parameters

Name	Type	Description
walletId	string
entityId	string
options?	RawAxiosRequestConfig	Override http request option.

Returns

Promise<AxiosResponse<void, any, >>

Throws

Inherited from

DefaultApi.wmpEntityServerConnect

Defined in

api.ts:6302