Records

Write record

Write a record transaction to the blockchain.

The transaction will be published to the blockchain asynchronously. Use Get linked record status to find out when it has been confirmed.

post

{your-URL}/api/v1/records

Query parameters

encodestringrequired

Encode the record before registering on the blockchain. Available encoders depend upon your configuration options. Possible encoders include:

• SHA256: Encode using SHA-2 256 *
• Base64: Makes output human-readable
• No specified encoder: the record is not encoded.

Note * A "salt" parameter may be specified in () brackets containing any of the following characters: ASCII letters and digits, "/", ":", "-" and "+" (URL encoded as "%2B"). The "salt" parameter will be prepended to the record before encoding.

Encoders may be combined using '|'. Example: SHA256(23:59:59.123)|Base64

Header parameters

x-api-keystringrequired

{your-API-key}

Body

string · byte

Responses

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '{your-URL}/api/v1/records?encode=text' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/octet-stream'

200

400

500

200

text/plain

application/json

text/json

text/plain

{
  "txId": "text",
  "fingerprint": "text"
}

The transaction has been published. The response is a JSON structure, containing the following details:

• txId: the transaction Id which is required by subsequent commands and can also be used by external tools
• encoding: array of encoding steps (omitted when encoders are not used), each element defines:
  • contentType: output content type
  • output: if content type is text, it will include up to 1024 characters of the output (omitted for binary content types)