Read Link Record

• The location owner optionally publishes the link location

• Anyone who has the location can read just the headers or the full record

• They can use any industry-standard tool

Example headers code:

cURL

curl --head $URL/api/v1/linkedrecords/$LOC/content \
     -H "x-api-key: $KEY" \
     -H "accept: */*"

JavaScript

const response = await fetch('${url}/api/v1/linkedrecords/${loc}/content', {
  method: 'HEAD',
  headers: {
    'x-api-key': '$KEY',
    'accept': '*/*'
  }
});

Example record code:

cURL

curl $URL/api/v1/linkedrecords/$LOC/content \
     -H "x-api-key: $KEY" \
     -H "accept: text/plain"

JavaScript

const response = await fetch('${url}/api/v1/linkedrecords/${loc}/content', {
  headers: {
    'x-api-key': '${key}',
    'accept': 'text/plain'
  }
});

Read Encoded Link

Example cURL headers response:

content-length: 44
content-type: text/plain; nchain-event-encoded=Sha256v2|Base64
date: Tue,02 Jan 2024 14:15:41 GMT
server: nginx/1.18.0 (Ubuntu)

Example cURL record response:

ytfc5c5wv0V7hOo....G1ucRFzSIe6rw=

To find out whether the resultant fingerprint is valid, the user also needs the original record and the encoding method plus any salt used.

Read Unencoded Link

Example cURL headers response:

content-length: 6
content-type: application/octet-stream
date: Tue,02 Jan 2024 14:18:52 GMT
server: nginx/1.18.0 (Ubuntu)

Example cURL record response:

hello