Skip to main content
Version: v4

search_response_EcosystemSnippet

An Ecosystem hit snippet: the [TG-FCT-6a] core plus the [TG-FCT-6b] Ecosystem-surface groups selected by the projection (default set: corporation, stats, didCard). An unselected group is omitted entirely, never null.

idintegerrequired

Possible values: >= 0

didsearch_response_DidStringrequired

The Ecosystem's DID (mirrors VPR Ecosystem.did; MAY be shared across Ecosystem entries — the key remains id).

Possible values: Value must match regular expression ^did:

archivedbooleanrequired
lastObservedAtTimestring<date-time>required

ISO 8601 / RFC 3339 datetime string in UTC.

Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?Z$

corporation object

[TG-FCT-6b] corporation group via Ecosystem.corporationId — same field set as the Did-surface group; never null. Present iff selected (default set).

idintegerrequired

Stable uint64 id of the referenced Corporation (Did.corporationId / Ecosystem.corporationId). Never null.

Possible values: >= 0

depositstring | nullnullablerequired

Referenced Corporation.deposit (Coin string); null only while the Corporation record is not yet materialised (bootstrap transient).

slashedEventsinteger | nullnullablerequired

Referenced Corporation.slashedEvents (0 when never slashed); null only while the Corporation record is not yet materialised (bootstrap transient).

Possible values: >= 0

lastSlashedAtTime objectrequired

Referenced Corporation.lastSlashedAtTime; null when never slashed, or while the Corporation record is not yet materialised.

anyOf

ISO 8601 / RFC 3339 datetime string in UTC.

string<date-time>

ISO 8601 / RFC 3339 datetime string in UTC.

Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?Z$

slashedValuestring | nullnullablerequired

Referenced Corporation.slashedValue (Coin string); null when never slashed, or while the Corporation record is not yet materialised.

property name*any

[TG-FCT-6b] corporation group via Ecosystem.corporationId — same field set as the Did-surface group; never null. Present iff selected (default set).

stats object

[TG-FCT-6b] stats group. Present iff selected (default set).

participants objectrequired

Per-role aggregate counts (map role → uint).

property name*integer

Possible values: >= 0

issuedCredentialsintegerrequired

Possible values: >= 0

verifiedCredentialsintegerrequired

Possible values: >= 0

property name*any

[TG-FCT-6b] stats group. Present iff selected (default set).

governance object

[TG-FCT-6b] governance group — the inline egf summary; null when the Ecosystem has not yet published any GF. Present iff selected (opt-in).

oneOf

Inline governance-framework summary (cgf / egf per [TG-DEREF-2a] / [TG-DEREF-2b]): active version, activation time, and document metadata — never document bodies. activeSince is required-present per the [TG-FCT-6b] null-not-omitted rule (null when the upstream inline object omits it), even though the persisted entity-table shape writes it as optional.

versionintegerrequired

Active GF version (integer, per the indexer's inline cgf / egf surfacing).

Possible values: >= 1

activeSince objectrequired
anyOf

ISO 8601 / RFC 3339 datetime string in UTC.

string<date-time>

ISO 8601 / RFC 3339 datetime string in UTC.

Possible values: Value must match regular expression ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+)?Z$

