Documentation

Learn how to integrate with Harbour's API, understand core concepts, and access our resources.

Quickstart

Annotating Documents

Learn how to add annotations to documents using Harbour's API. This guide shows you how to use the document annotation endpoint to add comments, highlights, and other markup to your documents.

Using Python

import requests
import json

def annotate_document(document_id, api_key, annotations):
    url = f"https://api.myharbourshare.com/v2/documents/{document_id}/annotate"
    
    headers = {
        "x-api-key": api_key,
        "Content-Type": "application/json"
    }
    
    response = requests.post(url, headers=headers, json=annotations)
    return response.json()

# Example usage
api_key = "your_api_key"
document_id = "doc_abc123"

annotations = {
    "fields_values": [
        {
          "id": "agreementinput-1",
          "value": "John Doe"
        },
        {
          "id": "agreementinput-2",
          "value": "2024-01-01"
        }
    ]
}

result = annotate_document(document_id, api_key, annotations)
print(result)

Using Node.js

const axios = require('axios');

async function annotateDocument(documentId, apiKey, annotations) {
  const url = `https://api.myharbourshare.com/v2/documents/${documentId}/annotate`;
  
  const headers = {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  };
  
  try {
    const response = await axios.post(url, annotations, { headers });
    return response.data;
  } catch (error) {
    console.error('Error annotating document:', error.response.data);
    throw error;
  }
}

// Example usage
const apiKey = 'your_api_key';
const documentId = 'doc_abc123';

const annotations = {
  field_values: [
    {
      "id": "agreementinput-1",
      "value": "John Doe"
    },
    {
      "id": "agreementinput-2",
      "value": "2024-01-01"
    }
  ]
};

annotateDocument(documentId, apiKey, annotations)
  .then(result => console.log(result))
  .catch(error => console.error(error));

Resources

Security

Harbour takes a comprehensive approach to security, ensuring your data and documents are protected at every level. Here's what you need to know about our security practices when using our API.

API Security Best Practices

Authentication & Authorization

• All API requests must use API keys for authentication
• Keys must be transmitted securely via the x-api-key header
• Each API key has specific permissions and rate limits
• API keys should never be exposed in client-side code or public repositories

Data Protection

• All API communications are encrypted using TLS 1.3
• Documents are encrypted at rest using AES-256
• Each document has unique encryption keys
• Access controls are enforced at the document level

Compliance & Certifications

Harbour maintains industry-standard security certifications:

• SOC 2 Type II certified ✅
• GDPR compliant ✅
• Regular third-party security audits ✅
• Annual penetration testing ✅

Security Documentation

The following documents are available upon request:

• Security whitepaper
• Compliance certificates
• Penetration test reports
• Data processing agreements

Contact security@harbourshare.com for security documentation or to discuss specific security requirements.

Vulnerability Reporting

If you discover a security vulnerability, please report it responsibly:

1. Email security@harbourshare.com
2. Include detailed vulnerability information
3. Allow up to 24 hours for initial response
4. Do not disclose the vulnerability publicly before it has been addressed

Harbour takes all security reports seriously and will work quickly to address any identified issues.