Saltar al contenido principal
GET
/
v1
/
holders
/
{holder_id}
/
aliases
/
{alias_id}
Obtener detalles de una cuenta 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": "0194fa41-5333-77c7-91fe-309fb4618155",
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2025-01-01",
    "iban": "US12345678901234567890",
    "countryCode": "US",
    "bankId": "12345"
  },
  "metadata": {
    "ad_4a": true
  },
  "createdAt": "2025-01-01T00:00:00Z",
  "updatedAt": "2025-01-01T00:00:00Z",
  "deletedAt": null
}

Encabezados

​
Authorization
string

El token de autorización en formato 'Bearer '.
Importante: Este encabezado es obligatorio si su entorno tiene habilitado Access Manager. Para obtener más información, consulte la documentación de Access Manager.

​
X-Organization-id
string
requerido

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

Ejemplo:

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

Parámetros de ruta

​
holder_id
string
requerido

Identificador único del titular.

​
alias_id
string
requerido

Identificador único de la cuenta alias.

Parámetros de consulta

​
include_deleted
string

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

Respuesta

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

Información sobre la cuenta alias.

​
id
string

Identificador único de la cuenta alias.

​
holderId
string

Identificador único del titular.

​
type
enum<string>

Tipo de titular.

Opciones disponibles:
LEGAL_PERSON,
NATURAL_PERSON
​
document
string

Documento de identificación del titular.

​
ledgerId
string

Identificador único del Ledger de Midaz asociado a la cuenta.

​
accountId
string

Identificador único de la cuenta relacionada.

​
bankingDetails
object

Detalles de la cuenta bancaria del titular.

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para añadir un centro de costos, usa costCenter: BR_11101997.

​
createdAt
string

Fecha en la que se creó la cuenta alias.

​
updatedAt
string

Fecha de la última actualización de la cuenta alias.

​
deletedAt
string

Fecha en la que se eliminó la cuenta alias.