Revolutio API

Welcome to the Revolutio API documentation. The Revolutio API provides programmatic access to live corporate registry data from official government sources across 100+ jurisdictions (112 certified sources).

Base URL

https://api.revolutio.systems

All paths in this documentation are relative to that host unless noted otherwise.

What you can do

Capability	Description
Company Search	Search official registries by registration number (or legal name where supported)
Expand Search	Run a follow-on registry search on a counterparty already on a case (ownership tree)
IDFinder	AI-powered resolution of registration numbers from a legal name + jurisdiction
LEI Lookup	Attach a GLEIF Legal Entity Identifier to a case target
Case File	Retrieve a case (target entity graph + search summaries)
Document Retrieval	Download proof documents (PDFs) associated with entities
Financials	Opt-in financial statement metrics on search / expand (include.financials)

Typical integration flow

1. Authenticate          → Bearer ID token  or  X-API-Key
2. (optional) IDFinder   → registration number from legal name
3. POST /search          → caseId + searchId (status PENDING)
4. GET  /search/{id}/status  → poll until COMPLETED | FAILED
5. GET  /casefile/{caseId}   → case graph + search summaries
6. GET  /document/{id}       → proof PDF (redirect or JSON URL)
7. (optional) POST /search/expand  → ownership layer under a counterparty

Authentication

Every endpoint except POST /authenticate requires credentials. Revolutio supports two independent methods:

Method	Header	Value
API key (recommended for server integrations)	X-API-Key	rev_<keyId>.<secret>
Firebase ID token	Authorization	Bearer <idToken>

API keys must be sent in X-API-Key, not in Authorization. See Authentication.

Credits (quota)

Search, expand, IDFinder, and optional financials consume credits from your account balance (volume_remaining).

• Search / expand debit the jurisdiction cost up front (base cost plus any mandatory source surcharge). On failure the base debit is refunded.
• Financials (include.financials) are charged after success only when numeric financials are returned.
• IDFinder is charged up front and refunded when no verified match is returned.
• LEI is charged only when an LEI is successfully attached (cost may be zero depending on plan/config).

When the balance is insufficient, the API returns 402 Payment Required. Contact your account manager to top up.

Exact costs vary by jurisdiction. See Data Coverage.

Rate limiting

• Authentication: 5 failed logins per email per hour → temporary lockout (429).
• Search / expand: per-user rate limiting (429 Rate limit exceeded).

Jurisdiction coverage

Your account is limited to jurisdictions in coverage_subscribed. Searches outside that list return 403. See Data Coverage for supported codes and typical credit costs.