# Getting Started

Welcome to the Revolutio API documentation. The Revolutio API provides programmatic access to corporate registry data across [**75+ jurisdictions worldwide**](/revolutio-api/data-coverage/corporate-registries.md).

## Base URL

```
https://api.revolutio.systems
```

## What you can do

| Capability             | Description                                                                           |
| ---------------------- | ------------------------------------------------------------------------------------- |
| **Company Search**     | Search government registries by company identifier in a specific jurisdiction         |
| ***IDFinder***         | AI-powered lookup of company registration numbers using a legal name and jurisdiction |
| **LEI Lookup**         | Retrieve Global Legal Entity Identifier (LEI) records                                 |
| **Case File**          | Retrieve a full case file containing all searches performed on an entity              |
| **Document Retrieval** | Download proof documents (PDFs) associated with entities                              |

## Authentication

All API endpoints (except `/authenticate`) require a Bearer token. See [Authentication](/revolutio-api/authentication.md) for details on obtaining a token.

## Quota System

Search and *IDFinder* operations consume credits from your account balance (`volume_remaining`). If a request fails due to a server-side error, the credit is automatically refunded.

When your balance reaches zero, the API returns `402 Payment Required`. Contact your account manager to top up.

## Rate Limiting

The API enforces rate limits to ensure fair usage:

* **Authentication:** 5 failed login attempts per email per hour results in a temporary lockout.
* **Search:** Per-user rate limiting is enforced on search operations.

## Jurisdiction Coverage

Your account has a list of subscribed jurisdictions. Searches are only permitted in jurisdictions included in your subscription.


---

# Agent Instructions: 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 current page URL with the `ask` query parameter:

```
GET https://equinoxe-systems.gitbook.io/revolutio-api/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.