Algorand Opt In

On Algorand, every asset and defi application needs to be opted into before a user can interact with it. The only exception is Algorand's native asset, Algo. The opt in is a free transaction however, in order to opt in, the user must have at least one Algo in their wallet.

Check Algo balance

If the wallet holder does not have Algo, you need to inform them on how to obtain some. If they have 1 Algo, they should be all set to opt in.

Fetch asset balance by specifying the asset address and the asset symbol

get

Authorizations

Query parameters

addressstringRequired

Asset valid address

Example: 0x9bf4001d307dfd62b26a2f1307ee0c0307632d59

assetSymbolstringRequired

Asset symbol, for instance: USDT, ETH, ALGO, etc, ...

Example: USDT

tokenStandardstring · enumOptional

Optional value only used when dealing with non native assets (aka tokens), it can be ERC_20, BEP_20, ALGO_STANDARD, ALGO_APP. If native asset, keep the field empty

Example: ERC_20Available options:

tokenTypestringRequired

Optional value only used when querying non native assets(tokens), it can be ERC_20, BEP_20, ALGO_STANDARD. If native asset, keep the field empty

Example: ERC_20

Responses

application/json

objectOptional

get

HTTPcURLJavaScriptPython

GET /api/v1/query/assets/balance?address=text&assetSymbol=text&tokenType=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "address": "0x9bf4001d307dfd62b26a2f1307ee0c0307632d59",
  "assetSymbol": "ETH",
  "tokenStandard": "ERC_20",
  "tokenType": "ERC_20",
  "balance": "181.2939",
  "lockedTokenBalance": "181.2939",
  "stakedBalance": "399.2",
  "claimableBalance": "1.3",
  "assetConfigId": "text",
  "balanceUpdatedAt": {}
}

Check opt in status

If the wallet holder is attempting to interact with an asset you must pass the asset index. If they are attempting to interact with an Algo dapp, you must pass the app index.

Get the list of all assets that the current account has opted into. This is only relevant for the Algorand chain

get

Authorizations

Query parameters

addressstringRequired

The address of the account that is being checked for optin status on particular assets or apps

Example: KFMRQHJVVONKOLXTEQ33CNUQZ4NBGU2EDCE25KNKVMRYPRKLKCNQDAWWTM

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/check-asset-optin?address=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200

Returns list of assets opted into

No content

Get the list of all apps that the current account has opted into. This is only relevant for the Algorand chain

get

Authorizations

Query parameters

addressstringRequired

The address of the account that is being checked for optin status on particular assets or apps

