Consultar detalhes da Conta Alias - Lerian

Consultar detalhes da Conta Alias

curl --request GET \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id}/aliases/{alias_id} \
  --header 'X-Organization-id: <x-organization-id>'

{
  "id": "01951ad1-9f62-793a-9095-fe7701f94434",
  "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
  "type": "LEGAL_PERSON",
  "document": "91315026015",
  "ledgerId": "7b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
  "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2025-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"
    },
    {
      "id": "01951ad2-5678-9abc-def0-123456789abc",
      "document": "98765432100",
      "name": "Jane Doe",
      "role": "LEGAL_REPRESENTATIVE",
      "startDate": "2024-01-01",
      "endDate": "2025-12-31"
    }
  ],
  "regulatoryFields": {
    "participantDocument": "00000000000191"
  },
  "metadata": {
    "ad_4a": true
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "deletedAt": null
}

GET

/

v1

/

holders

/

{holder_id}

/

aliases

/

{alias_id}

Consultar detalhes da Conta Alias

curl --request GET \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id}/aliases/{alias_id} \
  --header 'X-Organization-id: <x-organization-id>'

{
  "id": "01951ad1-9f62-793a-9095-fe7701f94434",
  "holderId": "0194f0ea-2cb2-78c9-b9be-704ba20a9cd8",
  "type": "LEGAL_PERSON",
  "document": "91315026015",
  "ledgerId": "7b0fb8b-1bd9-4810-9c6d-7e80064fab0c",
  "accountId": "019c96a0-0c0c-7221-8cf3-13313fb60081",
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2025-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"
    },
    {
      "id": "01951ad2-5678-9abc-def0-123456789abc",
      "document": "98765432100",
      "name": "Jane Doe",
      "role": "LEGAL_REPRESENTATIVE",
      "startDate": "2024-01-01",
      "endDate": "2025-12-31"
    }
  ],
  "regulatoryFields": {
    "participantDocument": "00000000000191"
  },
  "metadata": {
    "ad_4a": true
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "deletedAt": null
}

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:

"019c96a0-0a98-7287-9a31-786e0809c769"

Parâmetros de caminho

holder_id

string

obrigatório

Identificador único do Titular.

alias_id

string

obrigatório

Identificador único da Conta Alias.

Parâmetros de consulta

include_deleted

string

Se true, as Contas Alias que foram excluídas logicamente (soft delete) também serão incluídas.

Resposta

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

Informações sobre a Conta Alias.

id

string

Identificador único da Conta Alias.

holderId

string

Identificador único do Titular.

type

enum<string>

Tipo de Titular.

Opções disponíveis:

LEGAL_PERSON,

NATURAL_PERSON

document

string

Documento de identificação do Titular.

ledgerId

string

Identificador único do Midaz Ledger da Conta relacionada.

accountId

string

Identificador único da Conta relacionada.

bankingDetails

object

Detalhes da conta bancária do Titular.

Show child attributes

Lista de partes relacionadas associadas a esta Conta Alias.

Show child attributes

regulatoryFields

object

Campos de conformidade regulatória necessários para jurisdições específicas.

Show child attributes

metadata

object

Um objeto contendo pares chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Show child attributes

createdAt

string

A data em que a Conta Alias foi criada.

updatedAt

string

A data em que a Conta Alias foi atualizada pela última vez.

deletedAt

string

A data em que a Conta Alias foi excluída.

Listar Contas Alias

Atualizar uma Conta Alias

⌘I