Saltar al contenido principal
Listar cuentas alias
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
}

Encabezados

​
Authorization
string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el plugin Access Manager.

​
X-Organization-Id
string
requerido

Identificador único de la organización asociada a la solicitud.

​
X-Lerian-Id
string
requerido

Identificador único del cliente de Lerian, generado y asignado por Lerian.

Parámetros de consulta

​
holder_id
string

ID único del titular.

​
metadata
string

Clave de metadata informada al crear la cuenta alias.

​
limit
integer
predeterminado:10

Número máximo de elementos a incluir en la respuesta.

​
page
integer
predeterminado:1

Número de página que deseas recuperar.

​
sort_order
enum<string>

Orden utilizado para clasificar los resultados.

Opciones disponibles:
asc,
desc
​
include_deleted
string

Si es true, también se incluirán las cuentas alias eliminadas lógicamente (soft delete).

​
account_id
string

Filtra cuentas alias vinculadas a un ID de cuenta específico.

​
ledger_id
string

Filtra cuentas alias vinculadas a un ID de libro contable específico.

​
document
string

Filtra cuentas alias por número de documento.

​
banking_details_branch
string

Filtra cuentas alias por sucursal bancaria.

​
banking_details_account
string

Filtra cuentas alias por número de cuenta bancaria.

​
banking_details_iban
string

Filtra cuentas alias por IBAN bancario.

Respuesta

​
items
object[]
requerido

Lista de resultados devueltos.

​
page
integer
predeterminado:1
requerido

Número de página devuelto.

​
limit
integer
predeterminado:10
requerido

Número máximo de elementos a incluir en la respuesta.