PATCH
/
v1
/
holders
/
{holder_id}
/
aliases
/
{alias_id}
Update an Alias Account
curl --request PATCH \
  --url https://crm.sandbox.midaz.io/v1/holders/{holder_id}/aliases/{alias_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "bankingDetails": {
    "branch": "0001",
    "account": "123450",
    "type": "CACC",
    "openingDate": "2024-01-01",
    "iban": "US12345678901234567890",
    "countryCode": "US",
    "bankId": "12345"
  },
  "metadata": {
    "ad_4a": true
  }
}'
{
  "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": "2024-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
}

Headers

​
Authorization
string

The authorization token. Important: This header only is required if your environment has the Acces Manager plugin enabled.

​
X-Organization-id
string

The unique identifier of the Organization associated with the request.

Path Parameters

​
holder_id
string
required

The unique identifier of the Holder.

​
alias_id
string
required

The unique identifier of the Alias account.

Body

application/json

Details of the updated Alias 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.