OpenAPI 3.1

The full Proveium API spec

Every endpoint, every schema, every error code — described in OpenAPI 3.1. Browse interactively, generate clients, or import into your favourite tooling.

The spec is the source of truth for all Proveium SDKs. If the SDK does it, the spec describes it.

Browse interactive docs Download YAML

Three ways to access the spec

Browse interactive docs

Explore every endpoint, request body, and response schema in a searchable UI. Try requests live with your sandbox key.

Open interactive docs

Download spec (YAML)

Download the full OpenAPI 3.1 YAML file. Use it to generate typed clients, validate your integration, or keep a local copy.

Download openapi.yaml

Open in Postman

Import the collection directly into Postman. Pre-configured environments for sandbox and production. All requests templated.

Import Postman collection

What's in the spec

OpenAPI 3.1 — compatible with all major tooling

JSON Schema 2020-12 for all request and response models

Comprehensive error codes — no generic 400s

Webhook payload schemas included

Example values on every field

Tagged by resource for easy navigation

Code generation

Generate a typed client for any language

Use any OpenAPI-compatible code generator with our spec. Below are recommended tools for common languages.

TypeScriptvia openapi-typescript

npx openapi-typescript https://api.proveium.io/openapi.yaml -o ./types/proveium.d.ts

Pythonvia openapi-python-client

openapi-python-client generate --url https://api.proveium.io/openapi.yaml

Govia oapi-codegen

oapi-codegen -package proveium openapi.yaml > proveium.go

Anyvia openapi-generator-cli

openapi-generator-cli generate -i openapi.yaml -g <language> -o ./client

Or use any OpenAPI-compatible tool. The spec is plain YAML with no proprietary extensions.

Ready to integrate?

Get sandbox keys, explore the interactive docs, and make your first verification request in under an hour.

Get sandbox keys Browse SDKs