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

# API Introduction

> Introduction to the ABBYY Vantage REST APIs for intelligent document processing: Processing and Reporting APIs, OAuth 2.0 authentication, and base URLs.

export const VantageRegion = ({children}) => {
  const STORAGE_KEY = "abbyy.vantage.region";
  const REGIONS = [{
    code: "eu",
    label: "Europe"
  }, {
    code: "us",
    label: "North America"
  }, {
    code: "au",
    label: "Australia / Asia-Pacific"
  }];
  const [region, setRegion] = useState("eu");
  const [open, setOpen] = useState(false);
  const containerRef = useRef(null);
  const dropdownRef = useRef(null);
  function safeGetSavedRegion() {
    try {
      const saved = typeof window !== "undefined" ? window.localStorage.getItem(STORAGE_KEY) : null;
      const valid = new Set(REGIONS.map(r => r.code));
      return saved && valid.has(saved) ? saved : "eu";
    } catch {
      return "eu";
    }
  }
  function safeSetSavedRegion(code) {
    try {
      if (typeof window !== "undefined") {
        window.localStorage.setItem(STORAGE_KEY, code);
      }
    } catch {}
  }
  function dispatchRegionChanged(code) {
    try {
      if (typeof window !== "undefined") {
        window.dispatchEvent(new CustomEvent("abbyy:region-changed", {
          detail: {
            code
          }
        }));
      }
    } catch {}
  }
  function replaceRegionInString(text, currentRegion) {
    if (typeof text !== "string") return text;
    const hostRegex = /https:\/\/vantage-(eu|us|au)\.abbyy\.com/gi;
    const tokenRegex = /https:\/\/vantage-\[region\]\.abbyy\.com/gi;
    return text.replace(hostRegex, `https://vantage-${currentRegion}.abbyy.com`).replace(tokenRegex, `https://vantage-${currentRegion}.abbyy.com`);
  }
  useEffect(() => {
    setRegion(safeGetSavedRegion());
  }, []);
  useEffect(() => {
    const root = containerRef.current;
    if (!root) return;
    const anchors = root.querySelectorAll("a[href]");
    anchors.forEach(a => {
      const href = a.getAttribute("href");
      if (href) {
        const next = replaceRegionInString(href, region);
        if (next !== href) {
          a.setAttribute("href", next);
        }
      }
    });
    const walker = typeof document !== "undefined" ? document.createTreeWalker(root, NodeFilter.SHOW_TEXT, null) : null;
    if (walker) {
      const toUpdate = [];
      let node = walker.nextNode();
      while (node) {
        const updated = replaceRegionInString(node.nodeValue, region);
        if (updated !== node.nodeValue) {
          toUpdate.push([node, updated]);
        }
        node = walker.nextNode();
      }
      toUpdate.forEach(([textNode, value]) => {
        textNode.nodeValue = value;
      });
    }
  }, [region, children]);
  useEffect(() => {
    const root = containerRef.current;
    if (!root) return;
    const anchors = root.querySelectorAll("a[href]");
    anchors.forEach(a => {
      a.style.fontWeight = "600";
      a.style.textDecoration = "underline";
      a.style.textUnderlineOffset = "2px";
    });
  }, [region, children]);
  useEffect(() => {
    const onRegionChanged = evt => {
      const code = evt && evt.detail && evt.detail.code;
      if (!code || code === region) return;
      setRegion(code);
    };
    if (typeof window !== "undefined") {
      window.addEventListener("abbyy:region-changed", onRegionChanged);
    }
    return () => {
      if (typeof window !== "undefined") {
        window.removeEventListener("abbyy:region-changed", onRegionChanged);
      }
    };
  }, [region]);
  useEffect(() => {
    const onClickAway = e => {
      if (!dropdownRef.current) return;
      if (!dropdownRef.current.contains(e.target)) {
        setOpen(false);
      }
    };
    document.addEventListener("click", onClickAway, true);
    return () => document.removeEventListener("click", onClickAway, true);
  }, []);
  const onSelect = code => {
    setRegion(code);
    safeSetSavedRegion(code);
    dispatchRegionChanged(code);
    setOpen(false);
  };
  const current = REGIONS.find(r => r.code === region) || REGIONS[0];
  return <div className="not-prose">
      <div className="mb-4 inline-flex items-center gap-2" ref={dropdownRef}>
        <span className="text-sm text-zinc-950/80 dark:text-white/80">Tenant Region:</span>
        <div className="relative">
          <button type="button" aria-haspopup="listbox" aria-expanded={open ? "true" : "false"} onClick={() => setOpen(v => !v)} className="h-8 px-3 rounded-md bg-zinc-900/5 dark:bg-white/5 border border-zinc-950/20 dark:border-white/20 text-sm inline-flex items-center gap-2">
            <span className="text-zinc-950 dark:text-white">{current.label}</span>
            <svg width="8" height="24" viewBox="0 -9 3 24" className="transition-transform text-gray-400 overflow-visible dark:text-gray-600 ml-auto" style={{
    transform: open ? "rotate(270deg)" : "rotate(90deg)"
  }}>
              <path d="M0 0L3 3L0 6" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round"></path>
            </svg>
          </button>
          {open ? <div role="listbox" className="absolute z-50 left-full top-0 ml-2 w-56 rounded-xl border border-zinc-950/20 dark:border-white/20 bg-white dark:bg-zinc-900 shadow-lg p-2">
              {REGIONS.map(r => {
    const selected = r.code === region;
    return <button key={r.code} type="button" role="option" aria-selected={selected ? "true" : "false"} onClick={() => onSelect(r.code)} className={"w-full flex items-center justify-between px-3 py-2 rounded-lg text-sm hover:bg-zinc-950/5 dark:hover:bg-white/10 text-zinc-950 dark:text-white" + (selected ? " font-medium" : "")}>
                    <span style={selected ? {
      color: "#ff2038"
    } : undefined}>{r.label}</span>
                    <span className={selected ? "ml-3" : "ml-3 invisible"} style={selected ? {
      color: "#ff2038"
    } : undefined}>✓</span>
                  </button>;
  })}
            </div> : null}
        </div>
      </div>
      <div ref={containerRef} className="prose dark:prose-invert max-w-none">{children}</div>
    </div>;
};

