API Reference
GuidesReleasesPostmanRecipesAPI Reference

Register an address

post
https://sandbox.notabene.id/api/v1/wallets

Adds an address you control to your registry, optionally attributing it to a customer. Registering an address you hold, or a customer's, also confirms it as yours to the counterparties of live transfers settling to it. Registering it again does so only while a counterparty is still waiting on that confirmation.

Required permission: create:address.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Used in these guides:

Body Params
string
required

Address of the wallet: a CAIP-10 account such as eip155:1:0xabc, or a plain address with asset set.

string

An asset held at the address, as a CAIP-19 identifier or a plain symbol such as BTC. Required when address is a plain address, which takes the asset's chain. With a CAIP-10 address, the asset must be on the same chain.

string

DID of the wallet provider (custodian) holding the address for you. Published with the address so counterparties discover it as a custodian agent. Not allowed when managed is false.

string

IRI of the customer the address belongs to. Omit for an omnibus wallet holding funds for many customers.

boolean

True when you operate the wallet yourself. Defaults to true.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

429

Too Many Requests: more than 6,000 calls in 300 seconds. Every endpoint refuses your calls for the next 10 seconds. Send the request again with a backoff, as Rate limiting explains.

Updated 20 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 20 days ago

Did this page help you?