Skip to main content

vc.proto

path agntcy/identity/core/v1alpha1/vc.proto

package agntcy.identity.core.v1alpha1


Messages​

BadgeClaims​

BadgeClaims represents the content of a Badge VC defined [here] [here]: https://spec.identity.agntcy.org/docs/vc/intro/

NameTypeDescription
idoptional stringThe ID as defined [here] [here]: https://www.w3.org/TR/vc-data-model/#credential-subject
badgeoptional stringThe content of the badge

CredentialContent​

CredentialContent represents the content of a Verifiable Credential.

NameTypeDescription
content_typeoptional CredentialContentTypeType specifies the type of the content of the credential.
contentoptional google.protobuf.StructThe content representation in JSON-LD format.

CredentialSchema​

CredentialSchema represents the credentialSchema property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-data-model-2.0/#data-schemas

NameTypeDescription
typeoptional stringType specifies the type of the file
idoptional stringThe URL identifying the schema file

CredentialStatus​

CredentialStatus represents the credentialStatus property of a Verifiable Credential. more information can be found [here] [here]: https://www.w3.org/TR/vc-data-model-2.0/#status

NameTypeDescription
idoptional stringThe URL identifying the schema file
typeoptional stringType specifies the type of the file
created_atoptional TimeThe creation date and time of the status
purposeoptional CredentialStatusPurposeThe value of the purpose for the status entry

EnvelopedCredential​

EnvelopedCredential represents a Credential enveloped in a specific format.

NameTypeDescription
envelope_typeoptional CredentialEnvelopeTypeEnvelopeType specifies the type of the envelope used to store the credential.
valueoptional stringValue is the enveloped credential in the specified format.

Proof​

A data integrity proof provides information about the proof mechanism, parameters required to verify that proof, and the proof value itself.

NameTypeDescription
typeoptional stringThe type of the proof
proof_purposeoptional stringThe proof purpose
proof_valueoptional stringThe proof value

Time​

NameTypeDescription

VerifiableCredential​

DataModel represents the W3C Verifiable Credential Data Model defined [here] [here]: https://www.w3.org/TR/vc-data-model/

NameTypeDescription
contextrepeated stringhttps://www.w3.org/TR/vc-data-model/#contexts
typerepeated stringhttps://www.w3.org/TR/vc-data-model/#dfn-type
issueroptional stringhttps://www.w3.org/TR/vc-data-model/#issuer
contentoptional google.protobuf.Structhttps://www.w3.org/TR/vc-data-model/#credential-subject
idoptional stringhttps://www.w3.org/TR/vc-data-model/#identifiers
issuance_dateoptional stringhttps://www.w3.org/TR/vc-data-model/#issuance-date
expiration_dateoptional stringhttps://www.w3.org/TR/vc-data-model/#expiration
credential_schemarepeated CredentialSchemahttps://www.w3.org/TR/vc-data-model-2.0/#data-schemas
credential_statusrepeated CredentialStatushttps://www.w3.org/TR/vc-data-model-2.0/#status
proofoptional Proofhttps://w3id.org/security#proof

VerifiablePresentation​

DataModel represents the W3C Verifiable Presentation Data Model defined [here] [here]: https://www.w3.org/TR/vc-data-model/

NameTypeDescription
contextrepeated stringhttps://www.w3.org/TR/vc-data-model/#contexts
typerepeated stringhttps://www.w3.org/TR/vc-data-model/#dfn-type
verifiable_credentialrepeated VerifiableCredentialhttps://www.w3.org/2018/credentials#verifiableCredential
proofoptional Proofhttps://w3id.org/security#proof

VerificationResult​

The result returned from the verification process defined [here] [here]: https://www.w3.org/TR/vc-data-model-2.0/#verification

NameTypeDescription
statusoptional boolA boolean status
documentoptional VerifiableCredentialA conforming document which represents the Verifiable Credential
media_typeoptional stringThe media type of the Verifiable Credential (ex: application/vc)
controlleroptional stringThe controller of the verification method associated with the securing mechanism, usually it represents the issuer.
controlled_identifier_documentoptional stringA controlled identifier document that is associated with the verification method used to verify the securing mechanism (i,e the DID)
warningsrepeated ErrorInfoA list represents zero or more warnings generated by the verification process
errorsrepeated ErrorInfoA list represents zero or more errors generated by the verification process

Enums​

CredentialContentType​

The content of the Credential. Multiple content types can be supported: AgentBadge, etc.

NameNumberDescription
CREDENTIAL_CONTENT_TYPE_UNSPECIFIED0Unspecified Content Type.
CREDENTIAL_CONTENT_TYPE_AGENT_BADGE1AgentBadge Content Type. The Agent content representation following a defined schema OASF: https://schema.oasf.agntcy.org/schema/objects/agent Google A2A: https://github.com/google/A2A/blob/main/specification/json/a2a.json
CREDENTIAL_CONTENT_TYPE_MCP_BADGE2McpBadge Content Type. The MCP content representation following a defined schema The schema is defined in the MCP specification as the MCPServer type

CredentialEnvelopeType​

The Envelope Type of the Credential. Multiple envelope types can be supported: Embedded Proof, JOSE, COSE etc.

NameNumberDescription
CREDENTIAL_ENVELOPE_TYPE_UNSPECIFIED0Unspecified Envelope Type.
CREDENTIAL_ENVELOPE_TYPE_EMBEDDED_PROOF1Embedded Proof Envelope Type.
CREDENTIAL_ENVELOPE_TYPE_JOSE2JOSE Envelope Type.

CredentialStatusPurpose​

The purpose of the status entry

NameNumberDescription
CREDENTIAL_STATUS_PURPOSE_UNSPECIFIED0Unspecified status purpose
CREDENTIAL_STATUS_PURPOSE_REVOCATION1Used to cancel the validity of a verifiable credential. This status is not reversible.