About Anchors

Date	Responsible	Changes
September 19, 2023	@Luis Fidelis	Initial version
October 24, 2023	@Luis Fidelis	• Renamed `data.source` → `data.wallet` • Added `data.symbol` property • Removed reference to `advices` API

What is an anchor?

An anchor is a ledger record that represents a link between user wallets in the ledger. It can be used in the onboarding process of alias directories.

An anchor is a ledger record that represents a more detailed information about some of the wallets property. A wallet can have one or more anchors and they are connected to wallet by using source field. Anchors can function with or without wallets, depending on the use case.

Anchor can be used in an alias directory as a representation of an account that is connected to a specific wallet. Anchors cannot hold balances.

{
    "data": {
        "wallet": "tel:1234555555",
        "target": "account:1234@bank"
        "schema": "...",
        "custom": {
            ...
        },
        "access": [...],
    },   
    "hash": "...",
    "meta": {...}
}

It is possible to define a symbol for an anchor. Users can find for anchors by filtering a symbol.

{
    "data": {
        "wallet": "tel:1234555555",
        "target": "account:1235@bank"
        "schema": "...",
        "symbol": "usd",
        "custom": {
            ...
        },
        "access": [...],
    },   
    "hash": "...",
    "meta": {...}
}

The custom property can be used to include additional information such as its name and document info which is supported by the target account.

{
    "data": {
        "source": "tel:1234555555",
        "target": "account:1234@bank"
        "schema": "account",
        "symbol": "USD",
        "custom": {
            "name": "Melissa Ruiz",
            "documentType": "ccpt",
            "documentNumber": "814282133995806",
        },
        "access": [...],
    },   
    "hash": "...",
    "meta": {...}
}

About Anchors

What is an anchor?

On this page