Pular para o conteúdo principal
GET
/
v1
/
aliases
Listar Contas Alias
curl --request GET \
  --url https://crm.sandbox.lerian.net/v1/aliases \
  --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",
      "bankingDetails": {
        "branch": "0001",
        "account": "123450",
        "type": "CACC",
        "openingDate": "2010-01-01",
        "iban": "US12345678901234567890",
        "countryCode": "US",
        "bankId": "12345"
      },
      "relatedParties": [
        {
          "id": "01951ad2-1234-5678-9abc-def012345678",
          "document": "91315026015",
          "name": "John Doe",
          "role": "PRIMARY_HOLDER",
          "startDate": "2024-01-01"
        }
      ],
      "regulatoryFields": {
        "participantDocument": "00000000000191"
      },
      "metadata": {
        "key": "value"
      },
      "createdAt": "2024-12-17T14:34:09.191705548Z",
      "updatedAt": "2024-12-17T14:34:09.191705648Z",
      "deletedAt": null
    },
    {
      "id": "01951ad2-abcd-ef01-2345-67890abcdef0",
      "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
      "document": "08912345965",
      "ledgerId": "77b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
      "accountId": "0194fa41-5333-77c7-91fe-309fb4618156",
      "bankingDetails": {
        "branch": "0001",
        "account": "123451",
        "type": "CACC",
        "openingDate": "2010-01-01",
        "closingDate": "2024-06-30",
        "iban": "US12345678901234567891",
        "countryCode": "US",
        "bankId": "12345"
      },
      "relatedParties": [
        {
          "id": "01951ad2-5678-9abc-def0-123456789abc",
          "document": "98765432100",
          "name": "Jane Doe",
          "role": "LEGAL_REPRESENTATIVE",
          "startDate": "2024-01-01",
          "endDate": "2024-06-30"
        }
      ],
      "regulatoryFields": {
        "participantDocument": "00000000000191"
      },
      "metadata": {
        "key": "value"
      },
      "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
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '.
Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Exemplo:

"01946120-0f45-7c5f-86a0-0ea7c59fdbd4"

Parâmetros de consulta

​
holder_id
string

ID único do titular.

​
metadata
string

A chave de metadata fornecida quando a Conta Alias foi criada.

​
limit
integer
padrão:10

O número máximo de itens a serem incluídos na resposta.

​
page
integer
padrão:1

O número da página que você deseja consultar.

​
sort_order
enum<string>

A ordem utilizada para classificar os resultados.

Opções disponíveis:
asc,
desc
​
include_deleted
string

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

​
account_id
string

Filtra Contas Alias vinculadas a um ID de conta específico.

​
ledger_id
string

Filtra Contas Alias vinculadas a um ID de ledger específico.

​
document
string

Filtra Contas Alias pelo número do documento.

​
banking_details_branch
string

Filtra Contas Alias pela agência bancária.

​
banking_details_account
string

Filtra Contas Alias pela conta bancária.

​
banking_details_iban
string

Filtra Contas Alias pelo IBAN bancário.

Resposta

Indica que o recurso foi criado com sucesso e a operação foi concluída conforme esperado.

​
items
object[]
obrigatório

Lista dos resultados retornados.

​
page
integer
padrão:1
obrigatório

O número da página retornada.

​
limit
integer
padrão:10
obrigatório

O número máximo de itens a serem incluídos na resposta.