documents object[]required
  • Array [
    • languagestringrequired
    urlstring<uri>required
    digestSrisearch_response_DigestSrirequired

    Possible values: Value must match regular expression ^sha(256|384|512)-

    property name*any
  • ]
    • property name*any

    Inline governance-framework summary (cgf / egf per [TG-DEREF-2a] / [TG-DEREF-2b]): active version, activation time, and document metadata — never document bodies. activeSince is required-present per the [TG-FCT-6b] null-not-omitted rule (null when the upstream inline object omits it), even though the persisted entity-table shape writes it as optional.

    schemas object[]

    [TG-FCT-6b] schemas group; [] when the Ecosystem owns no schema. Present iff selected (opt-in).

  • Array [
    • idintegerrequired

    Possible values: >= 0

    titlestring | nullnullablerequired

    title of the loaded CredentialSchema.body; null when the body declares no title.

    archivedbooleanrequired
    participants objectrequired

    CredentialSchema.participants — the schema's per-role participant counts.

    property name*integer

    Possible values: >= 0

    property name*any

    Owned-schema reference: the shared item shape of the Did-surface ecosystems[].schemas and the Ecosystem-surface schemas group.

  • ]
    • didCard object

    [TG-FCT-6b] didCard group — the controller DID (Ecosystem.did) as a card. Present iff selected (default set).

    didsearch_response_DidStringrequired

    Possible values: Value must match regular expression ^did:

    trustedbooleanrequired
    isTrustExpiredbooleanrequired
    service objectrequired

    Same shape and null conditions as the Did-surface service group.

    oneOf

    [TG-FCT-6b] service group: the VS-level identity asserted by the ServiceCredential. The group is null (not this object) when the DID presents no ServiceCredential.

    patternstringrequired

    Architecture pattern (Did.pattern); non-null whenever a ServiceCredential exists.

    Possible values: [A, B]

    namestringrequired

    ServiceCredential.name.

    typestringrequired

    ServiceCredential.type — the declared VS service category.

    descriptionstringrequired

    ServiceCredential.description, optionally truncated for card use (truncation ends at a character boundary and is flagged with a trailing …).

    logoUristring<uri>required

    ServiceCredential.logoUri.

    logoDigestSrisearch_response_DigestSrirequired

    ServiceCredential.logoDigestSri.

    Possible values: Value must match regular expression ^sha(256|384|512)-

    property name*any

    [TG-FCT-6b] service group: the VS-level identity asserted by the ServiceCredential. The group is null (not this object) when the DID presents no ServiceCredential.

    operator objectrequired

    Same shape and null conditions as the Did-surface operator group.

    oneOf

    [TG-FCT-6b] operator group: the operative ORG-or-PERSONA identity the VS's trust chain rests on (Pattern A: self; Pattern B: issuer), per the [TG-FCT-3] derivation. The group is null (not this object) when the trust chain is incomplete.

    kindstringrequired

    Derived facet per [TG-FCT-3].

    Possible values: [Organization, Persona]

    namestringrequired

    Operative OrganizationCredential.name or PersonaCredential.name.

    logoUri(string | null)<uri>nullablerequired

    Operative OrganizationCredential.logoUri or PersonaCredential.avatarUri; null for a Persona without avatar.

    logoDigestSri objectrequired

    Paired OrganizationCredential.logoDigestSri or PersonaCredential.avatarDigestSri; null under the same conditions as logoUri.

    anyOf
    search_response_DigestSri

    Possible values: Value must match regular expression ^sha(256|384|512)-

    countryCodestringrequired

    Operative OrganizationCredential.countryCode or PersonaCredential.controllerCountryCode.

    Possible values: Value must match regular expression ^[A-Z]{2}$

    registryIdstring | nullnullablerequired

    Operative OrganizationCredential.registryId; null when the operator is a Persona.

    addressstring | nullnullablerequired

    Operative OrganizationCredential.address; null when the operator is a Persona.

    property name*any

    [TG-FCT-6b] operator group: the operative ORG-or-PERSONA identity the VS's trust chain rests on (Pattern A: self; Pattern B: issuer), per the [TG-FCT-3] derivation. The group is null (not this object) when the trust chain is incomplete.

    property name*any

    [TG-FCT-6b] didCard group — the controller DID (Ecosystem.did) as a card. Present iff selected (default set).

    property name*any

    An Ecosystem hit snippet: the [TG-FCT-6a] core plus the [TG-FCT-6b] Ecosystem-surface groups selected by the projection (default set: corporation, stats, didCard). An unselected group is omitted entirely, never null.

    search_response_EcosystemSnippet
    {
      "id": 0,
      "did": "string",
      "archived": true,
      "lastObservedAtTime": "2024-07-29T15:51:28.071Z",
      "corporation": {
        "id": 0,
        "deposit": "string",
        "slashedEvents": 0,
        "lastSlashedAtTime": "2024-07-29T15:51:28.071Z",
        "slashedValue": "string"
      },
      "stats": {
        "participants": {},
        "issuedCredentials": 0,
        "verifiedCredentials": 0
      },
      "governance": {
        "version": 0,
        "activeSince": "2024-07-29T15:51:28.071Z",
        "documents": [
          {
            "language": "string",
            "url": "string",
            "digestSri": "string"
          }
        ]
      },
      "schemas": [
        {
          "id": 0,
          "title": "string",
          "archived": true,
          "participants": {}
        }
      ],
      "didCard": {
        "did": "string",
        "trusted": true,
        "isTrustExpired": true,
        "service": {
          "name": "string",
          "type": "string",
          "description": "string",
          "logoUri": "string",
          "logoDigestSri": "string"
        },
        "operator": {
          "name": "string",
          "logoUri": "string",
          "logoDigestSri": "string",
          "countryCode": "string",
          "registryId": "string",
          "address": "string"
        }
      }
    }