Skip to main content
Skip table of contents

The Envelope - Format & Fields

Format

The basic format of an envelope is a header that informs The Platform of a general context of the call and then 1 or more data objects in an array the are specific to the call being made. Envelope key fields and their use are described below.

Field

Purpose

ETId

Envelope Type ID - The type of envelope this is. This is used so the platform knows what type of object to expect in the Data Field.

SV

The version of the data part of the envelope - Optional! By default the API will assume the latest SV is to be used. This is provided to allow use of a pervious SV. In practice it is best to always use the latest which means this does not need to be specified.

Data

A JSON/BSON object that contains the data that is represented by the ETId. This is not present on the internal blockchain as the contents of the Data field are encrypted and moved off chain. The DH (Data hash of the Cipher Text (64 chars long) field creates a permanent proof that the data which was submitted is the same that is stored.

Table 2.1.1. : Envelope Key Fields and Details

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.