Quickstart

Get started with verification and notarization in minutes

Implement Verification

Get up and running with Aqua Protocol’s verification system in three simple steps. This guide will walk you through setting up your environment, creating your first verification, and integrating with our API.

This quickstart assumes you have basic knowledge of blockchain concepts and JavaScript/TypeScript. If you’re new to verification systems, check out our Core Concepts guide first.

Step 1: Set Up Your Environment

Install the SDK

Install the Aqua Protocol SDK for verification and notarization:

npm

npm install @aqua-protocol/verifier

The SDK includes TypeScript definitions and comprehensive verification tools.

Get your API credentials

1. Sign up for a free account at app.aqua-protocol.org
2. Navigate to the API Keys section in your dashboard
3. Generate a new API key for verification services
4. Copy your API key and verification endpoint

Keep your API key secure and never commit it to version control. Use environment variables in production.

Step 2: Create Your First Verification

Define verification schema

Create a verification schema for document notarization:

schema.json

{
  "type": "object",
  "properties": {
    "documentId": {
      "type": "string",
      "description": "Unique document identifier"
    },
    "hash": {
      "type": "string",
      "description": "SHA-256 hash of document content"
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "signer": {
      "type": "string",
      "description": "Public key of document signer"
    }
  },
  "required": ["documentId", "hash", "timestamp", "signer"]
}

This schema defines the structure for document verification and notarization.

Implement verification

Create and verify a document using the Aqua Protocol SDK:

verify.js

import { AquaVerifier } from '@aqua-protocol/verifier';
import crypto from 'crypto';

const verifier = new AquaVerifier({
  apiKey: process.env.AQUA_API_KEY,
  endpoint: 'https://api.aqua-protocol.org/v3'
});

// Create document hash
const documentContent = 'Important document content';
const documentHash = crypto.createHash('sha256')
  .update(documentContent)
  .digest('hex');

// Create verification
const verification = await verifier.createVerification({
  documentId: 'doc-123',
  hash: documentHash,
  timestamp: new Date().toISOString(),
  signer: '0x742d35Cc6634C0532925a3b8D4C9db96C4b4d8b6'
});

console.log('Verification created:', verification.id);
console.log('Transaction hash:', verification.txHash);

Your document is now verified and notarized on the blockchain!

Step 3: Query Verification Status

Check verification status

Query your verification to confirm its status and details:

query.js

// Get verification details
const verification = await verifier.getVerification(verification.id);

console.log('Verification Status:', verification.status);
console.log('Document ID:', verification.documentId);
console.log('Created At:', verification.createdAt);
console.log('Block Number:', verification.blockNumber);

Verify document integrity

Verify that a document matches its notarized hash:

validate.js

// Verify document against notarized hash
const isValid = await verifier.validateDocument({
  documentId: 'doc-123',
  content: documentContent,
  expectedHash: verification.hash
});

if (isValid) {
  console.log('Document integrity verified');
} else {
  console.log('Document has been modified');
}

Always verify document integrity before trusting verification results in production applications.

Next Steps

Congratulations! You’ve successfully implemented verification and notarization with Aqua Protocol. Here’s what you can explore next:

Schema Reference

Explore comprehensive schema definitions for advanced verification patterns.

Verifier Tests

Learn about automated testing and validation frameworks.

Security & Identity

Implement advanced identity management and security features.

Use Cases

Discover real-world applications and implementation patterns.

What’s Next?

1. Explore Advanced Features

   Check out our Schema Reference for detailed verification schemas and API specifications.

2. Join the Community

   Connect with other developers in our Discord community for support and collaboration.

3. Build Secure Applications

   Use Aqua Protocol to build secure, verifiable applications. We can’t wait to see what you create!

Ready for production? Upgrade to our Pro plan for higher rate limits, priority support, and advanced verification features. Learn more.