Write Record

The record will be submitted to the blockchain asynchronously. You should use GET Location Status to find out whether the record has been confirmed before performing any other operations on the returned location.

Write Encoded Record

1. The record owner selects any encoders and salt to use

2. The record owner writes a record to be encoded via nChain Event

3. nChain Event encodes the record as specified to produce a fingerprint

4. The fingerprint is written to the blockchain

5. The result is the fingerprint and its location on the blockchain

6. The record owner stores the encoder, salt, fingerprint and location for subsequent processing

Example code:

cURL

curl -X POST "$URL/api/v1/records?encode=SHA256(01-02T13.14.15)|Base64" \
     -H "x-api-key: $KEY" \
     -H "Content-Type: application/octet-stream" \
     --data-binary "hello"

JavaScript

const response = await fetch('${url}/api/v1/records?
encode=SHA256(01-02T13.14.15)|Base64', {
  method: 'POST',
  headers: {
    'x-api-key': '${key}',
    'Content-Type': 'application/octet-stream'
  },
  body: 'hello'
});

Example cURL response:

{
  "txId": "7d2aef40841f0109....c31c83a5505a4c147e",
  "encoding" : [
    { 
      "content-type": "…|Base64", 
      "output" : "ytfc5c5wv0V7hOo....G1ucRFzSIe6rw=" 
    }
  ]
  ...
}

The final "output" shows the record that was written to the blockchain.

Write Unencoded Record

1. The record owner writes an unencoded record via nChain Event

2. The result is the location of the record on the blockchain

3. The record owner stores the location for later processing

Example code:

cURL

curl -X POST $URL/api/v1/records \
     -H "x-api-key: $KEY" \
     -H "Content-Type: application/octet-stream" \
     --data-binary "hello"

JavaScript

const response = await fetch('${url}/api/v1/records', {
  method: 'POST',
  headers: {
    'x-api-key': '${key}',
    'Content-Type': 'application/octet-stream'
  },
  body: 'hello'
});

Example cURL response:

{
  "txId": "7d2aef40841f0109....c31c83a5505a4c147e"
}

Extract Location

At least the location (shown as "txId") should be stored for subsequent operations:

cURL

LOC=7d2aef40841f0109....c31c83a5505a4c147e

JavaScript

const data = await response.json();
const loc = data.txId;