Configuration Object

Details and data about the property configuration, including title proof and media information.

Configuration Object

The configuration property is mutable, it can be updated by the owner(s) and links to additional property information.

{
  "proofOfTitle": {
    "document": "ipfs://bafkrei...",
    "documentId": "433397",
    "documentName": "Bargain and Sale Deed",
    "source": "Huerfano, CO County Records",
    "grantor": "The Terrain Inventory, LLC"
  },
  "userDescription": "This secluded 2.35 acres offers both privacy and exclusivity...",
  "media": [
    {
      "type": "image",
      "source": "ipfs://QmUdZ8...",
      "description": "Looking north from the county road",
      "order": "1"
    }
  ],
  "documents": [],
  "vendor": "regrid",
  "vendorId": "f8d8687b-2b78-4aef-9bcf-019cb6afd7cc",
  "holdingEntityDate": "2024-06-25T22:17:49.475Z"
}
FieldDescription
proofOfTitleDocuments verifying that the title was correctly established (typically the deed granting title to the holding entity).
userDescriptionOwner-provided property description for marketing purposes.
mediaPictures, videos, and other visual content about the property. See Media entries.
documentsAdditional documents attached to the property.
vendor / vendorIdLinks to third-party vendors used for creation or validation.
holdingEntityDateThe date when the holding entity was created (may differ from token issuance).

Media entries

Each entry in media describes one file:

FieldDescription
typeimage, video, or animation.
sourceWhere the file lives: an ipfs://<cid> URI or an https:// URL. When a file is uploaded through the Fabrica API it is pinned to IPFS and stored as ipfs://<cid>.
descriptionOptional caption, up to 255 characters.
orderOptional display position, a numeric value stored as a string. Entries are shown in ascending order, with entries that have no order last. The first image in that order is the property's cover image.

The Fabrica GraphQL API returns configuration.media already sorted this way, so clients can render the array as received. A media entry can be removed through the configuration update endpoints by sending its source with delete: true; the ipfs://<cid> form and any gateway URL for the same CID match the same entry, and a removal that matches nothing is rejected with an error naming the source rather than ignored.

Design note: holdingEntityDate is intentionally placed in the configuration (mutable) rather than the definition object, even though the related definition.holdingEntity (name) is immutable. The date is operational metadata that may not be known at minting time (especially in non-US jurisdictions) and has no security-sensitive downstream use, unlike the entity name, which is interpolated into legal documents and used for validator scoring.



Did this page help you?