> For the complete documentation index, see [llms.txt](https://docs.zwapgrid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zwapgrid.com/readme.md).

# Overview

Zwapgrid makes getting Your Customer's data simple and secure. Ditch the endless integrations. Just connect once, invite Your Customer, and seamlessly access the data you need.

Zwapgrid is a platform for accessing Your Customer's accounting data through one integration.

**New to Zwapgrid?** Start here: (1) Overview (this page), (2) [Terminology](/key-concepts/terminology.md), (3) [How the platform works](/get-started/how-the-platform-works.md), (4) [Get Started overview](/get-started/get-started.md), (5) [Onboard Your Customer](/get-started/onboard-your-customer.md), (6) [Access Your Customer Data](/get-started/access-your-customer-data.md).

It combines a unified API, a consent-driven onboarding flow, and a file ingestion service. You ship your product. We handle the system-by-system complexity behind the scenes.

### What is API.1?

API.1 is the single connection point for reading data from many accounting systems.

You integrate once. Your Customer connects their system during onboarding. You then fetch data in a consistent format.

### Why Zwapgrid + API.1 works well

* **One integration, many systems.** Avoid building and maintaining one-off connectors.
* **Unified schema.** API.1 normalizes system differences into one data model.
* **Less operational burden.** We handle auth flows, token refresh, and connector upkeep.
* **Customer-friendly onboarding.** Customers grant access in a guided, branded flow.
* **API-first with a file fallback.** If there is no API, use [File.1](/file-1/file-1.md) for uploads and parsing.
* **Built for controlled access.** Data access is consent-based and auditable by design.
* **Security-focused defaults.** See [API Security](/security/api-security.md) for specifics.

### What you get (building blocks)

* **Consent API** to create and manage customer consent.
* **Onboarding Flow** for Your Customer to connect their Accounting System.
* **Accounting API** to fetch normalized data after consent is granted.
* **File.1** – Use when there is no API for the system or you need to ingest files (e.g. PDF invoices). See [File.1 overview](/file-1/file-1.md).
* **Proxy.1** – Use when you need to call the underlying accounting system's API directly through Zwapgrid (same auth, normalized base URL). See [Proxy.1 overview](/proxy.1/proxy.1.md).
* **Client Portal** to manage environments and API keys.

<figure><img src="https://2802285108-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQCvVWgo58AdpQJMipzpD%2Fuploads%2FESx11Y3EckJ3D08lLbnF%2Fflow.1.png?alt=media&amp;token=1a61edbf-e689-4dff-bd9b-f061b377760d" alt=""><figcaption><p>End-to-end flow: consent, onboarding, and data access.</p></figcaption></figure>

### End-to-end flow

1. Create a consent in the Consent API.
2. Invite Your Customer to the Onboarding Flow.
3. Your Customer connects their accounting system (or uploads files).
4. Poll the Accounting API to retrieve Your Customer’s data.

For the practical steps, start here:

* [Get Started overview](/get-started/get-started.md)
* [Onboard Your Customer](/get-started/onboard-your-customer.md)
* [Access Your Customer Data](/get-started/access-your-customer-data.md)

### Technical model (at a glance)

API.1 is split into two APIs:

* **Consent API** for consent lifecycle and status.
* **Accounting API** for reading data from connected systems.

Use the **Consent API** to create consents and generate One-Time Codes; use the **Accounting API** (with that Consent ID in the path) to read invoices, company information, and other accounting data.

Operationally, API.1 is designed for polling-based data retrieval. It also supports traceability via correlation IDs.

Next reads:

* [API.1 overview](/api.1/api.1.md)
* [API Keys](/client-portal/api-keys.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zwapgrid.com/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `build a script that syncs our docs to a CMS` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.