TAtatum
Blockchain addresses

Check whether a blockchain address is assigned to a virtual account

/v3/offchain/account/address/{address}/{currency}

1 credit per API call

Check whether a blockchain address with the specified cryptocurrency is registered within Tatum and is assigned to a virtual account (that is, whether this blockchain address is a deposit address associated with the virtual account).

If the blockchain address is assigned to a virtual account, information about this account is returned. Otherwise, an error message is returned.

get/v3/offchain/account/address/{address}/{currency}

Request

  • Base URL
    https://api.tatum.io
  • URL
    https://api.tatum.io/v3/offchain/account/address/{address}/{currency}
  • Auth
    API key in header x-api-key

Path parameters

currencystring required
Example:BNB

The cryptocurrency of the blockchain address to check

addressstring required
Example:tbnb1sfj9981j2eo1ij2e09

The blockchain address to check

Query parameters

indexnumber
Example:1

Only for BNB Beacon Chain, Stellar, or XRPL<ul><li>For <b>BNB Beacon Chain</b>, specify the memo.</li><li>For <b>Stellar</b>, specify the message.</li><li>For <b>XRPL</b>, specify the DestinationTag.</li></ul>

Response

OK

idstring required

The ID of the virtual account

currencystring required

The currency of the virtual account

frozenboolean required

If set to "true", the virtual account is frozen

activeboolean required

If set to "true", the virtual account is active

customerIdstring

The ID of the customer (newly created or existing one) associated with the virtual account

accountNumberstring

The number associated with the virtual account in an external system

accountCodestring

The code associated with the virtual account in an external system to designate the purpose of the account in bookkeeping

accountingCurrencystring

The currency in which all the transactions for all accounts will be accounted

xpubstring

The extended public key of the blockchain wallet associated with the virtual account; used to generate deposit addresses for the virtual account

Example response

{
  "id": "5e68c66581f2ee32bc354087",
  "balance": {
    "accountBalance": "1000000",
    "availableBalance": "1000000"
  },
  "currency": "BTC",
  "active": true,
  "customerId": "5e68c66581f2ee32bc354087",
  "accountNumber": "123456",
  "accountCode": "03_ACC_01",
  "accountingCurrency": "EUR",
  "xpub": "xpub6FB4LJzdKNkkpsjggFAGS2p34G48pqjtmSktmK2Ke3k1LKqm9ULsg8bGfDakYUrdhe2EHw5uGKX9DrMbrgYnVfDwrksT4ZVQ3vmgEruo3Ka"
}

Changes

No recorded changes to this operation across all 1 revision of this API.