The ABBYY Vantage platform provides two REST APIs for integrating intelligent document processing into your applications:

<CardGroup cols={2}>
  <Card title="Processing API" icon="gears" href="#processing-api">
    Submit documents, manage transactions, and retrieve extracted data
  </Card>

  <Card title="Reporting API" icon="chart-line" href="#reporting-api">
    Access analytics and business reporting data
  </Card>
</CardGroup>

## Base URL

All API requests are made to the Vantage production server:

<VantageRegion>
  ```
  https://vantage-us.abbyy.com
  ```
</VantageRegion>

## Authentication

The Vantage API uses **OAuth 2.0** for authentication. Every request must include an access token in the Authorization header:

```bash theme={null}
Authorization: Bearer {your_access_token}
```

Vantage supports three authentication flows:

| Flow                                                                                                         | Best For                         |
| ------------------------------------------------------------------------------------------------------------ | -------------------------------- |
| [Resource Owner Password Credentials](/vantage/developer/authentication/resource-owner-password-credentials) | Server-to-server integrations    |
| [Authorization Code Flow](/vantage/developer/authentication/authorization-code-flow)                         | User-facing applications         |
| [Client Credentials](/vantage/developer/authentication/client-credentials)                                   | Machine-to-machine communication |

<Note>
  [Contact ABBYY](https://www.abbyy.com/company/contact-us/) to request a tenant in ABBYY Vantage. Once you have a tenant account, you can create user accounts and API clients for authentication.
</Note>

## Processing API

The Processing API (`/api/publicapi/v1/`) enables you to:

* **Create transactions** — Submit documents for processing with a specific skill
* **Manage files** — Upload, edit, and organize document images
* **Track status** — Monitor transaction progress and handle errors
* **Retrieve results** — Download extracted data in JSON or XML format
* **Manage catalogs** — Work with data catalogs and lookup tables

### Common Workflows

<AccordionGroup>
  <Accordion title="Single API Call Processing">
    Process documents with a single request that handles upload, processing, and result retrieval automatically.

    [Learn more →](/vantage/developer/processing-documents/processing-documents-single-api)
  </Accordion>

  <Accordion title="Multi-Step Processing">
    Use separate API calls for fine-grained control over document upload, processing, and result retrieval.

    [Learn more →](/vantage/developer/processing-documents/processing-documents-with-separate-api-calls)
  </Accordion>

  <Accordion title="Human-in-the-Loop">
    Integrate manual review into your workflow for documents requiring human verification.

    [Learn more →](/vantage/developer/integrating-manual-review)
  </Accordion>
</AccordionGroup>

## Reporting API

The Reporting API (`/api/reporting/v2/`) provides access to:

* **Business metrics** — Transaction volumes, processing times, and throughput
* **Quality analytics** — Extraction accuracy and confidence scores
* **Field-level data** — Detailed extraction results for analysis

[Learn more about Reporting →](/vantage/developer/reporting/reporting-service)

## Output Formats

Vantage returns extracted data in structured formats:

<CardGroup cols={2}>
  <Card title="JSON Output" icon="brackets-curly" href="/vantage/developer/output/json/json-output">
    Hierarchical data with full extraction details and confidence scores
  </Card>

  <Card title="XML Output" icon="code" href="/vantage/developer/output/xml/xml-output">
    Structured markup for systems requiring XML integration
  </Card>
</CardGroup>

## Developer Resources

<CardGroup cols={2}>
  <Card title="Developer Guide" icon="book" href="/vantage/developer/getting-started">
    Start here — make your first call, authenticate, and choose a processing scenario
  </Card>

  <Card title="Postman Collection" icon="rocket" href="/vantage/developer/postman-collection/overview">
    Ready-to-use API collection for testing and exploration
  </Card>
</CardGroup>

## Rate Limits & Best Practices

* **Batch operations** — Use batch endpoints when processing multiple records (up to 5,000 catalog records per request)
* **Polling** — When checking transaction status, use reasonable intervals (5-10 seconds)
* **Error handling** — Implement retry logic with exponential backoff for transient errors

## Next Steps

<Steps>
  <Step title="Set Up Authentication">
    [Configure OAuth 2.0](/vantage/developer/authentication/authentication) for your application
  </Step>

  <Step title="Process Your First Document">
    Follow the [processing guide](/vantage/developer/processing-documents/processing-documents) to submit a document
  </Step>

  <Step title="Explore the API">
    Browse the full [Processing API](/vantage/developer/processing-documents/processing-documents) and [Reporting API](/vantage/developer/reporting/reporting-service) references
  </Step>
</Steps>