Skip to main content
POST
/
v1
/
holders
/
{holder_id}
/
aliases
Create an Alias Account
curl --request POST \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id}/aliases \
  --header 'Content-Type: application/json' \
  --header 'X-Organization-id: <x-organization-id>' \
  --data '
{
  "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"
  },
  "metadata": {
    "key": "value"
  }
}
'
{
  "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
}

Headers

​
Authorization
string

The authorization token in the 'Bearer ' format.
Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

​
X-Organization-id
string
required

The unique identifier of the Organization associated with the request.

Example:

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

Path Parameters

​
holder_id
string
required

Unique identifier of the Holder to will be associated to Account.

Body

application/json

Details about the Alias Account.

​
accountId
string
required

Unique identifier of the Midaz Ledger Account.

​
ledgerId
string
required

Unique identifier of the Midaz Ledger of the related account.

​
bankingDetails
object

Details of the Holder's banking account.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

Information about the Alias Account.

​
id
string

Unique identifier of the Alias Account.

​
holderId
string

Unique identifier of the Holder.

​
type
enum<string>

Type of Holder.

Available options:
LEGAL_PERSON,
NATURAL_PERSON
​
document
string

Holder's identification document.

​
ledgerId
string

Unique identifier of the Midaz Ledger of the related Account.

​
accountId
string

Unique identifier of the related Account.

​
bankingDetails
object

Details of the Holder's banking account.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

​
createdAt
string

The date when the Alias Account was created.

​
updatedAt
string

The date when the Alias Account was last updated.

​
deletedAt
string

The date when the Alias Account was deleted.