Wallets

These are the endpoints on the OAuth API that allow at domain level for the access token:

  • See the wallets registered per token to the investor and their status (ready, pending, failed)

  • Add wallets to the investor (equivalent to adding them via the CP)

Important concepts and parameters

  • address - the address of the wallet to add. The format for this value will depend on the specific blockchain the token is using (i.e. Ethereum tokens will require Ethereum addresses, Algorand wallets will require Algorand addresses, etc...)

  • wallet name - the user-friendly name for this wallet, so that the user can identify it without having to check the address itself when looking at it from the Securitize dashboard

  • tokenId - the token for which this wallet wants to be authorized. This operation basically is set to add a wallet address to the whitelist of an specific token, and since in a given domain there may be multiple tokens this is needed to specify which one

  • securitizeiDwalletID - this is used to associate the wallet being whitelisted at token level with the same wallet iff it was registered to the user profile in Securitize iD. This is not required, as the whitelisting at token level does NOT require the wallet being registered at Securitize iD (the UI enforces this process for simplifity, but the system does not require it) and in some cases it would not be possible (e.g. for networks that are not exposed in Securitize iD, like BESU). If the link exists it fundamentally means the wallet was authorized through our UI by leveraging a previously SiD-registered wallet, but for an automatic operation via API this is likely not needed.

get
Get Wallets

https://sec-id-api.securitize.io/v1/{clientId}/investor/domain/wallets
This endpoint allows you to get the wallets of a specific investor
Request
Response
Request
Path Parameters
clientId
required
string
Your ClientID provided by Securitize
Headers
access-token
required
string
Investor Access Token
authorization
required
string
Your application secret provided by Securitize
Response
200: OK
Wallet successfully retrieved.
{ "name": "[
{
"securitizeIdWalletId":"60d1d2cdffa486001dc19c31",
"walletType":"other",
"walletName":"Algorand 1",
"walletAddress":"254zubmgyf3up6z7d6w56vekkdpgezzj6bzw3ruhlqbulwh3azqxrs4hp4",
"blockchain":"algorand",
"tokens":[
{
"tokenName":"SOPA",
"tokenId":"65be0954-a803-48f0-ad2e-8c7c1ccdbd10",
"status":"not-authorised"
}
]
}
] Could not find a cake matching this query.

post
Add Investor Wallet

https://sec-id-api.securitize.io/v1/{clientId}/investor/domain/wallets
This endpoint allows you to add an Investor Wallet
Request
Response
Request
Path Parameters
{clientId}
required
string
Headers
access-token
required
string
authorization
required
string
Body Parameters
tokenId
required
string
walletName
optional
string
address
required
string
securitizeIdWalletId
required
string
Response
200: OK