Transfer Digital Passport to Another Wallet

Transfer Digital Passport to Target Wallet Address

As a brand, you wish to allow your users to transfer digital passports from a user's wallet to another wallet address. To do so, our API generates the request ownership link.

⚠️

Every new transfer link is based on a new passphrase. That means old links will not work anymore.

URL

To trigger a transfer, use https://custody.arianee.com/{{client}}/{{chainType}}/nft/transfer.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/transfer

Body

FieldTypeRequiredDescription
protocolNameString - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnetProtocol on which the digital passport has been minted.
Dig deeper into Arianee Protocols.
smartAssetIdStringDigital passport identification number to claim.
toStringDigital passport recipient.
{
    "protocolName": "testnet",
    "smartAssetId": "967188109",
    "to": "0x4febba33415ab41256cbc981c178297f926a6490"
}

📌

If the transfer is initiated by another user than the digital passport's owner, the passphrase is mandatory.

Return Payload

Status CodeSuccessDescription
200truetrue: The transaction has been sent to the blockchain.
{
    "success": true
}

Errors

Status CodeReturn PayloadDescription
400false- The digital passport ID must be a string.

- Missing passport ID.
404falseThe wallet may not exist. You are not authenticated.
500falseYou are not the digital passport owner.
{
    "success": true
}
{
    "success": false,
    "error": "error while transfering the smart asset, make sure you are the owner and that the id is valid"
}


Transfer Digital Passport using Link

URL

Use the https://custody.arianee.com/{{client}}/{{chainType}}/nft/createTransferLink.

POST - https://custody.arianee.com/{{client}}/{{chainType}}/nft/createTransferLink

Body

FieldTypeRequiredDescription
protocolNameString - testnet, mainnet, arianeetestnet, mumbai, polygon, arialabs, stadetoulousain, ysl, testnetSbt, arianeeSupernet, arianeesbt, tezostestnet, supernettestnetProtocol on which the digital passport has been minted.
Dig deeper into Arianee Protocols.
smartAssetidObjectDigital passport identification number.
{
    "protocolName": "testnet",
    "smartAsset" : {
        "id": "33491174"
    }
}

Return Payload

Status CodeSuccessDescription
200trueThe proofLink is generated.
{
    "proofLink": "https://test.arian.ee/proof/33491174,ss9t4d2yg1yl"
}

Error

Status CodeSuccessDescription
404falseThe wallet may not exist. You are not authenticated.