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

# ArchiveOrder API

> API documentation for creating and managing archival document retrieval orders.

The ArchiveOrder API lets professional genealogy platforms, research firms, and archival services submit document retrieval orders to GenealogyDirect's fulfillment network.

Use the API to create orders, review researcher offers, initiate payments, exchange order messages, retrieve delivered documents, audit order events, and subscribe to webhook notifications.

## Base URLs

| Environment | Base URL                           |
| ----------- | ---------------------------------- |
| Production  | `https://api.archiveorder.com`     |
| Development | `https://api-dev.archiveorder.com` |

## Core workflow

<Steps>
  <Step title="Create an order">
    Submit the repository, document type, jurisdiction, people of interest, and fulfillment instructions.
  </Step>

  <Step title="Review offers">
    Researchers can submit offers with price, currency, message, and estimated completion information.
  </Step>

  <Step title="Select and pay">
    Select an offer, initiate payment, and finalize the accepted payment intent.
  </Step>

  <Step title="Track fulfillment">
    Read messages, status changes, events, and delivered documents.
  </Step>

  <Step title="Receive webhooks">
    Register HTTPS webhook endpoints to receive order event deliveries.
  </Step>
</Steps>

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/docs/getting-started/quickstart">
    Create your first ArchiveOrder with curl.
  </Card>

  <Card title="Authentication" icon="key" href="/docs/getting-started/authentication">
    Learn how API keys and scopes work.
  </Card>

  <Card title="Order lifecycle" icon="timeline" href="/docs/guides/order-lifecycle">
    Understand public order statuses.
  </Card>

  <Card title="OpenAPI" icon="file-code" href="/docs/reference/openapi">
    Download or inspect the OpenAPI 3.1 document.
  </Card>
</CardGroup>

<Note>
  Access to the API requires a scoped API key issued by GenealogyDirect. Contact support if you need a sandbox key or production credentials.
</Note>