Get desktop application:
View/edit binary Protocol Buffers messages
Service for managing wallets
Confirm identity added to the current wallet using `AddExternalIdentityInit`
The challenge received from the `AddExternalIdentityInit` endpoint
The response to the challenge. If using Email or Phone, this is the OTP code sent to the user's email or phone
(message has no fields)
Add new external identity to the current wallet, such as email, sms, ethereum address, etc. This identity ownership must be confirmed using `AddIdentityConfirm` via OTP, signature, etc.
The user identity to add to the wallet This can be an email address or phone number (formatted as +[country code][phone number])
The type of identity provider, like EMAIL or PHONE
Challenge or reference to the challenge to be used in the `AddExternalIdentityConfirm` endpoint
Confirm sign-in to an already existing wallet and return authentication token
The challenge received from the `AcquireAuthTokenInit` endpoint
The response to the challenge. If using Email or Phone, this is the OTP code sent to the user's email or phone
Auth token for the wallet
Sign-in to an already existing wallet, using an identity added that was previously registered This endpoint does not require authentication, and will return a challenge to be signed or verified
Identity to add to the wallet
Identity provider
Ecosystem ID to which the wallet belongs
The challenge received from the `AcquireAuthTokenInit` endpoint Pass this challenge back to the `AcquireAuthTokenConfirm` endpoint
Resend previous authentication code
Challenge for the code you want resent.
(message has no fields)
Create a new wallet and generate an auth token for access
Ecosystem ID of the wallet to create
Wallet name or description. Use this field to add vendor specific information about this wallet, such as email, phone, internal ID, or anything you'd like to associate with this wallet. This field is searchable.
Optional identity to add to the wallet (email or sms). Use this field when inviting participants into an ecosystem. If this field is set, an auth token will not be sent in the response.
Auth token for the newly created wallet
Token ID of the newly generated token
Wallet configuration
Delete an item from the wallet permanently
Request to delete an item in a wallet
ID of item to delete
Response to `DeleteItemRequest`
(message has no fields)
Delete a wallet and its credentials
Request to delete a wallet
Email address of account to delete. Mutually exclusive with `walletId` and `didUri`.
Wallet ID of account to delete. Mutually exclusive with `email` and `didUri`.
DID URI of the account to delete. Mutually exclusive with `email` and `walletId`.
Response to `DeleteWalletRequest`. Empty payload.
(message has no fields)
Generate new token for a given wallet and add it to the collection of known auth tokens. This endpoint requires authentication and will return a new token ID and auth token. Use this endpoint if you want to authorize another device, without having to share your existing auth token.
Retrieve an item from the wallet with a given item identifier
Request to fetch an item from wallet
ID of item in wallet
Response to `GetItemRequest`
Item data as a JSON string
Type of item specified when item was inserted into wallet
Retrieve wallet details and configuration about the currently authenticated wallet
Request to retrieve wallet information about the currently authenticated wallet
(message has no fields)
Response to `GetMyInfoRequest`
Wallet configuration
Retrieve information from an ecosystem wallet by searching for its external identity (email or phone)
Response to `GetWalletFromExternalIdentityRequest`
Wallet configuration
Retrieve wallet details and configuration
Request to retrieve wallet information about a given wallet identified by its wallet ID
Wallet ID of the wallet to retrieve
Response to `GetWalletInfoRequest`
Wallet configuration
Insert an item into the wallet
Request to insert a JSON document into a wallet
Document to insert; must be stringified JSON
Item type (ex. "VerifiableCredential")
Response to `InsertItemRequest`
ID of item inserted into wallet
List credentials which match a given verification template
Request to list templates by
ID of verification template to list matching credentials
Token provided by previous `ListCredentialTemplatesResponse` if more data is available for query
Response to `ListByVerificationTemplateRequest`
Array of query results, as JSON strings
Whether more results are available for this query via `continuation_token`
Token to fetch next set of results via `ListByVerificationTemplateRequest`
List all wallets in the ecosystem
Remove an external identity from the current wallet
The user identity to remove from the wallet This can be an email address or phone number (formatted as +[country code][phone number])
(message has no fields)
Revokes a previously issued auth token and updates the collection of known auth tokens. This endpoint requires authentication.
Request to revoke a previously issued auth token
Wallet ID of the wallet to from which to revoke the token
Token ID of the token to revoke
(message has no fields)
Search the wallet using a SQL syntax
Request to search items in wallet
SQL Query to execute against items in wallet
Token provided by previous `SearchResponse` if more data is available for query
Response to `SearchRequest`
Array of query results, as JSON strings
Whether more results are available for this query via `continuation_token`
Token to fetch next set of results via `SearchRequest`
Update an item in the wallet
Request to update item in wallet
ID of item in wallet
Item type (ex. "VerifiableCredential")
Response to `UpdateItemRequest`
(message has no fields)
Used in:
The user identity to add to the wallet This can be an email address or phone number (formatted as +[country code][phone number])
The type of identity provider, like EMAIL or PHONE