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

# SpherePay OpenAPI 3.0 Specification Download

> Download the SpherePay OpenAPI 3.0 specification to generate API clients, import into Postman or Insomnia, or build custom tooling and integrations.

The SpherePay API is documented as an OpenAPI 3.0 specification. The spec is the source of truth for every endpoint, request schema, response schema, and error code — drop it into your favorite tool to generate clients, import collections, or feed it to your own internal services.

<Card title="Download the OpenAPI spec" icon="file-down" href="/openapi/spherepay.yaml" horizontal>
  <code>spherepay.yaml</code> — OpenAPI 3.0, \~470 KB. The file is served directly from the docs site and reflects the latest published API surface.
</Card>

## What's in the spec

* Every public endpoint under `/v2/` — customers, transfers, bank accounts, wallets, virtual accounts (Onramper Accounts), offloader wallets, business representatives, documents, enhanced-due-diligence.
* Full request and response schemas for each endpoint, including discriminated unions for currency-specific bank-account shapes (USD vs. EUR vs. BRL).
* Standard error envelopes and status-code mappings.
* Examples for the most common request bodies.

## Common uses

<CardGroup cols={2}>
  <Card title="Generate an API client" icon="code">
    Feed the YAML into [openapi-generator](https://github.com/OpenAPITools/openapi-generator) or [Speakeasy](https://www.speakeasy.com/) to produce a typed SDK in TypeScript, Python, Go, Java, Ruby, and others.
  </Card>

  <Card title="Import into Postman or Insomnia" icon="bolt">
    Postman → **Import** → drop the file. You'll get a collection seeded with every endpoint, ready to authenticate with your API key.
  </Card>

  <Card title="Validate requests in CI" icon="circle-check">
    Use [Spectral](https://stoplight.io/open-source/spectral) or any OpenAPI-aware linter to validate your application's request payloads against the spec before they hit production.
  </Card>

  <Card title="Mock the API locally" icon="server">
    Tools like [Prism](https://stoplight.io/open-source/prism) spin up a local mock server from the spec, so you can develop against SpherePay's contract without burning sandbox traffic.
  </Card>
</CardGroup>

## Versioning

The spec tracks the **live `/v2/` API**. Breaking changes are announced in [Release notes](/changelog) before the spec changes; deprecated fields are kept in the spec with `deprecated: true` until removal.

If you need to pin against a specific historical version of the spec, check Git history on this file in the docs repository.

## Issues with the spec

If a field, type, or example doesn't match what you see when calling the API, that's a bug — reach out at [support@spherepay.co](mailto:support@spherepay.co) with the endpoint and a request/response sample and we'll fix the spec.