# Overview

#### Authentication [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#authentication" id="authentication"></a>

Authentication is done using [JSON Web Token ↗](https://jwt.io/) standard. Once token is obtained, it must be attached to requests headers:

text

```
Authorization: Bearer <token>
```

For a detailed walkthrough on how to authenticate, see dedicated page Authentication.

#### Authorization [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#authorization" id="authorization"></a>

Access rights & permissions for the current user are retrieved from the Vault orchestration layer. Check [User roles and permissions ↗](https://ledger-enterprise-help-center.redoc.ly/developer-portal/content/overview/rolespermissions) on Vault Help Center.

### Endpoints structure [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#endpoints-structure" id="endpoints-structure"></a>

#### Base URL [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#base-url" id="base-url"></a>

Here is the base URL that will be used as `$BASE_URL` in all the documentation pages:

```
https://re.vault.ledger.com/v1/rest
```

#### Requests headers [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#requests-headers" id="requests-headers"></a>

All the requests are expecting JSON response, and should have this header:

```
Content-Type: application/json
```

### Data validation [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#data-validation" id="data-validation"></a>

All the query params (for `GET` requests) and request payloads (for `POST`, `PUT` requests) are strictly validated against the expected schema (see API reference).

If the match isn't successful, API will answer with `HTTP 400` status, with an error detailing what is wrong.

### Pagination and filtering [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#pagination-and-filtering" id="pagination-and-filtering"></a>

#### Page-based pagination [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#page-based-pagination" id="page-based-pagination"></a>

For most of the endpoints that returns *multiple* items of the same type, data will be paginated following this structure:

ts

```
type Paginated<T> = {
  // the current page
  page: number;
  // the next page (or null if there is none)
  next: number | null;
  // the previous page (or null if there is none)
  prev: number | null;
  // the max count of items per page
  pageSize: number;
  // the total count of items
  total: number;
  // the page data
  results: T[];
};
```

Other pages can be fetched on the same endpoint with `?page=<number>`.

#### Cursor-based pagination [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#cursor-based-pagination" id="cursor-based-pagination"></a>

For some endpoints where the data is fetched from external sources (e.g: list of transactions), a cursor-based pagination is used, allowing you to discover the data page-by-page.

ts

```
type CursorPaginated<T> = {
  // cursor for next page (or null if there is none)
  next: string | null;
  // the page data
  results: T[];
};
```

Next page can be fetched on the same endpoint with `?cursor=<string>`.

#### Filtering [​](broken://pages/d6cIOcqB0iqx5NaY5YnF) <a href="#filtering" id="filtering"></a>

The search filters (and sort parameters) are retrieved from query params. You'll find the supported parameters on the dedicated endpoint reference pages (see Reference).


---

# 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://help.enterprise.ledger.com/api-documentation-v2/introduction/overview.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.