Skip to main content
List Alias Accounts
curl --request GET \
  --url http://127.0.0.1:4003/v1/aliases \
  --header 'X-Lerian-Id: <x-lerian-id>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "items": [
    {
      "id": "01951ad1-9f62-793a-9095-fe7701f94434",
      "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
      "document": "08912345965",
      "ledgerId": "77b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
      "accountId": "0194fa41-5333-77c7-91fe-309fb4618155",
      "metadata": {
        "key": "value"
      },
      "bankingDetails": {
        "branch": "0001",
        "account": "123450",
        "type": "CACC",
        "openingDate": "2010-01-01",
        "iban": "US12345678901234567890",
        "countryCode": "US",
        "bankId": "12345"
      },
      "createdAt": "2024-12-17T14:34:09.191705548Z",
      "updatedAt": "2024-12-17T14:34:09.191705648Z",
      "deletedAt": null
    },
    {
      "id": "01951ad1-9f62-793a-9095-fe7701f94434",
      "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
      "document": "08912345965",
      "ledgerId": "77b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
      "accountId": "0194fa41-5333-77c7-91fe-309fb4618155",
      "metadata": {
        "key": "value"
      },
      "bankingDetails": {
        "branch": "0001",
        "account": "123450",
        "type": "CACC",
        "openingDate": "2010-01-01",
        "iban": "US12345678901234567890",
        "countryCode": "US",
        "bankId": "12345"
      },
      "createdAt": "2024-12-17T14:34:09.191705548Z",
      "updatedAt": "2024-12-17T14:34:09.191705648Z",
      "deletedAt": "2024-12-17T14:34:09.191705648Z"
    }
  ],
  "page": 1,
  "limit": 10
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager plugin enabled.

​
X-Organization-Id
string
required

The unique identifier of the Organization associated with the request.

​
X-Lerian-Id
string
required

The unique identifier of Lerian's client, generated and assigned by Lerian.

Query Parameters

​
holder_id
string

Unique ID of the holder.

​
metadata
string

The metadata key provided when the Alias Account was created.

​
limit
integer
default:10

The maximum number of items to include in the response.

​
page
integer
default:1

The number of the page that you want to retrieve.

​
sort_order
enum<string>

The order used to sort the results.

Available options:
asc,
desc
​
include_deleted
string

If true, the Alias Accounts that were logically deleted (soft deleted) will also be included.

​
account_id
string

Filters Alias Accounts linked to a specific account ID.

​
ledger_id
string

Filters Alias Accounts linked to a specific ledger ID.

​
document
string

Filters Alias Accounts by document number.

​
banking_details_branch
string

Filters Alias Accounts by bank branch.

​
banking_details_account
string

Filters Alias Accounts by bank account.

​
banking_details_iban
string

Filters Alias Accounts by bank IBAN.

Response

​
items
object[]
required

List of returned results.

​
page
integer
default:1
required

The number of the page returned.

​
limit
integer
default:10
required

The maximum number of items to include in the response.