> ## Documentation Index
> Fetch the complete documentation index at: https://docs.docyard.cc/llms.txt
> Use this file to discover all available pages before exploring further.

# Welcome to Docyard

> The lake for document distribution

# Welcome to Docyard

Docyard is a document distribution platform built around a simple idea: **a lake where anyone can drop artifacts, and anyone with the right keys can fish them out**.

## The Problem

High-value documents—insurance declarations, loan agreements, closing documents—are distributed through fragmented channels:

* Email attachments that get lost
* Portals that require separate logins per carrier
* FTP servers that are hard to maintain
* Custom integrations that are expensive to build

Each integration is unique. Each carrier has their own system. Each collector must maintain multiple connections.

## The Solution

**Docyard is the lake.**

One shared system where:

* **Distributors** upload documents through **upload endpoints**
* **Collectors** retrieve documents through **docks**
* **Lock-key-weight** controls access

No custom integrations. No per-carrier connections. Connect once, access all.

## Key Features

### Simple Access Control

Access is controlled by **keys** and **weights**:

* Distributors define which metadata fields (locks) are needed
* Distributors assign scores (weights) to each field
* Documents have a minimum score (threshold) for access
* Collectors present their keys → System calculates score → Access granted if score meets threshold

### No Pre-Relationships Required

Any collector can access any document:

* No invitation-only access
* No pre-authorization required
* If you have the right keys, you can retrieve the document
* Just like fishing in a public lake

### One Connection, All Documents

For collectors:

* Connect to your dock once
* Search across all distributors' documents
* Retrieve what you need

For distributors:

* Upload to your upload endpoint once
* Make documents available to all collectors
* No per-collector integrations

## How It Works

### For Distributors

```
1. Create artifact type templates (e.g., "Insurance Declaration")
2. Upload documents with metadata locks
3. Set weights and threshold
4. Documents are now in the lake
```

### For Collectors

```
1. Complete KYC verification
2. Declare which keys you have access to
3. Search the lake
4. Present keys → Retrieve documents
```

## Architecture

<details>
  <summary>👆 Click to expand: Docyard Architecture Diagram</summary>

  ```mermaid theme={null}
  flowchart TB
      subgraph LAKE["THE LAKE"]
          A1[Insurance Declaration]
          A2[Loan Agreement]
          A3[Birth Certificate]
          A4[Insurance Declaration]
      end

      subgraph DISTRIBUTORS["DISTRIBUTORS"]
          D1[Acme Insurance]
          D2[Best Insurance]
          D3[Government Agency]
      end

      subgraph COLLECTORS["COLLECTORS"]
          C1[FirstCity Bank]
          C2[Title Company]
          C3[Auditor]
      end

      D1 -->|Upload via Upload| A1
      D2 -->|Upload via Upload| A2
      D3 -->|Upload via Upload| A3
      D1 -->|Upload via Upload| A4

      C1 -->|Search via Dock| A1
      C1 -->|Search via Dock| A4
      C2 -->|Search via Dock| A2
      C3 -->|Search via Dock| A3

      style LAKE fill:#e1f5fe,stroke:#01579b
      style DISTRIBUTORS fill:#e8f5e9,stroke:#2e7d32
      style COLLECTORS fill:#fff3e0,stroke:#ef6c00
  ```
</details>

## How It Works

## Supported Document Types

Docyard is flexible enough to support any document type:

| Industry   | Document Examples                           |
| ---------- | ------------------------------------------- |
| Insurance  | Declaration pages, Endorsements, Renewals   |
| Mortgage   | Loan agreements, Closing disclosures, Deeds |
| Legal      | Contracts, Court documents                  |
| Healthcare | EOBs, Lab results                           |
| Government | Permits, Certificates                       |

## Getting Started

### Quick Start

1. **[Sign Up](/introduction/quickstart)** - Create your account
2. **Configure Your Upload or Dock** - Set up your upload or retrieval endpoint
3. **Start Using** - Upload or retrieve documents

### Learn More

* **[Core Concepts](/concepts/the-lake)** - Understand the lake model
* **\[Uploads & Docks]\(/concepts/upload endpoints-and-docks)** - Upload and retrieval endpoints
* **[Lock-Key-Weight](/concepts/lock-key-weight)** - Access control mechanism
* **[API Reference](/api-reference/overview)** - Technical documentation

## API Base URL

```
https://api.docyard.io/v1
```

## SDKs

Official SDKs coming soon:

* Node.js
* Python
* Go

## Support

* **Email**: [support@docyard.io](mailto:support@docyard.io)
* **Status**: status.docyard.io
* **Documentation**: docs.docyard.io