For Developers

XBRL validation as an API call

A REST API, official SDKs and webhooks for asynchronous results — so you can put XBRL validation inside your own product instead of alongside it.

Quick start

Authenticate, submit a file, poll or receive a webhook. That is the whole integration.

Terminal
curl -X POST https://api.xerify.io/v1/validations \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "[email protected]" \
  -F "profile=ESEF"

# Response
{
  "id": "val_abc123",
  "status": "completed",
  "summary": {
    "errors": 2,
    "warnings": 5,
    "info": 12
  },
  "issues": [...]
}

Built to integrate

Fast by default

Validation runs asynchronously on a dedicated worker pool, so large instances never block your request.

Predictable REST API

Versioned endpoints, consistent pagination and structured error objects — documented with an OpenAPI schema.

Webhooks

Real-time notifications when an asynchronous validation completes, with signed payloads you can verify.

Official SDKs

First-party Python and TypeScript SDKs, plus a CLI for scripting and CI pipelines.

SDKs and tooling

Install the client for your stack, or drive the API directly from the CLI.

🐍

Python

pip install xerify
💚

Node.js

npm install @xerify/sdk

Java

com.xerify:sdk:1.0.0
🐹

Go

go get xerify.io/sdk

What teams build with it

CI/CD validation gates

Fail a pipeline when a generated report stops validating, the same way you would fail it on a broken test.

RegTech products

Embed validation in your own platform without building and maintaining an XBRL engine in-house.

ERP and consolidation tools

Validate exported reports at the point they are produced, before they reach a filing team.

Start building

Get your API key and validate your first file in minutes.

We use cookies to improve your experience. Essential cookies are always active. Analytics cookies help us understand usage. Privacy Policy