Example: KFMRQHJVVONKOLXTEQ33CNUQZ4NBGU2EDCE25KNKVMRYPRKLKCNQDAWWTM

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/transactions/check-app-optin?address=text HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Accept: */*

200Success

No content

Opt In

If they are not opted in and they have Algo in their wallet, you can prepare the seed phrase (the master seed phrase, not the Algorand seed phrase) for transport and send that along with opt in details.

Transaction for optin to receive a specific asset in the future

post

Authorizations

api-key-authjwt-access-token

Body

messagestringRequired

Message retrieved from the backend

Example: 717ea458b62a430cb37ced7c22ebec97

clientAuthPubKeystringRequiredExample: e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc

signaturestringRequired

Signature generated after signing the provided data field

Example: 0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c

originAddressstringRequired

The address of the account that wants to opt-in

Example: GR45UFDRAHU6AZ7FPWNUS52BN7ETV2WBR2CXCY44AIRMUCSIVN7MLYOWBM

referencestringRequired

Transaction reference

Example: a4dedb83-4d59-41ca-84b5-4b24a98878d8

notestringRequired

Transaction memo or note

Example: Hey I am trying opt-in

encryptedSeedall ofRequired

Seed encrypted asymmetrically by current user corresponding wallaby auth public key, to be decrypted inside the secure code execution environment

Example: {"iv":"b7b643ebccf35c262aa2d5c2729c5f3d","ephemPublicKey":"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729","ciphertext":"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4","mac":"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e"}

assetIndexnumberRequired

Asset Index value is the asset id on the chain

Example: 14241387

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/transactions/asset-optin HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1032

{
  "message": "717ea458b62a430cb37ced7c22ebec97",
  "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
  "signature": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c",
  "originAddress": "GR45UFDRAHU6AZ7FPWNUS52BN7ETV2WBR2CXCY44AIRMUCSIVN7MLYOWBM",
  "reference": "a4dedb83-4d59-41ca-84b5-4b24a98878d8",
  "note": "Hey I am trying opt-in",
  "encryptedSeed": "{\"iv\":\"b7b643ebccf35c262aa2d5c2729c5f3d\",\"ephemPublicKey\":\"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729\",\"ciphertext\":\"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4\",\"mac\":\"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e\"}",
  "assetIndex": 14241387
}

200

Asset optin transaction was broad-casted successfully

{
  "transaction": {
    "reference": "text",
    "hash": "text",
    "userId": "text",
    "merchantId": "text",
    "userEmail": "text",
    "chainId": "text",
    "chainName": "text",
    "chainSlip44": 1,
    "fromWalletId": "text",
    "fromAddress": "text",
    "toWalletId": "text",
    "toAddress": "text",
    "assetId": "text",
    "assetSymbol": "text",
    "tokenType": "text",
    "amount": "text",
    "fee": "text",
    "note": "text",
    "nonce": 1,
    "gasPrice": 1,
    "submitter": "text",
    "status": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "multisigSignerApprovedCount": 1,
    "txBlob": "text",
    "multisigParticipants": [
      {
        "transactionId": "text",
        "userAddress": "text",
        "userId": "text",
        "chainId": "text",
        "chainName": "text",
        "assetId": "text",
        "assetName": "text",
        "assetSymbol": "",
        "status": "pending-approval",
        "transaction": "[Circular Reference]",
        "user": {
          "id": "text",
          "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "role": "republic_admin",
          "firstName": "Bryan",
          "walletsCount": 2,
          "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
          "latestWallabyAuthPubKeyVersion": "1",
          "hasFullPermissions": true
        }
      }
    ],
    "merchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:50:33.634Z",
      "updatedAt": "2025-04-24T06:50:33.634Z",
      "createdAssets": [
        []
      ]
    }
  },
  "message": "text"
}

Transaction for optin to interact with a specific app

post

Authorizations

api-key-authjwt-access-token

Body

messagestringRequired

Message retrieved from the backend

Example: 717ea458b62a430cb37ced7c22ebec97

clientAuthPubKeystringRequiredExample: e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc

signaturestringRequired

Signature generated after signing the provided data field

Example: 0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c

originAddressstringRequired

The address of the account that wants to opt-in

Example: GR45UFDRAHU6AZ7FPWNUS52BN7ETV2WBR2CXCY44AIRMUCSIVN7MLYOWBM

referencestringRequired

Transaction reference

Example: a4dedb83-4d59-41ca-84b5-4b24a98878d8

notestringRequired

Transaction memo or note

Example: Hey I am trying opt-in

encryptedSeedall ofRequired

Seed encrypted asymmetrically by current user corresponding wallaby auth public key, to be decrypted inside the secure code execution environment

Example: {"iv":"b7b643ebccf35c262aa2d5c2729c5f3d","ephemPublicKey":"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729","ciphertext":"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4","mac":"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e"}

appIndexnumberRequired

App Index value is the app id being used on chain

Example: 14241387

Responses

application/json

objectOptional

post

HTTPcURLJavaScriptPython

POST /api/v1/transactions/app-optin HTTP/1.1
Host: 
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1030

{
  "message": "717ea458b62a430cb37ced7c22ebec97",
  "clientAuthPubKey": "e3421d7f9d6888ea83bef6b28ce0a2ab6eb6fe8a8fbfa3743240992590816b08f9a62edcc63296d056c552054d583fec36d23ef11dffb24c95aaf4a47d50dccc",
  "signature": "0xb44e88ff3c67de6e6548a6caf006bf6e1cb841119d0b9ea1b7e9b2d36a5e0ed42fd9f5e543243d1d73dc4b7800cc2026f74961f4edc769699678a316abb34e661c",
  "originAddress": "GR45UFDRAHU6AZ7FPWNUS52BN7ETV2WBR2CXCY44AIRMUCSIVN7MLYOWBM",
  "reference": "a4dedb83-4d59-41ca-84b5-4b24a98878d8",
  "note": "Hey I am trying opt-in",
  "encryptedSeed": "{\"iv\":\"b7b643ebccf35c262aa2d5c2729c5f3d\",\"ephemPublicKey\":\"040cff71ed16f1105c45c2214c9e72d3eabde48efe3759c6f150352b19aa8054c302dc1fd8b4f3927bd7d74ae0186854b3a13de7673be4f8424a6ba3702c239729\",\"ciphertext\":\"736bc1881a02fa08df4a3f1e35d426660e3c35471facba2866e960f8a19b783bac30d037b07dc9e6406e258d09a4a7e4a7cf58d20cf7b8b7201db0f80849a48d20389039e3fc196f42796fe6d501f47afb030f9946ecbc148d8da1e46c3793a4\",\"mac\":\"b6cbbdbbc3a311d919340fc3ec9ee1911d9ead6d989efa73e0ac3303c51a353e\"}",
  "appIndex": 14241387
}

200

Application optin transaction was broad-casted successfully

{
  "transaction": {
    "reference": "text",
    "hash": "text",
    "userId": "text",
    "merchantId": "text",
    "userEmail": "text",
    "chainId": "text",
    "chainName": "text",
    "chainSlip44": 1,
    "fromWalletId": "text",
    "fromAddress": "text",
    "toWalletId": "text",
    "toAddress": "text",
    "assetId": "text",
    "assetSymbol": "text",
    "tokenType": "text",
    "amount": "text",
    "fee": "text",
    "note": "text",
    "nonce": 1,
    "gasPrice": 1,
    "submitter": "text",
    "status": "text",
    "ownershipType": "text",
    "multisigVersion": 1,
    "multisigSignerThreshold": 1,
    "multisigSignerApprovedCount": 1,
    "txBlob": "text",
    "multisigParticipants": [
      {
        "transactionId": "text",
        "userAddress": "text",
        "userId": "text",
        "chainId": "text",
        "chainName": "text",
        "assetId": "text",
        "assetName": "text",
        "assetSymbol": "",
        "status": "pending-approval",
        "transaction": "[Circular Reference]",
        "user": {
          "id": "text",
          "externalUserId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "merchantId": "6e464058-67c1-4273-a6a4-8aae522e34be",
          "role": "republic_admin",
          "firstName": "Bryan",
          "walletsCount": 2,
          "latestWallabyAuthPubKey": "4ecb720b1392468c75803d6252ac987c113206955070b96df1208c1c480338168e1407cec4b5af2f91d12af9b725cbd85af994b29c6364971a7ef8d955be83dc",
          "latestWallabyAuthPubKeyVersion": "1",
          "hasFullPermissions": true
        }
      }
    ],
    "merchant": {
      "name": "Republic",
      "nameSlugify": "republic",
      "verified": true,
      "contactEmail": "[email protected]",
      "contactPhoneNumber": "text",
      "usersCount": 1,
      "assetsCount": 1,
      "tokensCount": 1,
      "coinsCount": 1,
      "walletsCount": 1,
      "status": "active",
      "createdAt": "2025-04-24T06:50:33.634Z",
      "updatedAt": "2025-04-24T06:50:33.634Z",
      "createdAssets": [
        []
      ]
    }
  },
  "message": "text"
}