Protocol Documentation
This page documents the Protobuf Services and Messages which compose the Trinsic API.
Top
services/verifiable-credentials/templates/v1/templates.proto
Service - CredentialTemplates
CreateCredentialTemplateRequest
Request to create a new template
Field
Type
Description
name
string Name of new template
fields
CreateCredentialTemplateRequest.FieldsEntry []Fields which compose the template
allow_additional_fields
bool Whether credentials may be issued against this template which have fields not specified in fields
CreateCredentialTemplateRequest.FieldsEntry
CreateCredentialTemplateResponse
Response to CreateCredentialTemplateRequest
DeleteCredentialTemplateRequest
Request to delete a template by ID
Field
Type
Description
id
string ID of template to delete
DeleteCredentialTemplateResponse
Response to DeleteCredentialTemplateRequest
GetCredentialTemplateRequest
Request to fetch a template by ID
Field
Type
Description
id
string ID of template to fetch
GetCredentialTemplateResponse
Response to GetCredentialTemplateRequest
Field
Type
Description
template
TemplateData Template fetched by ID
GetTemplateRequest
Unused
Field
Type
Description
id
string
GetTemplateResponse
Unused
ListCredentialTemplatesRequest
Request to list templates using a SQL query
Field
Type
Description
query
string SQL query to execute. Example: SELECT * FROM c WHERE c.name = 'Diploma'
continuation_token
string Token provided by previous ListCredentialTemplatesResponse if more data is available for query
ListCredentialTemplatesResponse
Response to ListCredentialTemplatesRequest
Field
Type
Description
templates
TemplateData []Templates found by query
has_more_results
bool Whether more results are available for this query via continuation_token
continuation_token
string Token to fetch next set of resuts via ListCredentialTemplatesRequest
ListTemplatesRequest
Unused
ListTemplatesResponse
Unused
SearchCredentialTemplatesRequest
Request to search templates using a SQL query
Field
Type
Description
query
string SQL query to execute. Example: SELECT * FROM c WHERE c.name = 'Diploma'
continuation_token
string Token provided by previous SearchCredentialTemplatesResponse if more data is available for query
SearchCredentialTemplatesResponse
Response to SearchCredentialTemplatesRequest
Field
Type
Description
items_json
string Raw JSON data returned from query
has_more
bool Whether more results are available for this query via continuation_token
continuation_token
string Token to fetch next set of results via SearchCredentialTemplatesRequest
TemplateData
Credential Template
Field
Type
Description
id
string Template ID
name
string Template name
version
int32 Template version number
fields
TemplateData.FieldsEntry []Fields defined for the template
allow_additional_fields
bool Whether credentials issued against this template may contain fields not defined by template
schema_uri
string URI pointing to template JSON schema document
context_uri
string URI pointing to template JSON-LD context document
ecosystem_id
string ID of ecosystem in which template resides
type
string Template type (VerifiableCredential)
created_by
string ID of template creator
date_created
string Date when template was created as ISO 8601 utc string
TemplateData.FieldsEntry
TemplateField
A field defined in a template
Field
Type
Description
description
string Human-readable description of the field
optional
bool Whether this field may be omitted when a credential is issued against the template
type
FieldType The type of the field
FieldType
Valid types for credential fields
Name
Number
Description
STRING
0
NUMBER
1
BOOL
2
DATETIME
4
Top
services/verifiable-credentials/v1/verifiable-credentials.proto
Service - VerifiableCredential
CheckStatusRequest
Request to check a credential's revocation status
Field
Type
Description
credential_status_id
string Credential Status ID to check. This is not the same as the credential's ID.
CheckStatusResponse
Response to CheckStatusRequest
Field
Type
Description
revoked
bool The credential's revocation status
CreateProofRequest
Request to create a proof for a Verifiable Credential using public key tied to caller.
Either item_id or document_json may be provided, not both.
Field
Type
Description
reveal_document_json
string A valid JSON-LD frame describing which fields should be revealed in the generated proof. If unspecified, all fields in the document will be revealed
item_id
string ID of wallet item stored in a Trinsic cloud wallet
document_json
string A valid JSON-LD Verifiable Credential document string with an unbound signature. The proof will be derived from this document directly. The document will not be stored in the wallet.
CreateProofResponse
Response to CreateProofRequest
Field
Type
Description
proof_document_json
string Valid JSON-LD proof for the specified credential
IssueFromTemplateRequest
Request to create and sign a JSON-LD Verifiable Credential from a template using public key tied to caller
Field
Type
Description
template_id
string ID of template to use
values_json
string JSON document string with keys corresponding to the fields of the template referenced by template_id
framework_id
string Governance framework ID to use with issuance of this credential. If specified, the issued credential will contain extended issuer metadata with membership info for the given ecosystem governance framework (EGF)
IssueFromTemplateResponse
Response to IssueFromTemplateRequest
Field
Type
Description
document_json
string Verifiable Credential document, in JSON-LD form, constructed from the specified template and values; signed with public key tied to caller of IssueFromTemplateRequest
IssueRequest
Request to sign a JSON-LD Credential using public key tied to caller
Field
Type
Description
document_json
string Valid JSON-LD Credential document to be signed, in string form
IssueResponse
Response to IssueRequest
Field
Type
Description
signed_document_json
string Verifiable Credential document, signed with public key tied to caller of IssueRequest
SendRequest
Request to send a document to another user's wallet
Field
Type
Description
email
string Email address of user to send item to
did_uri
string DID of recipient (presently unsupported)
didcomm_invitation_json
string DIDComm out-of-band invitation JSON (presently unsupported)
document_json
string JSON document to send to recipient
SendResponse
Response to SendRequest
UpdateStatusRequest
Request to update a credential's revocation status
Field
Type
Description
credential_status_id
string Credential Status ID to update. This is not the same as the credential's ID.
revoked
bool New revocation status of credential
UpdateStatusResponse
Response to UpdateStatusRequest
ValidationMessage
Result of a validation check on a proof
Field
Type
Description
is_valid
bool Whether or not this validation check passed
messages
string []If validation failed, contains messages explaining why
VerifyProofRequest
Request to verify a proof
Field
Type
Description
proof_document_json
string JSON-LD proof document string to verify
VerifyProofResponse
Response to VerifyProofRequest
Field
Type
Description
is_valid
bool Whether all validations in validation_results passed
validation_messages
string []Deprecated. Use validation_results instead
validation_results
VerifyProofResponse.ValidationResultsEntry []Results of each validation check performed, such as schema conformance, revocation status, signature, etc. Detailed results are provided for failed validations.
VerifyProofResponse.ValidationResultsEntry
Top
services/event/v1/event.proto
APICall
EGFCreated
Entity Governance Framework created and attached to ecosystem
Field
Type
Description
id
string UUID of the governance framework
ecosystem_id
string UUID of the ecosystem that owns this EGF
trust_registry
string Trust registry associated with this EGF
governing_authority
string Wallet ID of the authority for this EGF
type
string Type of EGF
name
string User-friendly name for the EGF
description
string Description of the EGF
governance_framework
string URI for the EGF
Event
Event
Field
Type
Description
id
string UUID of event
type
EventType Type of event
timestamp
string Timestamp event occurred, in ISO 8601 format (ex. 2022-07-07T08:09:10.11Z)
data
bytes Event-specific payload, as an encoded protobuf message
ItemReceived
Item inserted into wallet
Field
Type
Description
id
string UUID of the new item
received
string Timestamp when the item was received, in ISO 8601 format (ex. 2022-07-07T08:09:10.11Z)
Ping
Webhook test event
Field
Type
Description
id
string UUID of this ping
webhook_id
string UUID of the webhook receiving the ping
timestamp
string Timestamp ping was requested, in ISO 8601 format (ex. 2022-07-07T08:09:10.11Z)
message
string Arbitrary message specified when ping was requested
TemplateCreated
Template created in ecosystem
Field
Type
Description
id
string UUID of the template
ecosystem_id
string UUID of the ecosystem that owns this template
name
string Template name
type
string Template type
created_by
string WalletID that created the template
EventType
All event types
Name
Number
Description
PING
0
LOG
1
EGF_CREATED
5
EGF_MEMBER_REGISTERED
6
EGF_MEMBER_UNREGISTERED
7
TEMPLATE_CREATED
10
TEMPLATE_DELETED
11
WALLET_CREATED
15
ITEM_RECEIVED
16
File-level Extensions
Extension
Type
Base
Number
Description
event_type
EventType
.google.protobuf.MessageOptions
60002
Event type associated with this Event message.
Top
services/universal-wallet/v1/universal-wallet.proto
Service - UniversalWallet
DeleteItemRequest
Request to delete an item in a wallet
Field
Type
Description
item_id
string ID of item to delete
DeleteItemResponse
Response to DeleteItemRequest
GetItemRequest
Request to fetch an item from wallet
Field
Type
Description
item_id
string ID of item in wallet
GetItemResponse
Response to GetItemRequest
Field
Type
Description
item_json
string Item data as a JSON string
item_type
string Type of item specified when item was inserted into wallet
InsertItemRequest
Request to insert a JSON document into a wallet
Field
Type
Description
item_json
string Document to insert; must be stringified JSON
item_type
string Item type (ex. "VerifiableCredential")
InsertItemResponse
Response to InsertItemRequest
Field
Type
Description
item_id
string ID of item inserted into wallet
SearchRequest
Request to search items in wallet
Field
Type
Description
query
string SQL Query to execute against items in wallet
continuation_token
string Token provided by previous SearchResponse if more data is available for query
SearchResponse
Response to SearchRequest
Field
Type
Description
items
string []Array of query results, as JSON strings
has_more
bool Whether more results are available for this query via continuation_token
continuation_token
string Token to fetch next set of results via SearchRequest
UpdateItemRequest
Request to update item in wallet
Field
Type
Description
item_id
string ID of item in wallet
item_type
string Item type (ex. "VerifiableCredential")
UpdateItemResponse
Response to UpdateItemRequest
Top
services/account/v1/account.proto
Service - Account
AccountDetails
Account registration details
Field
Type
Description
name
string Account name
email
string Email address of account
sms
string SMS number including country code
AccountEcosystem
Deprecated
AccountInfoRequest
Request for information about the account used to make the request
AccountInfoResponse
Information about the account used to make the request
Field
Type
Description
details
AccountDetails The account details associated with the calling request context
ecosystems
AccountEcosystem []Deprecated. Use ecosystem_id instead
wallet_id
string The wallet ID associated with this account
device_id
string The device ID associated with this account session
ecosystem_id
string The ecosystem ID within which this account resides
public_did
string The public DID associated with this account. This DID is used as the issuer when signing verifiable credentials
authorized_webhooks
string []Webhook events, if any, this wallet has authorized
AccountProfile
Device profile containing sensitive authentication data.
This information should be stored securely
Field
Type
Description
profile_type
string The type of profile, used to differentiate between protocol schemes or versions
auth_data
bytes Auth data containg information about the current device access
auth_token
bytes Secure token issued by server used to generate zero-knowledge proofs
protection
TokenProtection Token security information about the token. If token protection is enabled, implementations must supply protection secret before using the token for authentication.
AuthorizeWebhookRequest
Request to authorize Ecosystem provider to receive webhooks for events
which occur on this wallet.
Field
Type
Description
events
string []Events to authorize access to. Default is "*" (all events)
AuthorizeWebhookResponse
Response to AuthorizeWebhookRequest
ListDevicesRequest
ListDevicesResponse
LoginConfirmRequest
Request to finalize login flow
Field
Type
Description
challenge
bytes Challenge received from Login
confirmation_code_hashed
bytes Two-factor confirmation code sent to account email or phone, hashed using Blake3. Our SDKs will handle this hashing process for you.
LoginConfirmResponse
Response to LoginConfirmRequest
Field
Type
Description
profile
AccountProfile Profile response; must be unprotected using unhashed confirmation code. Our SDKs will handle this process for you, and return to you an authentication token string.
LoginRequest
Request to begin login flow
Field
Type
Description
email
string Email address of account. If unspecified, an anonymous account will be created.
invitation_code
string Invitation code associated with this registration
ecosystem_id
string ID of Ecosystem to sign into. Ignored if invitation_code is passed.
LoginResponse
Response to LoginRequest
Field
Type
Description
challenge
bytes Random byte sequence unique to this login request. If present, two-factor confirmation of login is required. Must be sent back, unaltered, in LoginConfirm.
profile
AccountProfile Account profile response. If present, no confirmation of login is required.
RevokeDeviceRequest
RevokeDeviceResponse
SignInRequest
Request for creating or signing into an account
Field
Type
Description
details
AccountDetails Account registration details
invitation_code
string Invitation code associated with this registration
ecosystem_id
string ID of Ecosystem to use Ignored if invitation_code is passed
SignInResponse
Response for creating new account
This object will indicate if a confirmation code
was sent to one of the users two-factor methods
like email, SMS, etc.
Field
Type
Description
confirmation_method
ConfirmationMethod Indicates if confirmation of account is required.
profile
AccountProfile Contains authentication data for use with the current device. This object must be stored in a secure place. It can also be protected with a PIN, but this is optional. See the docs at https://docs.trinsic.id for more information on working with authentication data.
TokenProtection
Token protection info
Field
Type
Description
enabled
bool Indicates if token is protected using a PIN, security code, HSM secret, etc.
method
ConfirmationMethod The method used to protect the token
ConfirmationMethod
Confirmation method type for two-factor workflows
Name
Number
Description
None
0
No confirmation required
Email
1
Email confirmation required
Sms
2
SMS confirmation required
ConnectedDevice
3
Confirmation from a connected device is required
Other
10
Third-party method of confirmation is required
Top
services/provider/v1/provider.proto
Service - Provider
AddWebhookRequest
Request to add a webhook to an ecosystem
Field
Type
Description
destination_url
string Destination to post webhook calls to. Must be a reachable HTTPS URL.
secret
string Secret string used for HMAC-SHA256 signing of webhook payloads to verify that a webhook comes from Trinsic
events
string []Events to subscribe to. Default is "*" (all events)
AddWebhookResponse
Response to AddWebhookRequest
Field
Type
Description
ecosystem
Ecosystem Ecosystem data with new webhook
CreateEcosystemRequest
Request to create an ecosystem
Field
Type
Description
name
string Globally unique name for the Ecosystem. This name will be part of the ecosystem-specific URLs and namespaces. Allowed characters are lowercase letters, numbers, underscore and hyphen. If not passed, ecosystem name will be auto-generated.
description
string Ecosystem description
uri
string Deprecated. External URL associated with your organization or ecosystem entity
details
services.account.v1.AccountDetails The account details of the owner of the ecosystem
domain
string New domain URL
CreateEcosystemResponse
Response to CreateEcosystemRequest
DeleteWebhookRequest
Request to delete a webhook from an ecosystem
Field
Type
Description
webhook_id
string ID of webhook to delete
DeleteWebhookResponse
Response to DeleteWebhookRequest
Field
Type
Description
ecosystem
Ecosystem Ecosystem data after removal of webhook
Ecosystem
Details of an ecosystem
Field
Type
Description
id
string URN of the ecosystem
name
string Globally unique name for the ecosystem
description
string Ecosystem description
uri
string Deprecated. External URL associated with the organization or ecosystem entity
webhooks
WebhookConfig []Configured webhooks, if any
display
EcosystemDisplay Display details
domain
string Domain
EcosystemDisplay
EcosystemDisplayDetails
Field
Type
Description
logo_url
string string id = 1; string name = 2;
color
string
EcosystemInfoRequest
Request to fetch information about an ecosystem
EcosystemInfoResponse
Response to InfoRequest
Field
Type
Description
ecosystem
Ecosystem Ecosystem corresponding to current ecosystem in the account token
GenerateTokenRequest
Request to generate an authentication token for the current account
Field
Type
Description
description
string Description to identify this token
GenerateTokenResponse
Response to GenerateTokenRequest
GetAuthorizationsRequest
Fetch list of grants that the current account has access to
in its ecosystem
GetAuthorizationsResponse
Response to GetAuthorizationsRequest
Field
Type
Description
grants
Grant []Grants attached to account
GetEventTokenRequest
Generates an events token bound to the provided ed25519 public key.
Field
Type
Description
pk
bytes Raw public key to generate event token for
GetEventTokenResponse
Response message containing a token (JWT) that can be used
to connect directly to the message streaming architecture
Field
Type
Description
token
string JWT bound to the public key provided in GetEventTokenRequest
GetOberonKeyRequest
Request to fetch the Trinsic public key used
to verify authentication token validity
GetOberonKeyResponse
Response to GetOberonKeyRequest
Field
Type
Description
key
string Oberon Public Key as RAW base64-url encoded string
GetPublicEcosystemInfoRequest
Request to fetch information about an ecosystem
Field
Type
Description
ecosystem_id
string
GetPublicEcosystemInfoResponse
Response to InfoRequest
Grant
A grant authorizing actions on a resourceId
Field
Type
Description
resourceId
string the urn of the resource
actions
string []list of actions that are allowed
child_grants
Grant []any child grants
GrantAuthorizationRequest
Grant permissions to a resource or path in the ecosystem
Field
Type
Description
email
string Email address of account being granted permission. Mutually exclusive with walletId.
walletId
string Wallet ID of account being granted permission. Mutually exclusive with email.
resource
string Resource string that account is receiving permissions for. Resources are specified as a RESTful path: /{ecoId}/{resource type}/{resource id}. ecoId may be omitted.
action
string Action to authorize. Default is "*" (all)
GrantAuthorizationResponse
Response to GrantAuthorizationRequest
InvitationStatusRequest
Request details for the status of an invitation
Field
Type
Description
invitation_id
string ID of invitation, received from InviteResponse
InvitationStatusResponse
Response to InvitationStatusRequest
InviteRequest
Request to invite a participant to an ecosystem
InviteRequest.DidCommInvitation
InviteResponse
Response to InviteRequest
Field
Type
Description
invitation_id
string ID of created invitation
invitation_code
string Invitation code -- must be passed back in LoginRequest
IonOptions
Options for creation of DID on the ION network
Field
Type
Description
name
string Public name of this ecosystem
domain
string Public domain for the owner of this ecosystem
domain_verified
bool Trinsic verified the domain is owned by the owner of this ecosystem
style_display
EcosystemDisplay Style display information
RefreshDomainVerificationStatusRequest
RefreshDomainVerificationStatusResponse
Field
Type
Description
domain
string Domain URL verified
domain_verified
bool Specifies if the above domain was successfully verified
RetrieveDomainVerificationRecordRequest
RetrieveDomainVerificationRecordResponse
Response message containing a TXT record content for domain url verification
Field
Type
Description
verification_txt
string TXT code to use for domain verification
RevokeAuthorizationRequest
Revoke permissions to a resource or path in the ecosystem
Field
Type
Description
email
string Email address of account having permission revoked. Mutually exclusive with walletId.
walletId
string Wallet ID of account having permission revoked. Mutually exclusive with email.
resource
string Resource string that account is losing permissions for. Resources are specified as a RESTful path: /{ecoId}/{resource type}/{resource id}. ecoId may be omitted.
action
string Action to revoke. Default is "*" (all)
RevokeAuthorizationResponse
Response to RevokeAuthorizationRequest
SearchWalletConfigurationResponse
Field
Type
Description
results
WalletConfiguration []Results matching the search query
has_more
bool Whether more results are available for this query via continuation_token
continuation_token
string Token to fetch next set of results via SearchRequest
SearchWalletConfigurationsRequest
Search for issuers/holders/verifiers
Field
Type
Description
query_filter
string SQL filter to execute. SELECT * FROM _ WHERE [**queryFilter**]
continuation_token
string Token provided by previous SearchResponse if more data is available for query
UpdateEcosystemRequest
Request to update an ecosystem's metadata
Field
Type
Description
description
string New description of the ecosystem
uri
string Deprecated. New external URL associated with the organization or ecosystem entity
domain
string New domain URL
name
string New name
display
EcosystemDisplay Display details
UpdateEcosystemResponse
Response to UpdateEcosystemRequest
Field
Type
Description
Ecosystem
Ecosystem Current ecosystem metadata, post-update
UpgradeDidRequest
Request to upgrade a wallet
Field
Type
Description
email
string Email address of account to upgrade. Mutually exclusive with walletId.
wallet_id
string Wallet ID of account to upgrade. Mutually exclusive with email.
method
services.common.v1.SupportedDidMethod DID Method to which wallet should be upgraded
ion_options
IonOptions Configuration for creation of DID on ION network
UpgradeDidResponse
Response to UpgradeDIDRequest
Field
Type
Description
did
string New DID of wallet
WalletConfiguration
Strongly typed information about wallet configurations
WebhookConfig
Webhook configured on an ecosystem
Field
Type
Description
id
string UUID of the webhook
destination_url
string HTTPS URL to POST webhook calls to
events
string []Events the webhook is subscribed to
status
string Last known status of webhook (whether or not Trinsic can successfully reach destination)
InvitationStatusResponse.Status
Name
Number
Description
Error
0
Onboarding resulted in error
InvitationSent
1
The participant has been invited
Completed
2
The participant has been onboarded
Expired
3
The invite has expired
IonOptions.IonNetwork
Name
Number
Description
TestNet
0
MainNet
1
ParticipantType
Type of participant being invited to ecosystem
Name
Number
Description
participant_type_individual
0
Participant is an individual
participant_type_organization
1
Participant is an organization
Top
services/trust-registry/v1/trust-registry.proto
Service - TrustRegistry
AddFrameworkRequest
Request to register a new ecosystem governance framework in the current ecosystem
Field
Type
Description
governance_framework_uri
string URI of governance framework organization
name
string Name of governance framework organization
description
string Description of governance framework
AddFrameworkResponse
Response to AddFrameworkRequest
Field
Type
Description
id
string Unique framework identifier
governing_authority
string DID URI of Trinsic account which created the governance framework
trust_registry
string URN of trust registry for governance framework
FetchDataRequest
Not implemented.
Field
Type
Description
governance_framework_uri
string
query
string
FetchDataResponse
Not implemented.
Field
Type
Description
response_json
string
has_more_results
bool
continuation_token
string
GetMembershipStatusRequest
Request to fetch membership status in governance framework for a specific credential schema.
Only one of did_uri, x509_cert may be specified.
Field
Type
Description
governance_framework_uri
string URI of governance framework
did_uri
string DID URI of member
x509_cert
string X.509 certificate of member
schema_uri
string URI of credential schema associated with membership
GetMembershipStatusResponse
Response to GetMembershipStatusRequest
Field
Type
Description
status
RegistrationStatus Status of member for given credential schema
GovernanceFramework
Ecosystem Governance Framework
Field
Type
Description
governance_framework_uri
string URI of governance framework organization
trust_registry_uri
string URI of trust registry associated with governance framework
description
string Description of governance framework
RegisterMemberRequest
Request to register a member as a valid issuer of a specific credential schema.
Only one of did_uri, wallet_id, or email may be specified.
Field
Type
Description
did_uri
string DID URI of member to register
wallet_id
string Trinsic Wallet ID of member to register
email
string Email address of member to register. Must be associated with an existing Trinsic account.
schema_uri
string URI of credential schema to register member as authorized issuer of
valid_from_utc
uint64 Unix Timestamp member is valid from. Member will not be considered valid before this timestamp.
valid_until_utc
uint64 Unix Timestamp member is valid until. Member will not be considered valid after this timestamp.
framework_id
string ID of the governance framework that member is being added to
RegisterMemberResponse
Response to RegisterMemberRequest
RemoveFrameworkRequest
Request to remove a governance framework from the current ecosystem
Field
Type
Description
id
string ID of governance framework to remove
RemoveFrameworkResponse
Response to RemoveFrameworkRequest
SearchRegistryRequest
Request to search all governance frameworks within ecosystem
Field
Type
Description
query
string SQL query to execute against frameworks. Example: SELECT c from c where c.type == 'GovernanceFramework'
continuation_token
string Token to fetch next set of results, from previous SearchRegistryResponse
SearchRegistryResponse
Response to SearchRegistryRequest
Field
Type
Description
items_json
string JSON string containing array of resultant objects
has_more
bool Whether more data is available to fetch for query
continuation_token
string Token to fetch next set of results via SearchRegistryRequest
UnregisterMemberRequest
Request to unregister a member as a valid issuer of a specific credential schema.
Only one of did_uri, wallet_id, or email may be specified.
Field
Type
Description
did_uri
string DID URI of member to unregister
wallet_id
string Trinsic Wallet ID of member to unregister
email
string Email address of member to unregister. Must be associated with an existing Trinsic account.
schema_uri
string URI of credential schema to unregister member as authorized issuer of
framework_id
string ID of the governance framework that member is being removed from
UnregisterMemberResponse
Response to UnregisterMemberRequest
RegistrationStatus
Name
Number
Description
CURRENT
0
Member is currently authorized, as of the time of the query
EXPIRED
1
Member's authorization has expired
TERMINATED
2
Member has voluntarily ceased Issuer role under the specific EGF
REVOKED
3
Member authority under specific EGF was terminated by the governing authority
NOT_FOUND
10
Member is not associated with given credential schema in the EGF
Top
services/options/field-options.proto
SdkTemplateOption
Field
Type
Description
anonymous
bool Whether the service endpoint allows anonymous (no auth token necessary) authentication This is used by the protoc-gen-trinsic-sdk plugin for metadata.
ignore
bool Whether the SDK template generator should ignore this method. This method will be wrapped manually.
no_arguments
bool Whether the SDK template generator should generate this method without arguments, eg ProviderService.GetEcosystemInfo() where the request object is empty
File-level Extensions
Extension
Type
Base
Number
Description
optional
bool
.google.protobuf.FieldOptions
60000
Whether field is optional in Trinsic's backend. This is not the same as an optional protobuf label; it only impacts documentation generation for the field.
sdk_template_option
SdkTemplateOption
.google.protobuf.MethodOptions
60001
Top
services/common/v1/common.proto
Nonce
Nonce used to generate an oberon proof
Field
Type
Description
timestamp
int64 UTC unix millisecond timestamp the request was made
request_hash
bytes blake3256 hash of the request body
ResponseStatus
Name
Number
Description
SUCCESS
0
WALLET_ACCESS_DENIED
10
WALLET_EXISTS
11
ITEM_NOT_FOUND
20
SERIALIZATION_ERROR
200
UNKNOWN_ERROR
100
SupportedDidMethod
Enum of all supported DID Methods
Name
Number
Description
KEY
0
The did:key method -- all wallets use this by default
ION
1
The did:ion method
Top
sdk/options/v1/options.proto
ServiceOptions
Configuration for Trinsic SDK Services
Field
Type
Description
server_endpoint
string Trinsic API endpoint. Defaults to prod.trinsic.cloud
server_port
int32 Trinsic API port; defaults to 443
server_use_tls
bool Whether TLS is enabled between SDK and Trinsic API; defaults to true
auth_token
string Authentication token for SDK calls; defaults to empty string (unauthenticated)
Default ecosystem ID to use for various SDK calls; defaults to default string default_ecosystem = 5; |
Scalar Value Types
.proto Type
Notes
C++
Java
Python
Go
C#
PHP
Ruby
double
double
float
float64
double
float
Float
float
float
float
float32
float
float
Float
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
int64
long
int/long
int64
long
integer/string
Bignum
Uses variable-length encoding.
uint32
int
int/long
uint32
uint
integer
Bignum or Fixnum (as required)
Uses variable-length encoding.
uint64
long
int/long
uint64
ulong
integer/string
Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
int64
long
int/long
int64
long
integer/string
Bignum
Always four bytes. More efficient than uint32 if values are often greater than 2^28.
uint32
int
int
uint32
uint
integer
Bignum or Fixnum (as required)
Always eight bytes. More efficient than uint64 if values are often greater than 2^56.
uint64
long
int/long
uint64
ulong
integer/string
Bignum
Always four bytes.
int32
int
int
int32
int
integer
Bignum or Fixnum (as required)
Always eight bytes.
int64
long
int/long
int64
long
integer/string
Bignum
bool
boolean
boolean
bool
bool
boolean
TrueClass/FalseClass
A string must always contain UTF-8 encoded or 7-bit ASCII text.
string
String
str/unicode
string
string
string
String (UTF-8)
May contain any arbitrary sequence of bytes.
string
ByteString
str
[]byte
ByteString
string
String (ASCII-8BIT)