package services.universalwallet.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Service for managing wallets
Confirm identity added to the current wallet using `AddExternalIdentityInit`
message
universal-wallet.proto:378string challenge = 1
The challenge received from the `AddExternalIdentityInit` endpoint
string response = 2
The response to the challenge. If using Email or Phone, this is the OTP code sent to the user's email or phone
message
universal-wallet.proto:385(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.
message
universal-wallet.proto:366string identity = 1
The user identity to add to the wallet This can be an email address or phone number (formatted as +[country code][phone number])
provider.v1.IdentityProvider provider = 2
The type of identity provider, like EMAIL or PHONE
message
universal-wallet.proto:373string challenge = 1
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
message
universal-wallet.proto:416string challenge = 1
The challenge received from the `AcquireAuthTokenInit` endpoint
string response = 2
The response to the challenge. If using Email or Phone, this is the OTP code sent to the user's email or phone
message
universal-wallet.proto:424string auth_token = 1
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
message
universal-wallet.proto:394string identity = 1
Identity to add to the wallet
provider.v1.IdentityProvider provider = 2
Identity provider
string ecosystem_id = 3
Ecosystem ID to which the wallet belongs
message
universal-wallet.proto:403string challenge = 1
The challenge received from the `AcquireAuthTokenInit` endpoint Pass this challenge back to the `AcquireAuthTokenConfirm` endpoint
Resend previous authentication code
message
universal-wallet.proto:409string challenge = 1
Challenge for the code you want resent.
message
universal-wallet.proto:414(message has no fields)
Create a new wallet and generate an auth token for access
message
universal-wallet.proto:117string ecosystem_id = 1
Ecosystem ID of the wallet to create
optional string description = 2
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 = 3
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.
message
universal-wallet.proto:138string auth_token = 2
Auth token for the newly created wallet
string token_id = 3
Token ID of the newly generated token
optional wallet = 4
Wallet configuration
rpc DeleteItem (, )
universal-wallet.proto:234Delete an item from the wallet permanently
message
universal-wallet.proto:87Request to delete an item in a wallet
string item_id = 1
ID of item to delete
message
universal-wallet.proto:93Response to `DeleteItemRequest`
(message has no fields)
Delete a wallet and its credentials
message
universal-wallet.proto:98Request to delete a wallet
oneof account
string email = 1
Email address of account to delete. Mutually exclusive with `walletId` and `didUri`.
string wallet_id = 2
Wallet ID of account to delete. Mutually exclusive with `email` and `didUri`.
string did_uri = 4
DID URI of the account to delete. Mutually exclusive with `email` and `walletId`.
message
universal-wallet.proto:115Response 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.
message
universal-wallet.proto:149string wallet_id = 1
string token_description = 2
message
universal-wallet.proto:153string token_id = 1
string auth_token = 2
rpc GetItem (, )
universal-wallet.proto:206Retrieve an item from the wallet with a given item identifier
message
universal-wallet.proto:40Request to fetch an item from wallet
string item_id = 1
ID of item in wallet
message
universal-wallet.proto:46Response to `GetItemRequest`
string item_json = 1
Item data as a JSON string
string item_type = 2
Type of item specified when item was inserted into wallet
rpc GetMyInfo (, )
universal-wallet.proto:263Retrieve wallet details and configuration about the currently authenticated wallet
message
universal-wallet.proto:170Request to retrieve wallet information about the currently authenticated wallet
(message has no fields)
message
universal-wallet.proto:172Response to `GetMyInfoRequest`
optional wallet = 1
Wallet configuration
Retrieve information from an ecosystem wallet by searching for its external identity (email or phone)
message
universal-wallet.proto:193optional identity = 1
message
universal-wallet.proto:198Response to `GetWalletFromExternalIdentityRequest`
optional wallet = 1
Wallet configuration
Retrieve wallet details and configuration
message
universal-wallet.proto:159Request to retrieve wallet information about a given wallet identified by its wallet ID
string wallet_id = 1
Wallet ID of the wallet to retrieve
message
universal-wallet.proto:164Response to `GetWalletInfoRequest`
optional wallet = 1
Wallet configuration
rpc InsertItem (, )
universal-wallet.proto:220Insert an item into the wallet
message
universal-wallet.proto:72Request to insert a JSON document into a wallet
string item_json = 1
Document to insert; must be stringified JSON
string item_type = 2
Item type (ex. "VerifiableCredential")
message
universal-wallet.proto:81Response to `InsertItemRequest`
string item_id = 2
ID of item inserted into wallet
List credentials which match a given verification template
message
universal-wallet.proto:430Request to list templates by
string verification_template_id = 1
ID of verification template to list matching credentials
string continuation_token = 2
Token provided by previous `ListCredentialTemplatesResponse` if more data is available for query
message
universal-wallet.proto:440Response to `ListByVerificationTemplateRequest`
repeated string items = 1
Array of query results, as JSON strings
bool has_more_results = 2
Whether more results are available for this query via `continuation_token`
string continuation_token = 3
Token to fetch next set of results via `ListByVerificationTemplateRequest`
List all wallets in the ecosystem
message
universal-wallet.proto:186string filter = 1
message
universal-wallet.proto:189repeated wallets = 1
Remove an external identity from the current wallet
message
universal-wallet.proto:387string identity = 1
The user identity to remove from the wallet This can be an email address or phone number (formatted as +[country code][phone number])
message
universal-wallet.proto:392(message has no fields)
Revokes a previously issued auth token and updates the collection of known auth tokens. This endpoint requires authentication.
message
universal-wallet.proto:178Request to revoke a previously issued auth token
string wallet_id = 1
Wallet ID of the wallet to from which to revoke the token
string token_id = 2
Token ID of the token to revoke
message
universal-wallet.proto:184(message has no fields)
rpc Search (, )
universal-wallet.proto:213Search the wallet using a SQL syntax
message
universal-wallet.proto:17Request to search items in wallet
string query = 1
SQL Query to execute against items in wallet
string continuation_token = 2
Token provided by previous `SearchResponse` if more data is available for query
message
universal-wallet.proto:26Response to `SearchRequest`
repeated string items = 1
Array of query results, as JSON strings
bool has_more_results = 2
Whether more results are available for this query via `continuation_token`
string continuation_token = 4
Token to fetch next set of results via `SearchRequest`
rpc UpdateItem (, )
universal-wallet.proto:227Update an item in the wallet
message
universal-wallet.proto:57Request to update item in wallet
string item_id = 1
ID of item in wallet
string item_type = 2
Item type (ex. "VerifiableCredential")
message
universal-wallet.proto:66Response to `UpdateItemRequest`
(message has no fields)
message
universal-wallet.proto:129Used in:
string identity = 1
The user identity to add to the wallet This can be an email address or phone number (formatted as +[country code][phone number])
provider.v1.IdentityProvider provider = 2
The type of identity provider, like EMAIL or PHONE