About Advices

What is an advice?

Advice helps clients to check if an alias wallet exists in alias directory.

After onboarding an alias wallet, e.g. user phone and user mail with the ledger by using an anchor, it can be fetched afterwards by using the advices API.

Let's take the alias phone tel:1234555555 and the account account:1234@bank as example for advices execution.

Once the phone tel:1234555555 is onboarded with the ledger as a source for the target account account:1234@bank this anchor could be defined as

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

So, let's imagine that a different bank account account:5431@anotherbank wants to transfer money to the phone tel:123455555 in the ledger. The mobile app of the bank that holds account:5431@anotherbank account can call for advices to check whether this phone is onboarded with the ledger or not.

POST /v2/advices/alias-resolve

Body

{
    "data": {
        "handle": "tel:1234555555"
    },
    "hash": "...",
    "meta": {...}
}

Since there's an anchor in the ledger for the given phone, the output of this advice execution would be something like

{
    "data": [{
        "handle": "account:1234@bank",
        "schema": "account",
        "custom": {
            "name": "Melissa Ruiz",
            "documentType": "ccpt",
            "documentNumber": "814282133995806",
            "symbol": "DOP"
        },
    }],   
    "hash": "...",
    "meta": {...}
}

Note that in the input body handle represents the source of anchors. On the other hand, handle stands for the target of related anchors in the response.

The Advices API also supports symbol filtering. In the example above, the phone tel:1234555555 has a single anchor that supports the symbol DOP only, which means that if the account account:5431@anotherbank wants to transfer USD, this call for advices would result in an empty list.

Body

{
    "data": {
        "handle": "tel:1234555555",
        "symbol": "USD"
    },
    "hash": "...",
    "meta": {...}
}

Response

{
    "data": [],   
    "hash": "...",
    "meta": {...}
}