Connectors Reference
Connect your data and documents to the Bitcoin blockchain so anyone can verify their integrity and timestamp.
|
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
|
Name |
Summary |
|
Submit a hash |
|
|
GetProof ([internal][Optional]string code, string hash_id_node, string node_uri) |
Retrieve a proof |
|
VerifyProof ([internal][Optional]string code, VerifyProofParameterProof proof) |
Verify a proof |
|
SHA256FromString ([internal][Optional]string code, SHA256FromStringParameterData data) |
Generate a SHA256 Hash from a string |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Submit a hash
Description: Submit a hash to be anchored using Chainpoint
Syntax:
Chainpoint.SubmitHash ([internal][Optional]string code, string hash)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
code |
string
|
|
False |
|
|
hash |
string (Hash) |
The hex string Hash to be anchored |
True |
Returns:
Type:PostHashResponse
Summary: Retrieve a proof
Description: Retrieve a Chainpoint proof
Syntax:
Chainpoint.GetProof ([internal][Optional]string code, string hash_id_node, string node_uri)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
code |
string
|
|
False |
|
|
hash_id_node |
string (Hash ID) |
The Hash ID of the Proof to retrieve |
True |
|
|
node_uri |
string (Node URI) |
The Node URI from which to retrieve the Proof |
True |
Returns:
Type:GetProofResponse
Summary: Verify a proof
Description: Verify that a Chainpoint proof is valid
Syntax:
Chainpoint.VerifyProof ([internal][Optional]string code, VerifyProofParameterProof proof)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
code |
string
|
|
False |
|
|
proof |
|
|
True |
Returns:
Type:PostVerifyResponse
Summary: Generate a SHA256 Hash from a string
Description: Generate a SHA256 Hash for the given string
Syntax:
Chainpoint.SHA256FromString ([internal][Optional]string code, SHA256FromStringParameterData data)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
code |
string
|
|
False |
|
|
data |
|
|
True |
Returns:
Type:GenerateHashStringResponse
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
hash |
string Hash |
The SHA256 Hash of the string submitted |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
proof |
string Proof |
The Chainpoint Proof for a given Hash/Hash ID |
|
has_cal_anchor |
boolean Has Cal Anchor |
Boolean indicating if the Proof contains a Cal anchor |
|
has_btc_anchor |
boolean Has BTC Anchor |
Boolean indicating if the Proof contains a BTC anchor |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
hash_id_node |
string Hash ID |
The unique ID for the submitted Hash |
|
node_uri |
string Node URI |
The URI of the Node that received the Hash, Proofs must be retrieved from the same Node URI |
|
hash |
string Hash |
The Hash that was submitted |
|
cal_ready_at |
string(date-time) Cal Proof Ready Timestamp |
Timestamp offering an estimate when the Cal Proof will be ready for retrieval |
|
btc_ready_at |
string(date-time) BTC Proof Ready Timestamp |
Timestamp offering an estimate when the BTC Proof will be ready for retrieval |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
timestamp |
string(date-time) Timestamp |
The timestamp the Hash was submitted |
|
has_cal_anchor |
boolean Has Cal Anchor |
Boolean indicating if the Proof contains a Cal anchor |
|
has_btc_anchor |
boolean Has BTC Anchor |
Boolean indicating if the Proof contains a BTC anchor |
|
cal_anchor_is_valid |
boolean Cal Anchor Is Valid |
Boolean indicating if the Cal anchor is valid |
|
btc_anchor_is_valid |
boolean BTC Anchor Is Valid |
Boolean indicating if the BTC anchor is valid |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
data |
string Data |
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
proof |
Proof |
|
Summary: Proof
Description:
Properties:
|
Name |
Type |
Summary |