package services.verifiablecredentials.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Accept an offer to exchange a credential
message
verifiable-credentials.proto:298oneof offer
string document_json = 1
The JSON document that contains the credential offer
string item_id = 2
The ID of the credential offer (Parameter ID inside the JSON document)
message
verifiable-credentials.proto:306string item_id = 1
The ID of the item in the wallet that contains the issued credential
string document_json = 2
The JSON document that contains the issued credential. This item is already stored in the wallet.
Check credential status in the revocation registry
message
verifiable-credentials.proto:184Request to check a credential's revocation status
string credential_status_id = 1
Credential Status ID to check. This is not the same as the credential's ID.
message
verifiable-credentials.proto:190Response to `CheckStatusRequest`
bool revoked = 1
The credential's revocation status
Create credential offer
message
verifiable-credentials.proto:271string template_id = 1
ID of template to use
string values_json = 2
JSON document string with keys corresponding to the fields of the template referenced by `template_id`
bool holder_binding = 3
If true, the credential will be issued with holder binding by specifying the holder DID in the credential subject
bool include_governance = 4
If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's Trust Registry.
bool generate_share_url = 5
If true, a short URL link will be generated that can be used to share the credential offer with the holder. This link will point to the credential offer in the wallet app.
SignatureType signature_type = 7
The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`.
message
verifiable-credentials.proto:289string document_json = 1
The JSON document that contains the credential offer
string share_url = 2
If requested, a URL that can be used to share the credential offer with the holder. This is a short URL that can be used in a QR code and will redirect the holder to the credential offer using the wallet app.
Create a proof from a signed document that is a valid verifiable credential and contains a signature from which a proof can be derived.
message
verifiable-credentials.proto:66Request 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.
oneof disclosure
Selective disclosure specification. If nothing is provided, the entire proof is returned. Either a custom JSON-LD frame is provided, or a list of attributes is provided for selective disclosure
string reveal_document_json = 1
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
reveal_template = 11
Information about what sections of the document to reveal
string verification_template_id = 12
Id of verification template with which to construct the JSON-LD proof document
oneof proof
Specify the input to be used to derive this proof. Input can be an existing item in the wallet or an input document
string item_id = 2
ID of wallet item stored in a Trinsic cloud wallet
string document_json = 3
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.
bool use_verifiable_presentation = 4
Wrap the output in a verifiable presentation. If the credential used in the proof is bound to the holder DID, the output will always use a verifiable presentation and this field will be ignored.
bytes nonce = 10
Nonce value used to derive the proof. If not specified, a random nonce will be generated. This value may be represented in base64 format in the proof model.
message
verifiable-credentials.proto:107Response to `CreateProofRequest`
string proof_document_json = 1
Valid JSON-LD proof for the specified credential
Sign and issue a verifiable credential from a pre-defined template. This process will also add schema validation and revocation registry values to the credential.
message
verifiable-credentials.proto:15Request to create and sign a JSON-LD Verifiable Credential from a template using public key tied to caller
string template_id = 1
ID of template to use
string values_json = 2
JSON document string with keys corresponding to the fields of the template referenced by `template_id`
bool save_copy = 4
Save a copy of the issued credential to this user's wallet. This copy will only contain the credential data, but not the secret proof value. Issuers may use this data to keep track of the details for revocation status.
string expiration_date = 5
The ISO8601 expiration UTC date of the credential. This is a reserved field in the VC specification. If specified, the issued credential will contain an expiration date. https://www.w3.org/TR/vc-data-model/#expiration
bool include_governance = 6
If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's Trust Registry.
SignatureType signature_type = 7
The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`.
message
verifiable-credentials.proto:57Response to `IssueFromTemplateRequest`
string document_json = 1
Verifiable Credential document, in JSON-LD form, constructed from the specified template and values; signed with public key tied to caller of `IssueFromTemplateRequest`
Reject an offer to exchange a credential
message
verifiable-credentials.proto:314oneof offer
string document_json = 1
The JSON document that contains the credential offer
string item_id = 2
The ID of the credential offer (Parameter ID inside the JSON document)
message
verifiable-credentials.proto:322(message has no fields)
rpc Send (, )
verifiable-credentials.proto:241Sends a document directly to a user's email within the given ecosystem
message
verifiable-credentials.proto:142Request to send a document to another user's wallet
oneof delivery_method
string email = 1
Email address of user to whom you'll send the item
string wallet_id = 5
Wallet ID of the recipient within the ecosystem
string did_uri = 6
DID URI of the recipient
string phone_number = 7
SMS of user to whom you'll send the item
bool send_notification = 4
Send email notification that credential has been sent to a wallet
string document_json = 100
JSON document to send to recipient
message
verifiable-credentials.proto:167Response to `SendRequest`
(message has no fields)
Update credential status by setting the revocation value
message
verifiable-credentials.proto:171Request to update a credential's revocation status
string credential_status_id = 1
Credential Status ID to update. This is not the same as the credential's ID.
bool revoked = 2
New revocation status of credential
message
verifiable-credentials.proto:180Response to `UpdateStatusRequest`
(message has no fields)
Verifies a proof by checking the signature value, and if possible schema validation, revocation status, and issuer status against a trust registry
message
verifiable-credentials.proto:113Request to verify a proof
string proof_document_json = 1
JSON-LD proof document string to verify
message
verifiable-credentials.proto:119Response to `VerifyProofRequest`
bool is_valid = 1
Whether all validations in `validation_results` passed
map<string, > validation_results = 3
Results of each validation check performed, such as schema conformance, revocation status, signature, etc. Detailed results are provided for failed validations.
message
verifiable-credentials.proto:101Used in:
repeated string template_attributes = 1
A list of document attributes to reveal. If unset, all attributes will be returned.
Used in: ,
UNSPECIFIED = 0
The signature type is not specified. The experimental signature type will be used.
STANDARD = 1
The signature type uses EdDSA with the Ed25519 curve (NIST compliant). This type of signature does not support selective disclosure of attributes.
EXPERIMENTAL = 2
The signature type uses BBS signatures with BLS12-381 curve (experimental). This type of signature allows for selective disclosure of attributes.
message
verifiable-credentials.proto:133Result of a validation check on a proof
Used in:
bool is_valid = 1
Whether this validation check passed
repeated string messages = 2
If validation failed, contains messages explaining why